vtreex

Crates.iovtreex
lib.rsvtreex
version0.1.2
created_at2025-06-20 08:08:55.942731+00
updated_at2025-06-20 09:47:44.774351+00
descriptionA fast, colorful directory tree viewer written in Rust.
homepage
repositoryhttps://github.com/07calc/vtreex
max_upload_size
id1719275
size17,187
CalC (07CalC)

documentation

README

๐Ÿ“ 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
Commit count: 0

cargo fmt