treex

List directory contents as a tree with file and directory metadata

Copyright (c) 2026 Corey Goldberg
Development: GitHub
Releases: PyPI
License: MIT

About

treex is a command-line utility that recursively scans a directory and lists its contents as a tree along with file and directory metadata.

Shows human-readable file sizes
Shows recursive directory sizes
Shows line counts for text files
Identifies binary and unreadable files by type
Optionally shows modification timestamps
Respects .gitignore rules when Git is installed

Status

Latest Version
Tests (CI)
Supported Python Versions

Requirements

Python 3.10+
Git 2.0+ (optional)
UTF-8-compatible terminal

Installation

Install treex from PyPI using either pip or pipx:

pip install treex-cli
pipx install treex-cli

Usage

$ treex --help
usage: treex [-h] [-a] [-m] [-q] [-s] [directory]

List directory contents as a tree with file and directory 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
  -q, --quiet     don't show file metadata
  -s, --summary   show summary only

Screenshot

Metadata

Release files for treex-cli 0.1.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for treex-cli 0.1.7
File	Size	Uploaded
treex_cli-0.1.7.tar.gz	6.2 kB	Sep 24, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for treex-cli 0.1.7
File	Interpreter	ABI	Platform	Reset
treex_cli-0.1.7-py3-none-any.whl 6.3 kB Sep 24, 2026	Python 3	none	any	Details

Total release size: 12.5 kB

Release files / treex_cli-0.1.7.tar.gz

Download URL	treex_cli-0.1.7.tar.gz
Size	6.2 kB
Tags	Source
SHA-256 checksum How to use checksums	`f1e746f700e3e7e7d20f578beaff7738db4d763d23e26885b4a9954db5803b20`
BLAKE2b-256 checksum How to use checksums	`562be1517ac0624c2640ed3ebae5b9366aa451e3bcd0f2e8ac03dade5678ebb5`
Upload date	Sep 24, 2026
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.7-py3-none-any.whl

Download URL	treex_cli-0.1.7-py3-none-any.whl
Size	6.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`e12dc915f0520f798ff1905520454037290095a3a1dfaba70a7d5ef2aea0167f`
BLAKE2b-256 checksum How to use checksums	`9d3c223dde078aef3988e3fab794fc03377679c0cbbb8a781e7d0d683fc10657`
Upload date	Sep 24, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.14.7`