Skip to main content

Smart folder tree CLI with gitignore support

Project description

gettree

Modern tree CLI with ignore support, filtering, and exports



Overview

gettree is a fast CLI to visualize directory structures with:

  • ignore rules
  • filterings
  • sorting
  • multiple export formats

Install

pip install gettree

or

pip install git+https://github.com/ash-kernel/gettree.git

Usage

gettree [path] [options]

Examples

gettree .
gettree . --color --icons --size
gettree . --depth 2
gettree . --filter "\.py$"
gettree . --sort size --size
gettree . --json -o tree.json
gettree . --markdown -o tree.md

Features

  • .gitignore + .gettreeignore
  • regex filtering (--filter)
  • sorting (name | size | type)
  • file size + depth control
  • JSON / CSV / Markdown export
  • stats (files, folders, size, time)
  • watch mode + TUI

Options

Display: --color, -c --icons --size, -s --depth, -d N --fullpath --stats --dirs-only --files-only --hidden

Output: --json --csv --markdown --output, -o FILE --flat --count

Advanced: --filter, -f REGEX --sort TYPE --ignore, -i PATTERN --no-ignore --min-size SIZE --max-size SIZE --watch, -w --tui --no-color


Ignore Rules

Supports: .gitignore .gettreeignore

Example: *.log dist/ temp/


Example Output

src
├── main.py
└── README.md

License

MIT

Author

ash-kernel

MADE WITH ❤️

My other works

SpiceDeck - Your Games, One Launcher.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gettree-1.5.0.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gettree-1.5.0-py3-none-any.whl (7.7 kB view details)

Uploaded Python 3

File details

Details for the file gettree-1.5.0.tar.gz.

File metadata

  • Download URL: gettree-1.5.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for gettree-1.5.0.tar.gz
Algorithm Hash digest
SHA256 f6fd6b03e444d0d8f8250cace7e1d2d07b59dc6f01bf6fd8a6c7a6822942c9f8
MD5 153cf54d13c5ba481ed5983c54eb9502
BLAKE2b-256 68b597e80904f6c46dcce8198ae8e91251e3bde7716bf0535a7244b30fca4dde

See more details on using hashes here.

File details

Details for the file gettree-1.5.0-py3-none-any.whl.

File metadata

  • Download URL: gettree-1.5.0-py3-none-any.whl
  • Upload date:
  • Size: 7.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.13

File hashes

Hashes for gettree-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3012a43f66b2f26a2474bdec28a2a85110182475669b4534563c1efea36f3b5a
MD5 048be455213c4388d2d8e0f4baeb9980
BLAKE2b-256 d2154400c34597dc636b096839c9add90341d03074ac600299ad0db7300b1b23

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page