repo-summarizer
| Crates.io | repo-summarizer |
| lib.rs | repo-summarizer |
| version | |
| source | src |
| created_at | 2025-03-02 21:57:23.429958+00 |
| updated_at | 2025-03-03 21:19:00.251196+00 |
| description | A tool for generating a text file summary of directory contents |
| homepage | |
| repository | https://github.com/katsuhirohonda/repo-summarizer |
| max_upload_size | |
| id | 1574911 |
| 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 |
Katsuhiro Honda (katsuhirohonda)
documentation
README
Repo Summarizer
A command-line tool that generates a comprehensive summary of a repository or directory structure.
Features
- Recursively traverses directories
- Displays directory structure as a tree
- Shows file contents with line numbers
- Ignores binary files
- Provides statistics about file types and line counts
- Excludes specified directories or files (e.g.,
.git,node_modules, etc.) - Notes symlinks without following them
Installation
cargo install repo-summarizer
Usage
repo-summarizer [OPTIONS] <INPUT_DIR> <OUTPUT_FILE>
Options
-e, --exclude <PATTERNS> Patterns to exclude (comma-separated glob patterns)
-h, --help Print help
-V, --version Print version
Example
repo-summarizer ~/projects/my-rust-app ./summary.txt --exclude "target,node_modules,.git"
Output Format
The output file will include:
- A tree view of the directory structure
- File contents with line numbers
- Statistics about the project (number of files, directories, lines of code)
License
This project is licensed under the MIT License - see the LICENSE file for details.