A beautifully structured CLI tree viewer with export capabilities
Arborix is a minimalist, yet feature-rich command-line utility that renders directory trees in a clean and human-readable format. It leverages UTF-8 icons to intuitively represent various file types and offers multi-format export options for versatile use cases.
.txt, .json, and .html (with embedded CSS)Choose from the following methods:
pip install git+https://github.com/mallikmusaddiq1/arborix.git
cd arborix
pip install .
pip install arborix
Launch Arborix from your terminal:
arborix [path] [options]
-d, --depth <int>: Set tree depth limit (e.g., --depth 3)--txt <file>: Export tree view to .txt--json <file>: Export tree structure to .json--html <file>: Export to .html with embedded styles--sort <name|size|date>: Sort directory entries (default: name)-H, --hidden: Include hidden files and folders--no-icons: Disable Unicode icons--color: Enable ANSI-colored output--stats: Display summary of files and directories-v, --version: Show tool version and author informationGenerate a basic tree with stats and export:
arborix . --depth 2 --txt output.txt --stats
Export to JSON with colored output and hidden files:
arborix . --json structure.json --color --hidden
Generate icon-free HTML output for a directory:
arborix /path/to/dir --html index.html --no-icons
Display version and credits:
arborix --version
| Icon | Category | File Types |
|---|---|---|
| 📁 | Folder | Directories |
| 📸 | Image | jpg, png, svg, psd |
| 🎵 | Audio | mp3, wav, flac, ogg |
| 🎬 | Video | mp4, mkv, avi, mov |
| 📄 | Text & Code | txt, py, java, html |
| 🗜️ | Archive | zip, rar, tar, 7z |
| ⚙️ | Executable | exe, bin, jar, sh |
| 🔤 | Font | ttf, otf, woff, woff2 |
| 🗄️ | Database | sql, sqlite, db |
| 📊 | Presentation | ppt, pptx, odp |
| 📈 | Spreadsheet | xls, xlsx, ods |
| 📖 | PDF & E-books | pdf, epub, mobi |
| 📐 | CAD & 3D Models | dwg, stl, obj |
| 📦 | Miscellaneous | torrent, tmp, cfg |
| 💾 | Virtual Machines | vmdk, vmx, vdi |
| 🎮 | Game Files | rom, nes, gba |
| 🔬 | Scientific Data | hdf, npy, pdb |
| ✍️ | Markup & Docs | md, tex, adoc |
| 📦 | Other | Unrecognized extensions |
Mallik Mohammed Musaddiq
GitHub: @mallikmusaddiq1
Email: mallikmusaddiq1@gmail.com
This project is licensed under the MIT License. Refer to the LICENSE file for full details.
FAQs
A beautifully structured CLI tree viewer with exports
We found that arborix demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
npm now supports Trusted Publishing with OIDC, enabling secure package publishing directly from CI/CD workflows without relying on long-lived tokens.
Research
/Security News
A RubyGems malware campaign used 60 malicious packages posing as automation tools to steal credentials from social media and marketing tool users.
Security News
The CNA Scorecard ranks CVE issuers by data completeness, revealing major gaps in patch info and software identifiers across thousands of vulnerabilities.