promkit

A toolkit for building your own interactive prompt in Rust.

Getting Started

Put the package in your Cargo.toml.

[dependencies]
promkit = { version = "0.17.0", features = ["runtime", "texteditor"] }

Features

• Application-owned composition — Implement the Prompt lifecycle and combine only the widget states an application needs. Key bindings, focus, validation, background work, and other event policy remain in the application instead of framework-owned presets.
• Optional runtime and terminal lifecycle — Use the asynchronous prompt runtime when useful, and independently manage raw mode, the alternate screen, cursor visibility, and mouse capture with TerminalSession.
• Viewport-aware rendering — promkit-core handles wrapping or truncation, vertical pane allocation, cursor scrolling, clipping, resizing, and screen-to-widget hit testing.
• Reusable widget states — promkit-widgets provides text editing and display, list and checkbox selection, prefix search, spinners, trees, JSON and YAML documents, and CSV tables.
• Efficient large-content projection — JSON, YAML, and table widgets can project only the visible terminal viewport instead of rebuilding all content on every redraw.
• Feature-gated modules — No Cargo features are enabled by default. Choose the runtime, terminal session, capabilities, and individual widgets needed by the application.
• Cross-platform terminal support — UNIX and Windows are supported through crossterm.

Concept

See here.

Projects using promkit

• ynqa/empiriqa
• ynqa/jnv
• ynqa/logu
• ynqa/sig

Examples/Demos

promkit provides a runtime and reusable widgets for building interactive terminal applications. The examples own their event policies and demonstrate how applications can compose the widgets they need.

Table of contents

Each section includes a command, source link, and recorded demo. Demo GIFs and their VHS tapes are stored in tapes/. Regenerate them with bash scripts/render_tapes_gif.sh (requires VHS).

Readline

cargo run --bin readline

Composition / Usage

Confirm

cargo run --bin confirm

Code

Password

cargo run --bin password

Code

Form

cargo run --bin form

Code

Listbox

cargo run --bin listbox

Code

QuerySelector

cargo run --bin query-selector

Code

Checkbox

cargo run --bin checkbox

Code

Tree

cargo run --bin tree

Code

JSON

cargo run --bin json ${PATH_TO_JSON_FILE}

Code

YAML

cargo run --bin yaml ${PATH_TO_YAML_FILE}

Code

CSV

cargo run --bin csv ${PATH_TO_CSV_FILE}

Code

Text

cargo run --bin text

Code

Advanced Examples

These examples demonstrate how to compose widgets and rendering primitives for application-specific event loops and asynchronous workflows.

Async Task with Spinner

cargo run --bin async_task

Code

Multiline REPL

cargo run --bin repl

Code

License

MIT License