2 stable releases
1.0.1 | Jun 22, 2024 |
---|
#286 in Filesystem
7KB
92 lines
pathy 🦀
Minimal Rust CLI tool to display directory structures
Features
- 🧠 Smart Display: Automatically excludes commonly ignored directories (e.g
.git
andnode_modules
) for a cleaner tree visualization. - 👨🦯 Easy Exclusions: Use the
-i
option to seamlessly omit any specific directories & files from the display.
Install
via Cargo
cargo install pathy
via Source
git clone https://github.com/fearandesire/pathy.git
cd pathy
cargo build --release
cargo install .
Usage
Basic usage: pathy <directory>
Arguments
<directory>
: Directory to display. Defaults to the current directory.-i
, or--ignore
: Specify directories or files to ignore`-h
, or--help
: Display this help message-v
, or--version
: Display the current version
Default Ignored Directories
You can review the default ignored directories here
Examples
pathy .
# Ignoring a directory
pathy -i docs
# Ignoring multiple directories
pathy -i docs node_modules .
# Ignore a directory and a any file
pathy -i docs README.md
Notice: Ignoring a directory / a file will explicitly exclude any exact match. E.g, ignoring
-i README.md
will ignoreREADME.md
from the file tree visualization entirely, no matter how far down it is.
Contributing
Contributions are welcome! Please feel free to submit pull requests or open issues to improve the functionality or documentation of pathy.
License
This project is licensed under the MIT License - see the LICENSE file for details.
Author
Dependencies
~1.2–8.5MB
~70K SLoC