Skip to main content

pyinkcli


pyinkcli

A Python fork and translation project of Ink for building terminal UIs with a React-like component model.

pyinkcli is a Python implementation inspired by and translated from Ink. This repository is a fork, not the official Node.js package, and the API is adapted for Python where needed.

Ink demo

Install

pip install pyinkcli

Quick Start

from pyinkcli import Box, Text, render


def Counter():
    return Box(
        Text("Hello from pyinkcli", color="green", bold=True),
        flexDirection="column",
        alignItems="center",
    )


app = render(Counter)
app.wait_until_exit()

What This Repo Is

  • A Python fork of Ink focused on translating the terminal UI model into Python
  • A repo that keeps the upstream JS implementation nearby for parity work and audits
  • A place for Python-native examples and tests under examples/ and tests/

Examples

  • examples/alternate-screen/
  • examples/chat/
  • examples/counter/
  • examples/terminal-resize/
  • examples/use-focus/
  • examples/use-input/

License

MIT. The repository includes the upstream Ink license text in LICENSE.

Metadata

Release files for pyinkcli 0.1.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyinkcli 0.1.4
File Size Uploaded Provenance Actions
pyinkcli-0.1.4.tar.gz 124.6 kB Without provenance Details for pyinkcli-0.1.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pyinkcli 0.1.4
File Interpreter ABI Platform Actions
pyinkcli-0.1.4-py3-none-any.whl Python 3 none any Details for pyinkcli-0.1.4-py3-none-any.whl

Total release size: 294.4 kB

Release files / pyinkcli-0.1.4.tar.gz

Download URL pyinkcli-0.1.4.tar.gz
Size 124.6 kB
Tags Source
SHA-256 checksum
How to use checksums
1def0c56a204fe58eba5016f2f54c30439a24bf602213bd1c89c29d867768c46
BLAKE2b-256 checksum
How to use checksums
ee97542bb0b56fc6d2269f05501c474108a336ef3f7c40f7631c7de282a668c8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / pyinkcli-0.1.4-py3-none-any.whl

Download URL pyinkcli-0.1.4-py3-none-any.whl
Size 169.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3685966da8e947b86f43c78446bfe1379fc624adc9b51fb26201c34e761758b7
BLAKE2b-256 checksum
How to use checksums
a8c36d60a19573b3d7b0281905dfb606fcae0f87b1c310b13fefa522a57f26a9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Security for pyinkcli 0.1.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page