treex
List directory contents in a tree format with file metadata.
- Copyright (c) 2026 Corey Goldberg
- Development: GitHub
- Releases: PyPI
- License: MIT
About
treex is a command-line utility (similar to tree) that recursively
scans a directory and prints its contents as a tree using Unicode box-drawing
characters. File names include their human-readable size and, optionally,
modification time. Text files also include their line count, while binary and
unreadable files are marked with their type. When Git is installed, it respects
.gitignore rules.
Requirements:
- Python 3.10+
- Git 2.0+ (optional)
- UTF-8-compatible terminal
Status
| Latest Version |
|
| Tests (CI) |
|
| Supported Python Versions |
|
Installation
Install treex from PyPI using either pip or pipx:
pip install treex-clipipx install treex-cli
Usage
$ treex --help
usage: treex [-h] [-a] [-m] [-s] [-w N] [directory]
List directory contents in a tree format with file metadata.
positional arguments:
directory directory to scan (default: current directory)
options:
-h, --help show this help message and exit
-a, --all show all files (including those ignored by Git)
-m, --modified show file modification times
-s, --summary show summary only
-w, --width N starting column for file metadata (default: 50)
Screenshot
Release files for treex-cli 0.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| treex_cli-0.1.1.tar.gz | 5.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| treex_cli-0.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.2 kB
Release files / treex_cli-0.1.1.tar.gz
| Download URL | treex_cli-0.1.1.tar.gz |
|---|---|
| Size | 5.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
07a1e27ab9dd1f6379a67fba16bc6e28f21a8eb7f3ff847650f43efbf791b4b2
|
|
BLAKE2b-256 checksum How to use checksums |
5e3c626d6e127569409699e3d04941cbe347bc89fb6dfceebbd431481c3e31e6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|
Release files / treex_cli-0.1.1-py3-none-any.whl
| Download URL | treex_cli-0.1.1-py3-none-any.whl |
|---|---|
| Size | 6.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a9fb652a17c4387cb8b415950d20f1327ef262eef977fad11063f29806b9c910
|
|
BLAKE2b-256 checksum How to use checksums |
a8e2a5130642fbb12a4ca36d00f143ac8eff7028a58f51bc92631c3ae6340981
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.14.7
|