rusty-roots
| Crates.io | rusty-roots |
| lib.rs | rusty-roots |
| version | 0.3.0 |
| source | src |
| created_at | 2024-08-27 02:27:11.440877 |
| updated_at | 2024-09-05 22:23:33.022375 |
| description | A Rust CLI tool that replicates the Unix 'tree' command with enhanced features. |
| homepage | https://github.com/kathirmeyyappan/rusty-roots |
| repository | https://github.com/kathirmeyyappan/rusty-roots |
| max_upload_size | |
| id | 1352799 |
| size | 33,938 |
Kathir Meyyappan (kathirmeyyappan)
documentation
https://github.com/kathirmeyyappan/rusty-roots/blob/main/README.md
README
rusty-roots
- CLI tool that displays directory structure of a specified path in tree-like format, similar to the
treeUnix command. - Allows customized output by ignoring certain files and directories (see
.rrignorefile!). - Supports colorized output (file-type-based coloring, tree depth gradients, etc.).
Demo
Here is a short example video showing rusty-roots in action:
https://github.com/user-attachments/assets/9689ad2f-937b-4b58-a9a9-217c85ccd2e3
Installation
Prerequisites
- Ensure Rust is installed. Visit: https://www.rust-lang.org/tools/install.
Steps
- Install rusty-roots:
cargo install rusty-roots
- Run rusty-roots in some directory (with or without extra args, as specified below):
rusty-roots
Options
Usage: rusty-roots [OPTIONS]
Options:
-p, --path <PATH> Path to get tree from
-i, --ignore Ignore files and directories as specified in {$path}/.rrignore
-f, --fast-print Print directory on the fly without pre-calculation
-h, --help Print help
-V, --version Print version
tip: If the program seems to be hanging because the called directory is extremely large, try running with -f. Pre-calculation for the branch color gradient is not done when this flag is called, so the program will be able to print the tree on-the-fly.