🌳 abitree
Generate beautiful, icon-rich file trees for your README — instantly.
📁 my-project/
├── 📁 src/
│ ├── 🐍 main.py
│ ├── ⚛️ App.tsx
│ └── 🎨 styles.css
├── 📦 package.json
├── 🐳 Dockerfile
└── 📝 README.md
Installation
macOS (Homebrew) — recommended
brew tap abidit/abitree && brew install abitree
pip (macOS / Linux / Windows)
pip install abitree
Usage
# Current directory
abitree
# Specific path
abitree ./my-project
# Limit depth
abitree -L 2
# Output to file
abitree -o structure.md
# Wrap in markdown code block
abitree --md
# Directories only
abitree --dirs-only
# Ignore extra folders
abitree -i dist,build,.cache
# No icons (plain text)
abitree --no-icons
Options
| Flag | Description |
|---|---|
path |
Directory to scan (default: .) |
-L, --level |
Max depth |
-o, --output |
Write output to file |
-i, --ignore |
Comma-separated ignore list |
--dirs-only |
Show directories only |
--no-icons |
Disable icons |
--no-default-ignore |
Don't ignore .git, node_modules, etc. |
--md |
Wrap output in markdown code block |
Default ignored
.git, __pycache__, .DS_Store, .idea, .vscode, node_modules
Author
Built by Abidit Shrestha
License
MIT
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
abitree-0.1.1.tar.gz
(5.2 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file abitree-0.1.1.tar.gz.
File metadata
- Download URL: abitree-0.1.1.tar.gz
- Upload date:
- Size: 5.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4e90dd7d42ecc452009c7b553d073210e6c7f3e48e87c9984904cae8660578ba
|
|
| MD5 |
8b3cf6f2182580d38c564580c150c574
|
|
| BLAKE2b-256 |
c7e5ab4773116ec51fda84a7a5f55144105096d1b710918d6299b371db59ee4e
|
File details
Details for the file abitree-0.1.1-py3-none-any.whl.
File metadata
- Download URL: abitree-0.1.1-py3-none-any.whl
- Upload date:
- Size: 6.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.9.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f311f3781ee7ccc24a2d8fe86974a9e13a29d1ae7256084df4ebd343add8e16e
|
|
| MD5 |
6c922a13ec737bc9677c123cf4443d5c
|
|
| BLAKE2b-256 |
14e4408548fc8f1c81233064e5abf0ead81c5dcb2ed89b645d828901b0893df6
|