Skip to content

Commit

Permalink
groot-tree -> regroot
Browse files Browse the repository at this point in the history
  • Loading branch information
Z1xus committed Jan 3, 2025
1 parent 4b406c9 commit 5346864
Show file tree
Hide file tree
Showing 3 changed files with 74 additions and 28 deletions.
16 changes: 8 additions & 8 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

19 changes: 13 additions & 6 deletions Cargo.toml
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"]
67 changes: 53 additions & 14 deletions README.md
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.

0 comments on commit 5346864

Please sign in to comment.