Skip to content

07CalC/vtreex

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📁 vtreex

A fast and colorful Rust CLI tool to print directory trees — like tree, but better.
Includes stats, ignore filters, text export, and human-readable performance timing.

2025-06-20-134204_hyprshot


🚀 Features

  • ✅ Beautiful Unicode tree output with colors
  • 📦 Built-in ignore list (.git, node_modules, etc.)
  • 🧹 --ignore and --include for custom control
  • 📊 Optional stats: number of files, dirs, and total size
  • ⏱️ Human-readable processing time
  • 📄 Save output to a .txt file

📦 Installation

Prerequisites

  • rust and cargo 👉 Install via rustup.rs:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Then restart your terminal and verify:

rustc --version
cargo --version

Install from crates.io

cargo install vtreex

Build from source

git clone https://github.com/07calc/vtreex.git
cd vtreex
cargo build --release
cargo install --path .

📂 Examples

Basic usage

vtreex ${path} ( . by default)

Limit depth

vtreex -d 3

show stats

vtreex --stats

Output to a file

vtreex --output tree.txt

Include ignored folders (e.g., .git)

vtreex --include .git

📊 Sample Output

.
├── .gitignore
├── Cargo.lock
├── Cargo.toml
└── src
    └── main.rs

📁 1 directories, 📄 4 files
📦 Total size: 12.87 kB

⏱️ Processed in 124μs

About

CLI tool to print directory trees

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages