lumin
| Crates.io | lumin |
| lib.rs | lumin |
| version | |
| source | src |
| created_at | 2025-04-23 06:24:12.734062+00 |
| updated_at | 2025-05-13 14:54:32.161704+00 |
| description | A library for searching and displaying local files |
| homepage | |
| repository | |
| max_upload_size | |
| id | 1645111 |
| Cargo.toml error: | TOML parse error at line 18, column 1 | 18 | autolib = false | ^^^^^^^ unknown field `autolib`, expected one of `name`, `version`, `edition`, `authors`, `description`, `readme`, `license`, `repository`, `homepage`, `documentation`, `build`, `resolver`, `links`, `default-run`, `default_dash_run`, `rust-version`, `rust_dash_version`, `rust_version`, `license-file`, `license_dash_file`, `license_file`, `licenseFile`, `license_capital_file`, `forced-target`, `forced_dash_target`, `autobins`, `autotests`, `autoexamples`, `autobenches`, `publish`, `metadata`, `keywords`, `categories`, `exclude`, `include` |
| size | 0 |
tacogips (tacogips)
documentation
README
lumin: A File Searcher
A Rust utility for searching, traversing, and viewing files with rich filtering options and type-aware content handling.
Features
- Search: Find text patterns in files using regex
- Traverse: List files in directories with advanced filtering
- View: Display file contents with type detection (text, binary, image)
Installation
cargo install --path .
Usage
Search for text patterns
lumin search <PATTERN> <DIRECTORY> [OPTIONS]
Options:
--case-sensitive: Enable case-sensitive matching--ignore-gitignore: Ignore .gitignore rules--omit-context <NUM>: Limit context around matches to show only NUM characters before and after each match (the matched pattern itself is always displayed in full)
Traverse directories
lumin traverse <DIRECTORY> [OPTIONS]
Options:
--case-sensitive: Enable case-sensitive filtering--ignore-gitignore: Ignore .gitignore rules--all-files: Include binary files (default: text files only)
View file contents
lumin view <FILE_PATH> [OPTIONS]
The view command outputs a structured JSON with:
- File path
- File type
- Contents (text, binary, or image with appropriate metadata)
Key Features
- Gitignore-aware operations
- Type detection using extension and content analysis
- Strongly typed output structures
- Comprehensive error handling
- Context control for search results to focus on relevant matches
Development
# Build
cargo build
# Test
cargo test
# Format code
cargo fmt
# Run linter
cargo clippy
License
MIT
Contributing
See CONTRIBUTING.md for guidelines.