c-bata/go-prompt
Go Prompt
go-prompt is a library for building interactive command-line interfaces in Go. It serves as a cross-platform console UI framework and terminal input manager, providing the tools necessary to capture user input and execute commands through a persistent interactive loop.
The library features a dedicated auto-completion engine that provides real-time command suggestions. It also supports dynamic prompt prefixes updated via callback functions and a system for managing and recalling command history.
The framework covers a broad range of terminal capabilities, including keyboard shortcut mapping, cursor control, and terminal output management for text colors and screen updates. It incorporates a trie-based system for input completion and buffer-based text management for real-time editing.
Features
- Interactive Prompt Toolkits - Provides a toolkit for building cross-platform interactive terminal user interfaces and prompt systems in Go.
- Terminal Prompt Libraries - Implements a comprehensive library for building interactive command-line prompts with auto-completion and history management in Go.
- Trie-Based Completions - Incorporates a trie-based system for providing real-time command completion suggestions.
- Command Line Completions - Implements real-time suggestions and input completion for command-line tools.
- Real-Time Completion Engines - Implements a real-time completion engine that provides immediate suggestions as the user types in the terminal.
- Cross-Platform Console Tooling - Provides a framework for building terminal user interfaces that behave consistently across different operating systems.
- Command-Line Input Completions - Provides a real-time suggestion system for possible completions of the current command-line input.
- Interactive CLI Tools - Enables the development of interactive CLI tools with advanced features like auto-completion.
- Terminal Output Management - Provides utilities for controlling cursor position, clearing the screen, and managing terminal output flow.
- ANSI Escape Sequence Renderers - Provides engines that generate ANSI escape codes to control text color and cursor positioning in the terminal.
- User Input Capture - Captures real-time text data from users through an interactive command-line prompt.
- Event-Driven Input Handlers - Utilizes an asynchronous event loop to process raw keyboard input and trigger editor actions.
- Text Buffer Management - Implements a mutable text buffer to manage real-time input editing and cursor movement.
- Terminal Input Handling - Manages keyboard input, shortcuts, and cursor control specifically for terminal emulator environments.
- Dynamic - Supports dynamic prompt prefixes that are updated via callback functions to reflect current application state.
- Command History Managers - Implements a system for storing and recalling previously executed commands.
- Custom Key Mappings - Allows binding of specific keys or ASCII codes to custom editor actions and navigation shortcuts.
- Keyboard Shortcuts - Provides a system for mapping key combinations to standard text manipulation and navigation controls.
- Keyboard Shortcut Mappings - Allows users to map specific commands and terminal operations to custom keyboard shortcuts.
- Command History Navigation - Enables keyboard-driven traversal and recall of previously entered commands from a history stack.
- Dynamic Prompt Modification - Enables real-time modification of the terminal prompt string via callback functions.
- Terminal User Interfaces - Provides a framework for building and styling interactive text-based interfaces within a terminal.
- Command Line Interfaces - Interactive prompt builder.
- Console Interfaces - Listed in the “Console Interfaces” section of the Awesome Go awesome list.
- Console UI - Interactive prompt builder.
- Terminal User Interfaces - Library for building interactive terminal prompts.
