gabbium-tree 1.0.0

CLI to print a project directory tree

gabbium-tree

A simple Python CLI to print a directory tree (like tree command), with support for depth limits, hidden files, and excludes.

✅ What it does

• Prints a project folder structure in a clean tree format\
• Supports options like:
  • --max-depth → limit tree depth\
  • --only-dirs → show only directories\
  • --exclude → skip specific directories (defaults: .git, node_modules, __pycache__, ...)\
  • --output → save output to file

---

📦 Installation

pip install gabbium-tree

---

⚙️ Usage

Basic:

gtree .

Limit depth:

gtree . --max-depth 2

Only directories:

gtree . --only-dirs

Exclude extra paths:

gtree . --exclude dist build

Save to file:

gtree . --output tree.txt

Or with shell redirection:

gtree . > tree.txt

---

🔑 Features

• Cross-platform (Windows, macOS, Linux)\
• Prints with Unicode characters (fallback to ASCII if needed)\
• Defaults to ignoring common junk folders (.git, node_modules, __pycache__)

---

✅ Example output

~/my-project
├── src/
│   ├── app/
│   └── utils/
├── tests/
└── pyproject.toml

---

🛠 Roadmap

• Option for ASCII-only mode (--ascii)\
• Output to file (--output tree.txt)\
• Config file support (.gtreerc)

---

🪪 License

This project is licensed under the MIT License -- see LICENSE for details.