withfig/autocomplete
Autocomplete
This project is a shell autocomplete engine and completion provider that adds real-time suggestions for command line interface options and arguments within a terminal. It functions as a declarative completion framework, allowing command hierarchies and option sets to be defined via structured data instead of manual shell scripts.
The system acts as a cross-shell completion bridge, translating a single unified definition into commands compatible with multiple different shell environments. This ensures a consistent autocomplete experience across various terminals using a shared specification format.
The engine handles the parsing and resolution of JSON-based specifications to determine valid subcommands and flags based on cursor position. It utilizes shell-integrated hooks to intercept terminal input and apply dynamic filtering to provide hints as the user types.
Features
- Completion Frameworks - Implements a declarative framework for defining shell autocomplete specifications using structured data instead of manual scripts.
- Declarative Schemas - Allows command hierarchies and options to be defined via structured data instead of manual shell scripts.
- CLI Autocompletion Generators - Generates shell completion scripts from declarative schemas for subcommands and options.
- Cross-Shell Completion Interfaces - Provides a unified bridge that ensures a consistent autocomplete experience across multiple different shell environments.
- Shell Autocompletion Providers - Ships an engine that provides context-aware command and flag suggestions within terminal shells using declarative schemas.
- Declarative Specifications - Defines command hierarchies and option sets through structured data instead of shell scripts.
- Shell Completion Providers - Acts as a backend that generates real-time suggestions for CLI options and arguments.
- Shell Integration Hooks - Intercepts terminal input via native shell scripts to trigger the suggestion engine.
- Command Suggestion Tools - Analyzes user input to provide intelligent, real-time completions for command-line instructions.
- Command Line Interface - Adds IDE-style suggestions to terminals to help users discover available commands.
- Completion Spec Resolution - Parses JSON configuration files into a structured tree to determine available completions.
- Input Suggestions - Provides real-time filtering of available subcommands and flags as the user types.
- CLI User Experience Tools - Enhances the usability of CLI tools by providing real-time hints for options and arguments.
- Environment-Aware Completion Filtering - Matches user input against completion schemas to narrow down valid subcommands and flags.
- Developer Experience - Improves the developer workflow by providing real-time command hints directly in the shell.
- Interactive CLI Tools - Provides an intuitive interaction model for complex CLI tools through advanced autocompletion.
- Cursor-Position Resolution - Parses structured configuration into a command tree to determine valid suggestions based on cursor position.
- Command Line Utilities - Context-aware terminal autocompletion for commands.
- Linux 项目 - Listed in the “Linux 项目” section of the Great Open Source Project awesome list.
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.
