jeffreytse/zsh-vi-mode
Zsh Vi Mode
zsh-vi-mode is a modal command line editor and Zsh shell extension that provides Vi and Vim keybindings for terminal navigation and text manipulation. It functions as a plugin that implements a modal state machine to switch between command navigation and text insertion.
The extension includes advanced text editing capabilities such as keyword cycling for values, surround management for quotes and brackets, and the ability to hand off the command line buffer to an external text editor for complex modifications. It also provides system integration for synchronizing the shell clipboard with the native OS clipboard and opening file paths or URLs located under the cursor.
The project covers shell modal navigation and terminal text manipulation through custom widget mapping and visual mode indicators that signal the active input state via the cursor style. Users can extend the editor's behavior by registering custom widgets and defining specific escape key sequences for mode transitions.
Features
- Command Line Navigation - Provides a Vi-modal editing environment for the Zsh shell to improve command line navigation and manipulation.
- Vi Modal Editing - Implements Vi-style modal editing for efficient text navigation and manipulation on the shell command line.
- Modal Text Manipulation - Implements advanced modal text manipulation such as surround management and keyword cycling on the command line.
- Modal Text Navigation - Provides Vi-style modal navigation for moving and editing complex command strings efficiently.
- Command Line Editors - Implements a modal text entry system for the shell to speed up command line editing.
- Shell Widget Mappings - Binds custom shell functions to Zsh Line Editor widgets to customize command line behavior.
- Zsh Shell Extensions - Extends the Zsh shell with modal editing and custom widget mapping capabilities.
- Editor Mode Switching - Detects specific character patterns to trigger transitions between insert and normal modes.
- Input Mode State Machines - Implements a state machine to track and switch between command navigation and text insertion modes.
- Terminal Clipboard Utilities - Integrates shell-level deletions and copies with the system clipboard for seamless data transfer.
- Key Sequence Patterns - Allows users to define custom character sequences that trigger the transition to normal mode.
- Shell Workflow Optimizers - Streamlines terminal interactions through customizable widgets and mode transition sequences.
- Surrounding Character Management - Provides capabilities to add, replace, or delete surrounding characters like quotes and brackets around selected text.
- System Clipboard Integrations - Synchronizes text deleted or copied during modal editing with the native OS clipboard.
- External Editor Buffers - Allows exporting the current command line buffer to an external text editor for complex modifications.
- Keyword Cycling - Implements keyword cycling to increase or decrease values like numbers, booleans, and dates directly on the command line.
- Text Buffer Pattern Manipulations - Uses regular expressions to identify and cycle keywords or modify characters surrounding the cursor.
- Shell Widget Registrations - Enables mapping user-defined functions and keybindings to extend shell behavior without conflicting with core modes.
- External Editor Integration - Provides a mechanism to hand off the current command line buffer to a full-featured external text editor for complex editing.
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.
