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.2

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.2
File Size Uploaded
treex_cli-0.1.2.tar.gz 5.8 kB Details

Built distribution (wheel)

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

Total release size: 11.8 kB

Release files / treex_cli-0.1.2.tar.gz

Download URL treex_cli-0.1.2.tar.gz
Size 5.8 kB
Tags Source
SHA-256 checksum
How to use checksums
46594f44c3052ccc86b643bf8d597d9ddff779c83124304b28145e4ff58457d4
BLAKE2b-256 checksum
How to use checksums
b8d6166a3dd7aa85b01331ad6bebbddd71623e8fee76d9dc90ad35d932992cc8
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.2-py3-none-any.whl

Download URL treex_cli-0.1.2-py3-none-any.whl
Size 6.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0aaa8aa85a9f461117a802b82cd22bdc412d62906c9e717e1167e527e30d921d
BLAKE2b-256 checksum
How to use checksums
89e0b2f3084dfcfcf2f23d32b522cbf894bdecc1ec015106ce17ac126f7e9224
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

0.1.3

2 release files

This release

0.1.2 This release

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