treeit-cli 1.0.1

CLI tool to generate a directory tree view of your project

🌳 tree-it

A simple and flexible CLI tool to generate a visual representation of your project's directory tree — with support for advanced ignore rules (like .gitignore).

Generate a clean overview of your folder structure in seconds.

---

🔧 Features

• Output a tree view of any directory
• Control the depth of the tree with a --depth option (0, 1, ..., or full)
• Ignore folders, files or patterns (e.g. *.log, folder/, folder/*)
• Show folder names without listing their content
• Export result to a readable .txt file
• Works on any OS with Python 3

---

📦 Installation

Install from PyPI:

pip install treeit-cli

⚠️ Note: This project is currently published under the name treeit-cli on PyPI
If the name tree-it becomes available in the future, the package name may change accordingly.

Or clone the repository:

git clone https://github.com/Damien-Bureau/tree-it.git
cd tree-it

---

🚀 Usage

treeit [path] [options]

Options

Option	Description
path	Root directory to scan (default: current folder)
-o, --output	Output file (default: tree.txt)
-d, --depth	Max depth (0, 1, ..., or full)
-i, --ignore [patterns...]	Ignore rules (see examples below)

---

🎯 Ignore Patterns

Pattern	Meaning
folder/	Completely ignore folder and its content
folder/*	Keep folder in tree, ignore its content
*.ext	Ignore all files with that extension
file.txt	Ignore a specific file

---

✅ Examples

# Show tree up to depth 2, ignoring node_modules entirely
treeit -d 2 --ignore node_modules/

# Ignore all .log files and only the content of frontend/node_modules
treeit --ignore *.log frontend/node_modules/*

---

📄 Output example

my-project/
├── backend/
│   └── node_modules/  (content ignored)
├── frontend/
│   ├── assets/
│   └── App.jsx
├── .gitignore
└── README.md

---

🔒 License

MIT — free to use, modify and share.
Feel free to contribute or suggest improvements!