forked from RodrigoRVSN/groot
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
74 additions
and
28 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,23 @@ | ||
[package] | ||
name = "groot-tree" | ||
name = "regroot" | ||
version = "0.3.0" | ||
edition = "2021" | ||
description = "Walk in thee directories" | ||
authors = ["Community"] | ||
documentation = "https://github.com/rodrigorvsn/groot" | ||
authors = ["RodrigoRVSN", "z1xus"] | ||
description = "A modern, colorful directory tree viewer with glob pattern support" | ||
documentation = "https://github.com/z1xus/regroot" | ||
homepage = "https://github.com/z1xus/regroot" | ||
repository = "https://github.com/z1xus/regroot" | ||
readme = "README.md" | ||
license = "MIT" | ||
keywords = ["cli", "tree"] | ||
categories = ["cli", "tree"] | ||
keywords = ["tree", "directory", "filesystem", "cli", "glob"] | ||
categories = ["command-line-utilities", "filesystem", "development-tools"] | ||
|
||
# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html | ||
|
||
[dependencies] | ||
clap = { version = "4.5", features = ["derive"] } | ||
glob = "0.3" | ||
|
||
[package.metadata.docs.rs] | ||
all-features = true | ||
rustdoc-args = ["--cfg", "docsrs"] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,28 +1,67 @@ | ||
# Groot | ||
# regroot | ||
|
||
## Directories tree | ||
An updated version of the original [groot-tree](https://crates.io/crates/groot-tree) crate by [RodrigoRVSN](https://github.com/RodrigoRVSN). | ||
|
||
![image](https://github.com/RodrigoRVSN/groot/assets/75763403/67f9821b-62b3-49a9-849d-491b93ff47a7) | ||
<p align="center"> | ||
<img src="https://github.com/user-attachments/assets/e29f561d-e49d-46f9-b302-01d3178d16d1" alt="regroot preview" /> | ||
</p> | ||
|
||
## How to use | ||
<p align="center"> | ||
<a href="https://crates.io/crates/regroot"> | ||
<img src="https://img.shields.io/crates/v/regroot.svg" alt="Version" /></a> | ||
<a href="https://crates.io/crates/regroot"> | ||
<img src="https://img.shields.io/crates/d/regroot.svg" alt="Downloads" /></a> | ||
<a href="https://github.com/Z1xus/regroot/issues?q=is%3Aissue+is%3Aopen+" alt="GitHub issues"> | ||
<img src="https://img.shields.io/github/issues/z1xus/regroot"></a> | ||
<a href="https://github.com/Z1xus/regroot/pulls?q=is%3Apr+is%3Aopen+" alt="GitHub pull requests"> | ||
<img src="https://img.shields.io/github/issues-pr/z1xus/regroot"></a> | ||
</p> | ||
|
||
Install locally and run | ||
## Features | ||
|
||
``` | ||
cargo run . --help | ||
``` | ||
- 🎨 Color-coding for files and directories | ||
- 🔍 Glob pattern support | ||
- 📊 Customizable depth levels | ||
- 📁 Directory-only view option | ||
- 🌳 Clean and minimal tree structure | ||
|
||
Or install by [crates]([url](https://crates.io/crates/groot-tree)https://crates.io/crates/groot-tree) | ||
## Installation | ||
|
||
``` | ||
cargo install groot-tree | ||
Via cargo: | ||
```bash | ||
cargo install regroot | ||
``` | ||
|
||
Or build from source: | ||
```bash | ||
git clone https://github.com/z1xus/regroot | ||
cd regroot | ||
cargo build --release | ||
``` | ||
groot-tree --help | ||
|
||
## Usage | ||
|
||
Basic usage: | ||
```bash | ||
regroot . | ||
tree . # alias | ||
``` | ||
|
||
Common options: | ||
```bash | ||
# Show only 2 levels deep | ||
regroot -d 2 . | ||
|
||
# Use glob patterns for path | ||
regroot "src/{bin,lib}/*" | ||
|
||
# Ignore paths using glob patterns | ||
regroot -i "*.pyc,tests/*" . | ||
|
||
# Show only directories | ||
regroot --dirs-only . | ||
``` | ||
|
||
## Tools used | ||
## License | ||
|
||
- Rust | ||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details. |