rust-tree

Features

Installation

From Source

cargo install --path .

Build from Source

git clone <repository-url>
cd rust-tree
cargo build --release

Usage

Basic Usage

# Show current directory tree
rust-tree
# Show a specific directory
rust-tree /path/to/directory
# Limit depth to 2 levels
rust-tree -d 2 /path/to/directory

Output Formats

# Tree format (default)
rust-tree
# JSON format
rust-tree -f json
# Table format with statistics
rust-tree -f table -S

Color Support

# Always use colors
rust-tree --color=always
# Never use colors (useful for piping to files)
rust-tree --color=never
# Auto-detect terminal support (default)
rust-tree --color=auto
# Use extended color scheme with more file type colors
rust-tree --color-scheme=extended

Filtering

# Exclude files matching a pattern
rust-tree --exclude "*.log"
# Exclude multiple patterns
rust-tree -e "*.log" -e "node_modules" -e ".git"
# Include only files matching a pattern
rust-tree --include-only "*.rs"
# Use common exclude patterns for specific languages
rust-tree --exclude-common=rust # Rust projects
rust-tree --exclude-common=python # Python projects
rust-tree --exclude-common=nodejs # Node.js projects
rust-tree --exclude-common=common # Common development files

Progress Indication

# Show progress bar during scanning
rust-tree --progress

Streaming Mode

# Use streaming mode for low memory usage on large directories
rust-tree --streaming

Display Options

# Show file sizes
rust-tree -s
# Show hidden files
rust-tree -a
# Sort by file size (descending)
rust-tree -o size -r
# Sort by file type
rust-tree -o type

Examples

# Display tree with colors and sizes
rust-tree --color=always -s
# Scan with progress indication for large directories
rust-tree --progress /large/directory
# Exclude build artifacts and dependencies
rust-tree --exclude-common=rust --exclude "*.rlib"
# Memory-efficient scanning with streaming
rust-tree --streaming -d 5 /very/large/directory
# JSON output with full statistics
rust-tree -f json -S > stats.json
# Show only Rust source files
rust-tree --include-only "*.rs"
# Colored tree with statistics
rust-tree --color-scheme=extended -s -S

Command-Line Options

Output Examples

Tree Format

src/
├── core/
│ ├── models.rs
│ ├── walker.rs
│ └── collector.rs
├── formatters/
│ ├── tree.rs
│ ├── json.rs
│ └── table.rs
├── config.rs
├── lib.rs
└── main.rs

JSON Format

{
 "tree": {
 "root": {
 "name": "src",
 "type": "directory",
 "children": [...]
 }
 },
 "stats": {
 "total_files": 11,
 "total_directories": 3,
 "total_size": 42944,
 "files_by_extension": {
 ".rs": {
 "count": 11,
 "total_size": 42944,
 "percentage": 100.0
 }
 }
 }
}

Table Format

╭──────────────────╬────────╮
│ Statistics ║ │
╞══════════════════╪════════╡
│ Total Files ║ 11 │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌┤
│ Total Directories╩ 3 │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌┤
│ Total Size ║ 42 KB │
╰──────────────────┴────────╯

Development

Project Structure

rust-tree/
├── src/
│ ├── main.rs # CLI entry point
│ ├── lib.rs # Library interface
│ ├── config.rs # Configuration & CLI parsing
│ ├── core/ # Core functionality
│ │ ├── models.rs # Data structures
│ │ ├── walker.rs # Directory traversal
│ │ ├── collector.rs # Statistics collection
│ │ ├── filter.rs # Pattern filtering
│ │ ├── progress.rs # Progress indication
│ │ └── streaming.rs # Memory-efficient streaming
│ └── formatters/ # Output formatters
│ ├── tree.rs # Tree format
│ ├── json.rs # JSON format
│ ├── table.rs # Table format
│ └── streaming_tree.rs # Streaming tree format
├── docs/ # Documentation
└── tests/ # Tests

Running Tests

cargo test

Building

# Debug build
cargo build
# Release build
cargo build --release

Documentation

License

Contributing