Arborix

A beautifully structured CLI tree viewer with export capabilities

Overview

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.

Key Features

• 📁 Unicode icons for different file types
• 📄 Export to .txt, .json, and .html (with embedded CSS)
• 🧠 Sorting by name, size, or date
• 🫥 Toggle hidden files
• 🌈 Colored terminal output
• 🔍 Depth limitation for focused navigation
• 📊 Directory statistics on demand

Installation

Choose from the following methods:

From GitHub

pip install git+https://github.com/mallikmusaddiq1/arborix.git
cd arborix
pip install .

From PyPI

pip install arborix

Usage

Launch Arborix from your terminal:

arborix [path] [options]

Command-line 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 information

Example Commands

Generate 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

File Type Icons

Author

Mallik Mohammed Musaddiq

GitHub: @mallikmusaddiq1

Email: mallikmusaddiq1@gmail.com

License

This project is licensed under the MIT License. Refer to the LICENSE file for full details.