Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/andydunstall/tree
CLI tool to view your directory tree
https://github.com/andydunstall/tree
Last synced: 28 days ago
JSON representation
CLI tool to view your directory tree
- Host: GitHub
- URL: https://github.com/andydunstall/tree
- Owner: andydunstall
- License: mit
- Created: 2021-03-27T08:10:19.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-16T18:16:20.000Z (almost 3 years ago)
- Last Synced: 2024-10-28T20:10:32.585Z (3 months ago)
- Language: Rust
- Size: 147 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tree
A CLI tool to list your directory tree.
This is a simplified implementation of UNIX [tree](https://linux.die.net/man/1/tree)
with added features for filtering files. By default will hide all files
listed in the current workspaces `.gitignore` (disabled with `-g` flag) as
its often frustrating to list output directories like `venv/` and `target/`.
## Getting Started
### Download
```sh
wget https://github.com/dunstall/tree/releases/download/a.b.c/tree-variant
chmod +x tree-variant
mv tree-variant /usr/local/bin/tree
```
### Installation
```sh
git clone [email protected]:dunstall/tree.git && cd tree
cargo build --release
cp target/release/tree /usr/local/bin
```
### Testing
```sh
git clone [email protected]:dunstall/tree.git && cd tree
cargo test
```
### Flags
See `tree --help` for the full CLI.
## Roadmap
* Add `-f` flag to filter files shown (`*.java`, `SB*.h*`, ...)
* Pretty print byte count (KB, MB...)
* Add glob support
* Add missing matching rules for `.gitignore` from `https://git-scm.com/docs/gitignore#_pattern_format`
* Add support for multiple directories (`tree bin/ src/`)
## Licence
See `LICENSE` for more information.