Skip to main content

treex

List directory contents as a tree with file metadata


About

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

  • File names show human-readable sizes
  • Text files show line counts
  • Binary and unreadable files show their type
  • Modification timestamps are optional
  • 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] [-s] [directory]

List directory contents as a tree 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

Screenshot

Screenshot

Release files for treex-cli 0.1.3

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.3
File Size Uploaded
treex_cli-0.1.3.tar.gz 5.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for treex-cli 0.1.3
File Interpreter ABI Platform
treex_cli-0.1.3-py3-none-any.whl Python 3 none any Details

Total release size: 11.9 kB

Release files / treex_cli-0.1.3.tar.gz

Download URL treex_cli-0.1.3.tar.gz
Size 5.9 kB
Tags Source
SHA-256 checksum
How to use checksums
2576d67b827b1b41a30d0ca47540b4f5c3f68d0ce3b8eac62e3d703ba4535bba
BLAKE2b-256 checksum
How to use checksums
7bc14e67defe8a61a033a58220e2bc7cf5b6d5cadb7e05c89fe85a6e9cc70162
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.3-py3-none-any.whl

Download URL treex_cli-0.1.3-py3-none-any.whl
Size 6.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
75c4f7d81789ad4fa000e9983d10ec35d62658c889488060b46b0cd558c1b983
BLAKE2b-256 checksum
How to use checksums
129ef9e1b37af1ae87945ec47bfe5163fb7a3d9c46b393683208858caf51a666
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release history Release notifications | RSS feed

0.1.4

2 release files

This release

0.1.3 This release

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page