lotabout/skim
Skim
Skim is an interactive text filter and terminal selection tool written in Rust. It functions as a command line interface utility that processes input streams to isolate specific entries through real-time user queries and sorting.
The tool differentiates itself through ANSI compatibility, allowing it to parse color codes and maintain text formatting during the search process. It supports multiple matching strategies, including configurable fuzzy matching algorithms and regular expression integration.
The application covers a broad range of capabilities including field-specific filtering, result sorting, and a command-based preview system for highlighted items. It provides extensive integration for shells and text editors, including the generation of completion scripts and customizable key bindings.
The project includes execution debugging and search performance benchmarking to monitor resource usage and execution speed.
Features
- Fuzzy Matching - Core functionality providing multiple configurable fuzzy-matching algorithms to isolate entries through real-time queries.
- Interactive Text Filters - Provides a real-time, interactive TUI for searching and filtering text streams using fuzzy matching and regular expressions.
- Interactive Stream Filtering - Allows running external processes and piping their real-time output into a searchable interface for immediate analysis.
- Fuzzy Finders - Implements a high-performance fuzzy finder in Rust for searching and selecting items from text lists.
- Fuzzy Search Interfaces - Provides a real-time search interface that narrows down results as the user types using fuzzy matching.
- Regular Expressions - Integrates a regular expression engine as a secondary matching strategy for pattern-based filtering.
- Shell Completion Generators - Generates shell-specific completion scripts to accelerate command execution from the terminal.
- ANSI Sequence Parsers - Implements parsing logic for ANSI escape sequences to preserve text colors and formatting during interactive filtering.
- Shell Integration - Provides deep shell integration through key bindings and completion scripts for common terminal environments.
- Command Line Utilities - Provides a selection interface that integrates into shell scripts to automate command-line workflows.
- Interactive Selection Interfaces - Provides a searchable terminal interface for filtering and selecting text items to be piped into other tools.
- High-Performance Text Processing - Leverages Rust's memory safety and performance to ensure low-latency searching during high-volume text processing.
- Standard Stream Piping - Processes data piped from external processes in real time via standard input streaming.
- List Search Filters - Implements real-time filtering mechanisms to narrow down long lists of selectable text options.
- Pattern Matching Engines - Supports matching patterns within a data source using regular expressions as an alternative to fuzzy logic.
- Field-Specific Filtering - Enables restricting search algorithms to specific columns of a text line by parsing delimiters.
- Search Result Sorting - Orders matched records based on customizable criteria such as score, index, or string length.
- Custom Key Mappings - Allows users to define custom keyboard shortcuts to modify interaction with the filtering tool.
- Selection Content Previews - Provides a system to render real-time content previews of selected items by executing external commands.
- External Command Execution - Executes dynamic system commands and captures their output for immediate interactive filtering.
- External Command Integrations - Passes selected items from the interface to other external tools or shell commands.
- File Navigation Tools - Enables rapid file searching and project-wide navigation via an interactive fuzzy search interface.
- Shell Completion - Provides shell-specific completion scripts to accelerate command execution within the terminal.
- Text Editor Plugin Integrations - Enables triggering the fuzzy finder from within text editors to select files or text fragments.
- Dynamic Content Previews - Displays the content of a highlighted item by executing a configured external process with the selection as an argument.
- Configurable Key-to-Command Mappings - Allows users to map specific keys to application actions or shell commands via a configuration table.
- Field-Specific Matching - Restricts search matching to specific columns of delimited data sources to ignore irrelevant information.
- Search and Discovery - A general fuzzy finder written in Rust, similar to fzf.
- fzf - Listed in the “fzf” section of the Awesome Alternatives In Rust awesome list.
