charmbracelet/gum
Gum
Gum is a toolkit for building interactive, visually styled command-line interfaces and prompts directly within shell scripts. It functions as a library of modular components that allow developers to enhance terminal workflows by adding structured layouts, formatted text, and user-input widgets to standard command-line operations.
The project distinguishes itself by providing a suite of specialized utilities for common shell tasks, such as fuzzy-matched selection menus, interactive file system navigation, and confirmation dialogs. It translates high-level styling and layout instructions into terminal-native escape sequences, enabling the creation of complex, readable interfaces without requiring deep knowledge of terminal rendering logic.
Beyond basic input and styling, the tool supports advanced terminal interactions including scrollable viewports for long documents, animated progress indicators for background tasks, and structured table displays. It integrates into existing shell environments by reading from standard input and writing results to standard output, facilitating its use within automated pipelines and scripts.
Features
- Interactive CLI Tooling - Provides a suite of modular components for building interactive, visually styled command-line interfaces directly within shell scripts.
- Terminal UI Frameworks - Enables the creation of professional command-line experiences through a declarative framework for formatting text, managing layouts, and capturing user input.
- ANSI Escape Sequence Renderers - Generates ANSI escape sequences to apply colors, borders, and formatting to terminal output.
- Shell Scripting Utilities - Offers a library of interactive widgets that simplify data collection, file navigation, and task progress indication in terminal workflows.
- Terminal Output Stylers - Enhances command-line readability by applying colors, markdown, and structured layouts to terminal output.
- Interactive Command Interfaces - Builds visually styled command-line interfaces using modular components for script interaction.
- Progress Indicators - Provides animated spinners and status indicators to give visual feedback during long-running command-line operations.
- Model-View-Update Runtimes - Implements a message-passing architecture for state management in interactive terminal interfaces.
- Native Input Prompts - Captures user-provided strings through interactive text input fields in shell scripts.
- User Confirmation Dialogs - Creates intuitive prompts, selection menus, and confirmation dialogs for user interaction in shell scripts.
- Command Line Tools - Tool for building shell scripts with TUI.
- Shell Scripting Tools - Tool for creating interactive and styled shell scripts.
- TUI Libraries - Tool for shell script TUIs.
- File System Navigators - Enables interactive directory browsing and file selection directly within command-line interfaces.
- Task Status Monitors - Monitors background tasks by providing visual feedback through spinners and status logs.
- Input Collection Components - Gathers data from users through interactive text fields and selection lists.
- Masked Inputs - Prompts users for text entries with support for masking sensitive characters.
- Selectable Lists - Presents interactive lists that support fuzzy-matched filtering and selection for command-line workflows.
- Text Rendering - Renders markdown, syntax-highlighted code, and structured tables to improve terminal output readability.
- Item Navigation and Selection - Filters lists of options using fuzzy matching for single or multiple item selection.
- Terminal UI Layouts - Provides declarative primitives for arranging terminal UI elements using a box-model approach.
- Fuzzy Matching - Uses string similarity algorithms to filter and rank list items for rapid selection.
- Background Processing Tools - Displays animated spinners to indicate activity during background command execution.
- Viewport Navigators - Provides a scrollable viewport for viewing and navigating lengthy text content within the terminal.
- Terminal Viewports - Manages scrollable regions and windowing logic to render large text buffers within constrained terminal dimensions.
- Terminal Layout Engines - Structures command-line interfaces by arranging components into organized layouts.
- Selection Tables - Displays structured data in tables and allows users to select specific rows for further processing.
- Standard Input/Output Streams - Integrates with shell environments by reading from standard input and writing to standard output.
- Content Display Components - Renders long documents in a scrollable viewport with line numbers and display settings.
- Text Formatting Utilities - Formats command-line output using markdown, code highlighting, and templates.
- Text Styling - Renders text with custom colors, styles, and markdown support.
- Visual Status Indicators - Provides visual feedback through spinners and formatted logs to communicate task status.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
