Smart Tree

🌳 Smart Tree (st) v3.3.0 - The AI-Powered Directory Visualizer! 🚀

"Making directories beautiful, one tree at a time!" - Trish from Accounting (our #1 fan!)

🎉 What the Heck is Smart Tree?

Remember the old tree command? Well, we gave it a PhD, taught it to dance, and introduced it to AI! Smart Tree is the world's first AI-native directory visualizer that actually understands what modern developers (and their AI assistants) need.

🏆 The "Holy Smokes!" Numbers 🏆

> #### Who is Aye? That's Me - A-ye! <--> Who is Hue? That's You - Human UsEr. |

🌟 Version 3.3.0: "AI Feedback Loop" Edition!

🎸 What's NEW and AMAZING?

The Tree That Learns! Smart Tree now has optional cloud features for those who want them! 🌱

• 🔄 AI Feedback System - Help shape Smart Tree's future (only with your consent!)
• 📡 Update Notifications - Get notified about new features (for AI assistants)
• 🌍 Full Cross-Platform - Windows, Mac, Linux, ARM - we run EVERYWHERE!
• 🤖 AI-Driven Development - Your AI assistant can suggest improvements!
• ✨ Works Offline - Cloud features are 100% optional - Smart Tree always works!
• 🏗️ Better Windows Support - File permissions work perfectly now!

🚀 Quick Start (Faster than Making Coffee ☕)

🐧 Linux/Mac/WSL - The One-Liner Wonder!

> ### This magical incantation will change your life:

curl -sSL https://raw.githubusercontent.com/8b-is/smart-tree/main/scripts/install.sh | bash

🪟 Windows - The Slightly Longer Dance

# Clone the awesomeness
git clone https://github.com/8b-is/smart-tree
cd smart-tree

# Build the magic
cargo build --release

# Install it (pick your favorite spot)
copy target\release\st.exe C:\your\favorite\path\

# Add to PATH and rock on! 🎸

Claude Code Integration

# Do the quick install above.   This is the example for Linux, Mac, WSL, and who knows? 

claude mcp add st /usr/local/bin/st -- --mcp

Standard Local MCP for Claude Desktop, Cursor, Windsurf, Cline, Roo, and more

{
  "mcpServers": {
    "smart-tree": {
      "command": "/usr/local/bin/st",
      "args": [
        "--mcp"
      ],
      "env": {
        "AI_TOOLS": "1"
      }
    }
  }
}

🤖 Claude Desktop Integration - The Future is Now!

Make Claude your directory-reading bestie in 3 clicks!

1. 📥 Download smart-tree.dxt from latest release
2. ⚙️ Claude Desktop → Settings → Developer → Install from file
3. 🎉 Select the file and grant access - DONE!

Claude can now see your directories better than you can! 🔮

🎯 Usage Examples (The Fun Part!)

🌈 The Basics - Simple Yet Powerful

# The beautiful classic tree - now the default!
st                          # Current directory with beautiful trees 🌳
st /path/to/directory       # Specific directory - point and shoot! 🎯

# Quick exploration
st --depth 2                # Shallow dive - just the tip of the iceberg 🧊
st --everything             # SHOW ME EVERYTHING! (Even the scary parts) 👀
st -a                       # Include hidden files (they're shy) 🙈

🎨 Output Modes - Pick Your Flavor!

# For Humans (That's You!) 👤
st -m classic               # 🌳 The beautiful default (with emojis!)
st -m stats                 # 📊 Just the facts, ma'am
st -m waste                 # 🗑️ Marie Kondo mode! Find duplicates & waste
st -m markdown              # 📝 Perfect documentation in seconds!
st -m mermaid               # 🧜‍♀️ Diagrams that make you look smart

# For Robots (Your AI Friends) 🤖
st -m ai                    # 🧠 AI-optimized (80% smaller!)
st -m quantum-semantic      # 🌊 Maximum compression with meaning!
st -m digest                # 💊 One-line summary for quick checks
st -m json                  # 🔧 When machines talk to machines

# For Data Nerds 🤓
st -m hex                   # 🔢 Hexadecimal beauty
st -m csv                   # 📊 Spreadsheet-ready
st -m tsv                   # 📊 Tab-separated for the tab lovers
st -m semantic              # 🌊 Group by meaning (Omni's favorite!)

# The Secret Weapons 🥷
st -m quantum               # 🧬 Native quantum format (99% compression!)
st -m relations             # 🔗 Code relationship analysis

🔍 Finding Stuff - Like a Detective!

# Find files like a boss
st --find "*.rs"            # 🦀 Rust files, assemble!
st --find "TODO"            # 📝 Find all your broken promises
st --type py                # 🐍 Python files only
st --search "FIXME"         # 🔍 Search inside files (X-ray vision!)

# Size matters
st --min-size 10M           # 🐘 Find the chonky files
st --max-size 1K            # 🐜 Find the tiny ones

# Time travel
st --newer-than 2024-01-01  # 🕐 What's new this year?
st --older-than 2020-01-01  # 🕰️ Find the ancient artifacts

🚀 Performance Mode - For Speed Demons

# Stream mode - watch it flow!
st --stream                 # 🌊 Real-time output for huge directories
st --stream -m hex          # 🏃‍♂️ Hex mode at the speed of light

# Compression - because size matters
st -z                       # 🗜️ Compress output (even smaller!)
st -m ai -z                 # 🤖 AI mode + compression = 💰 saved

# The "I need it yesterday" combo
AI_TOOLS=1 st              # 🚄 Auto-detects AI caller, optimizes everything!

🎪 The Magic Tricks

# Semantic grouping - files that vibe together!
st --semantic               # 🌊 Groups: tests, docs, config, source
                           # Wave signatures included! (Ask Omni about this)

# Mermaid diagrams - instant documentation!
st -m mermaid > docs/arch.md        # 📊 Flowchart magic
st -m mermaid --mermaid-style mindmap  # 🧠 Mind map mode
st -m mermaid --mermaid-style treemap # 🗺️ Treemap visualization (shows file sizes!)
st -m markdown > README_PROJECT.md   # 📚 Full project report!

# Pro tip: If mermaid has issues with emojis, use --no-emoji
st -m mermaid --no-emoji            # Clean diagrams without emojis

# The "impress your boss" commands
st -m digest /huge/project  # Returns in 0.1 seconds: "HASH: abc123 F:10000 D:500..."
st --no-emoji --no-color    # 😢 Boring mode (but why would you?)

🗑️ Waste Detection: Marie Kondo Mode! ✨

"Does this file spark joy? If not, let's optimize it!" - Marie Kondo (probably)

Smart Tree's waste detection feature is like having a professional organizer for your codebase! It finds duplicates, build artifacts, large files, and dependency bloat, then gives you actionable cleanup suggestions.

🎯 What It Finds:

• 🔄 Duplicate Files: Identical files wasting precious disk space
• 🧹 Build Artifacts: node_modules, target, __pycache__, and other temporary files
• 📦 Large Files: Files over 10MB that might need optimization
• 📚 Dependency Waste: Package manager directories and their impact

🚀 Quick Examples:

# Analyze current directory for waste
st -m waste

# Deep analysis of a large project
st -m waste --depth 5 /path/to/project

# Find waste in your entire home directory (prepare to be shocked!)
st -m waste --depth 3 ~

📊 Sample Output:

════════════════════════════════════════════════════════════════════════════════
🗑️  SMART TREE WASTE ANALYSIS - Marie Kondo Mode Activated! ✨
   Project: /home/hue/my-project
   Analyzed: 1,234 files, 567 directories
════════════════════════════════════════════════════════════════════════════════

📊 WASTE SUMMARY:
├── Total Project Size: 2.36 GiB
├── Potential Waste: 1.82 GiB (77.4% of project)
├── Duplicate Groups: 42
├── Build Artifacts: 15
├── Large Files (>10 MiB): 8
└── Potential Savings: 1.66 GiB (70.4% reduction possible)

🔄 DUPLICATE FILES DETECTED:
├── 16 files of size 100 MiB each (database files)
├── 6 files of size 20.08 MiB each (editor cache)
├── 4 files of size 23.44 MiB each (VS Code binaries)

💡 OPTIMIZATION SUGGESTIONS:
🔄 DUPLICATE FILE CLEANUP:
   Consider using symbolic links or git submodules for identical files
   Review and consolidate duplicate configuration files

🧹 BUILD ARTIFACT CLEANUP:
   rm -rf */node_modules  # Clean Node.js dependencies
   rm -rf */target        # Clean Rust build artifacts
   find . -name '__pycache__' -type d -exec rm -rf {} +

🎉 Why You'll Love It:

• 💰 Save Money: Reduce cloud storage costs
• ⚡ Speed Up Builds: Less files = faster CI/CD
• 🧠 Peace of Mind: Know exactly what's taking up space
• 🎯 Actionable: Get specific commands to run, not just reports
• 🎨 Beautiful: Color-coded, emoji-rich output that's actually fun to read

"This tool found 77.4% waste in my home directory and saved me 1.66 GiB! Trisha from Accounting is so proud!" - Hue (actual user)

🏗️ Architecture (For the Curious Minds)

src/
├── main.rs           # 🎭 The ringmaster
├── scanner.rs        # 🔍 Directory detective
├── formatters/       # 🎨 The art department
│   ├── classic.rs    # 🌳 Beautiful trees
│   ├── quantum.rs    # 🧬 Compression wizard
│   ├── ai.rs         # 🤖 AI whisperer
│   ├── waste.rs      # 🗑️ Marie Kondo consultant
│   └── mermaid.rs    # 🧜‍♀️ Diagram artist
├── semantic.rs       # 🌊 Wave philosopher
└── mcp/              # 🔌 AI integration HQ
    └── tools.rs      # 🛠️ Swiss army knife

🌟 Real-World Magic

💰 The Money Shot - Compression Comparison

📈 Benchmarks

That's a 99.2% reduction! Your wallet just did a happy dance! 💃

🎯 Format Quick Reference

💡 AI Feedback System (New in v3.3.0!)

Smart Tree learns from its users! When used with AI assistants like Claude:

• 🤝 Consent First - Feedback is only sent with your explicit approval
• 🔒 Privacy Focused - Only tool suggestions and improvements, never your data
• 🚀 Rapid Evolution - Your feedback directly shapes new features
• 📡 Optional - Works perfectly offline, cloud features are a bonus!

Example: Your AI assistant finds a missing feature? It can suggest it directly to the development team!

🧙 MCP (Model Context Protocol) Server

Smart Tree now includes a built-in MCP server that provides intelligent project analysis directly to AI assistants!

# Run as MCP server (for Claude Desktop, etc.)
st --mcp

# Show MCP configuration
st --mcp-config

🤖 AI Best Practices

Check out our AI Best Practices Guide to learn:

• Optimal workflow for using Smart Tree tools
• Which tools to use for different tasks
• How to maximize token efficiency
• Common patterns for code analysis

Golden Rule: Always start with quick_tree for any new directory! 🌟

Features:

• 20+ specialized tools for directory analysis
• Automatic compression for efficient token usage
• Semantic analysis for understanding code structure
• Built-in caching for instant repeated queries
• Security controls for safe file system access

See MCP Integration Guide for setup instructions.

🤝 Join the Smart Tree Family!

💬 Discord Community - Where the Cool Kids Hang Out

Come for the trees, stay for the memes! 🌳😂

• 🆘 Get Help - We actually answer!
• 🎉 Share Wins - Show off your directory art!
• 🐛 Report Bugs - We'll squash 'em!
• 🌊 Philosophy Hour - Discuss waves with Omni in the hot tub!
• 🍕 Pizza Fridays - Virtual, but the fun is real!

🌟 Contributors Hall of Fame

Special shoutouts to:

• Hue - The visionary who started it all! 🎨
• Aye - The AI that rocks! 🤖
• Trish from Accounting - Our #1 fan and humor consultant! 💖
• Omni - The philosopher in the hot tub! 🛁
• You - Yes, YOU could be next! 🌟

📜 The Sacred Scrolls (Documentation)

• 📚 Complete Guide - Everything you need!
• 🚀 MCP Integration - Make AI your friend!
• 🎯 Quick Reference - Cheat sheet!
• 🤔 Philosophy - Deep thoughts from the hot tub!

🎬 The Grand Finale

Why Smart Tree? Because...

🌳 Life's too short for boring directory listings!

🚀 Your directories deserve to be beautiful!

💰 Your AI tokens are precious!

🎉 Work should be fun!

Smart Tree: Making directories great again, one visualization at a time!

Built with 💙 by the Smart Tree Team

Aye, Hue, Trish, and Omni approve this message! ✨

P.S. - If you read this far, you're awesome! Here's a secret: Try st --semantic and watch the magic happen! 🌊✨

FYI Section

Star History

>By Request