peco/peco
Peco
Peco is an interactive text filter and fuzzy finder for the terminal. It serves as a terminal user interface selection tool that filters standard input in real-time using fuzzy matching and regular expressions.
The tool preserves and renders ANSI color escape sequences from piped input streams while performing matching logic on plain-text versions. It supports multi-stage filtering, allowing users to freeze result sets to create a new base for subsequent refinements.
Capability areas include advanced search filtering with negative matching, multi-item selection, and the ability to pipe selected lines into external shell commands. The interface is customizable via layout configurations, key binding maps, and the integration of external filter binaries.
The project is written in Go and provides a compiled binary executable.
Features
- Interactive Text Filters - Offers a real-time interactive interface to sift through long lists of text using fuzzy matching and regular expressions.
- Interactive Selection Interfaces - Provides a searchable TUI interface with fuzzy matching and query refinements for sifting through text lists.
- Fuzzy Matching - Calculates match quality using fuzzy logic and regular expressions to filter input lines.
- Command Line Automation Tools - Enables the automation of repetitive system tasks by piping filtered text selections into other shell commands.
- Fuzzy Finders - Provides a command-line interface for searching and selecting items from text lists using approximate string matching.
- Line-Based Text Filters - Implements real-time filtering of text lines using regular expressions and negative matching.
- Selection-Based Command Execution - Passes selected lines from a filtered list to a shell command for immediate execution.
- Terminal Viewports - Renders a scrollable viewport of filtered results within a fixed-height terminal window.
- Interactive Command-Line Filters - Provides real-time, interactive filtering of standard input streams using fuzzy matching and regular expressions.
- ANSI Escape Sequence Renderers - Preserves and renders ANSI escape sequences to maintain colored text in the terminal interface.
- Standard Input Processing - Reads and processes text from the standard input stream for real-time interactive filtering.
- Search Filters - Provides logic to filter and narrow down available options using case-sensitivity and fuzzy matching.
- Searchable Filter Inputs - Provides a searchable interface for narrowing down lists of text provided via standard input.
- List Search Filters - Provides real-time filtering mechanisms to narrow down long lists of input text using external binaries.
- Multiple Selections - Provides capabilities for selecting multiple individual items or ranges from a filtered list.
- Text Line Selection - Ships a terminal user interface for choosing single or multiple lines of text to pipe into other shell commands.
- Text-User Interface Rendering - Renders a searchable text-user interface in the terminal to manage layout and colors for filtering.
- Multi-Stage Filtering - Supports narrowing lists through layers by snapshotting results to create new bases for subsequent filtering.
- Custom Matching Logic - Implements a system for using external executables to perform specialized matching logic on input data.
- Negative Search Terms - Provides negative matching capabilities to remove lines from results using a minus sign prefix.
- Search Result Filtering - Enables locking a result set to allow clearing queries while maintaining the filtered list.
- Search Result Snapshots - Allows users to snapshot current filtered results to create a new base for subsequent search refinements.
- Command Piping - Pipes selected lines of text as standard input to an external shell command.
- External Process Integrations - Integrates with external binaries to execute custom shell commands for matching logic.
- Key Sequence Patterns - Matches multi-key sequences to specific commands using a longest-match-wins resolution strategy.
- Iterative Search Refinement - Supports narrowing down large datasets by iteratively freezing search results to create a new base for further refinement.
- Keybinding Configurations - Supports mapping terminal key sequences to built-in actions to automate selection tasks.
- Shell Command Execution - Executes shell commands using selected lines as standard input without exiting the interface.
- Circular Memory Buffers - Uses a circular buffer to discard oldest entries when memory limits are reached.
- Terminal Stream Following - Automatically scrolls the viewport to keep the newest lines visible as input streams in.
- Configurable Key-to-Command Mappings - Includes a system for mapping specific keys or sequences to internal commands via configuration.
- Log Analysis Tools - Provides utilities for searching through real-time log streams while preserving ANSI color formatting.
- Auto-Scrolling Viewports - Pins the viewport to the end of the text buffer so new lines in a stream appear immediately.
- External Filter Integrations - Allows users to integrate external scripts or programs to implement custom matching logic for input buffers.
- Layout Configurations - Adjusts the position and dimensions of the query prompt and result list through layout settings.
- End-of-Stream Auto-Scrolling - Tracks the end of a text stream to keep latest incoming lines visible.
- Terminal UI Components - Acts as a reusable searchable selection component that can be integrated into other command-line tools.
- Full Screen TUI Layouts - Supports various TUI layouts including full-screen, inline bottom-panel, and bottom-up orientations.
- Interface Appearance Customization - Allows customization of the terminal interface's visual themes, prompt text, and color styles.
- Command Line Environment - Interactive filtering tool for command line output.
- Developer Utilities - Interactive filtering tool for CLI output.
- General Utilities - Interactive filtering tool.
- General Utility Libraries - Interactive filtering tool.
- Text Processing - Interactive filtering tool for command output.
- General Programming - Documentation for an interactive filtering tool.
