zsh-users/zsh-autosuggestions
Zsh Autosuggestions
This project is a shell plugin that provides real-time command suggestions to accelerate terminal input. By hooking into the command line editor and utilizing a strategy-based prediction engine, it generates completions derived from command history, shell completion data, or custom user-defined sources.
The tool distinguishes itself by rendering suggestions as a visual ghost layer directly within the terminal buffer using ANSI-styled overlays. To maintain a responsive command-line environment, it performs all prediction calculations in the background, ensuring that heavy computation does not block user input.
Users can customize the experience through extensive configuration options, including the ability to map specific keyboard shortcuts for accepting or navigating suggestions. The engine also supports fine-grained control over the prediction process, allowing for the filtering of history or completion results and the adjustment of performance parameters based on input length.
Comprehensive documentation is available to guide users through the installation, configuration, and maintenance of the plugin.
Features
- Command Prediction Engines - Uses modular logic providers to generate command suggestions from history and completion data.
- Terminal Productivity Tools - Accelerates terminal workflows by predicting and completing commands based on personal history and shell usage patterns.
- Shell Integration Hooks - Hooks into the command line editor by wrapping existing shell widgets to trigger suggestion logic.
- Shell Workflow Optimizers - Streamlines repetitive terminal tasks by providing instant access to frequently used commands and complex syntax through intelligent suggestions.
- Terminal UI Enhancements - Renders predicted command text as a visual ghost layer directly within the terminal buffer.
- Command Line Tools - Listed in the “Command Line Tools” section of the The Book Of Secret Knowledge awesome list.
- Shell Environments - Fish-like command autosuggestions for Zsh.
- Shell Frameworks - Fish-like fast and unobtrusive command autosuggestions.
- Terminal Utilities - Provides Fish-like autosuggestions for the Zsh shell.
- Asynchronous Execution Utilities - Offloads prediction generation to a background process to keep the shell responsive.
- Asynchronous Task Configuration - Enables background calculation of suggestions to maintain shell responsiveness.
- Keyboard Shortcut Mappings - Allows custom keyboard keys to trigger actions like accepting predicted command text.
- Responsive Interface Patterns - Maintains a responsive command line by performing heavy computations in the background.
- Terminal Input Enhancers - Provides visual feedback and keyboard-based shortcuts to streamline the process of typing and executing shell commands.
- Configuration Management - Enables definition of data sources used to generate command predictions.
- Input Processing Middleware - Analyzes command line state to conditionally suppress suggestions for performance optimization.
- Widget Mapping Utilities - Assigns shell widgets to suggestion actions for custom navigation and acceptance.
- Terminal User Interfaces - Enhances the command line interface with visual cues and predictive text to reduce typing effort and improve input accuracy.
Star history
How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.
