playfairs/clearvision
Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
Repository files navigation
ClearVision I can see Clearly. DEFINITIONS: (a). 'ClearVision' means the ClearVision software project, including all source code, documentation, assets, and related materials contained within its codebase. (b). 'grep' and 'ripgrep' mean the respective text-search utilities known by those names and are referenced solely for comparison, compatibility, or explanatory purposes. (c). 'User' means any individual or entity that downloads, executes, studies, modifies, distributes, or otherwise interacts with ClearVision. (d). 'Release' means any published version of ClearVision identified by a version number, tag, commit, or distribution package. ClearVision is a fast, modern recursive search utility written in C that builds upon the proven search capabilities of Ripgrep. Rather than implementing a search engine from scratch, ClearVision uses Ripgrep as its search backend while providing additional functionality focused on project exploration, indexing, workflow improvements, and developer experience. The project is inspired by tools such as grep and ripgrep and is designed to complement them rather than replace them. ClearVision leverages Ripgrep's performance and mature search capabilities while exploring alternative approaches to result presentation, project navigation, indexing, configuration management, and search workflows. The primary goal of ClearVision is to provide a streamlined and intuitive interface for searching files, directories, and large codebases while maintaining the speed, simplicity, and reliability developers expect from modern command-line tools. By combining Ripgrep's search engine with additional tooling and workflow enhancements, ClearVision aims to offer a practical and efficient experience for developers working with large projects and complex repositories. INSTALLATION: ClearVision uses Just as its build orchestration tool. Ensure you have the following dependencies installed: - clang (or gcc) - pkg-config - sqlite3 - pcre2 - ncurses - pthreads BUILD COMMANDS: just build just release just clean just install just uninstall NIX: ClearVision provides a Nix flake for reproducible development and builds: nix develop nix build nix run USAGE: BASIC SEARCH: cv search "pattern" cv regex "pattern" cv fuzzy "pattern" SEARCH OPTIONS: cv search "pattern" -i cv search "pattern" -w cv search "pattern" -c cv search "pattern" -A 3 cv search "pattern" -B 3 cv search "pattern" -C 3 cv search "pattern" -j 8 FILE FILTERING: cv search "pattern" --hidden cv search "pattern" --follow cv search "pattern" --include "*.c" cv search "pattern" --exclude "*.o" cv search "pattern" --max-size 1048576 OUTPUT FORMATS: cv search "pattern" --json cv search "pattern" --tree cv search "pattern" --stats INDEXING: cv index <path> cv rebuild cv remove-index cv stats INTERACTIVE INTERFACE: cv tui OTHER COMMANDS: cv version cv help CONFIGURATION: ClearVision uses the following filesystem paths: - Configuration: ~/.config/clearvision - Cache: ~/.cache/clearvision - Data: ~/.local/share/clearvision