pyletree 1.0.0

Generate directory tree diagrams from the command line

Pyletree

Pyletree is a simple and fast CLI tool to generate directory tree diagrams.

Installation

pip install pyletree

Usage

pyletree [ROOT_DIR]

If no directory is provided, the current directory is used:

pyletree

Show help:

pyletree -h

Options

General

• -h, --help Show help message
• -v, --version Show version

Modes

• -d, --dir-only Show directories only
• -f, --files-only Show files only

Ordering

• -df, --dirs-first List directories before files
• -ff, --files-first List files before directories

Alphabetical order is always applied as base sorting.

Display

• -n, --no-pipes Remove vertical pipes between branches

Ignoring

• -i, --ignore PATTERN [PATTERN ...] Ignore files/directories
• -gi, --gitignore Respect .gitignore rules

Depth

• -dl, --depth-level N Limit depth

Output

• -o, --output-file FILE Save output to file (Markdown format)

Examples

Basic:

pyletree

Directories first:

pyletree . -df

Files only:

pyletree . -f

Limit depth:

pyletree . -dl 2

Ignore entries:

pyletree . -i node_modules dist .git

Use .gitignore:

pyletree . -gi

No pipes mode:

pyletree . -n

Save to file:

pyletree . -o tree.md

Sample Output

Default

project/
│
├── src/
│   ├── main.py
│   └── utils.py
│
├── tests/
│   └── test_main.py
│
└── README.md

No pipes (-n)

project/
├── src/
│   ├── main.py
│   └── utils.py
├── tests/
│   └── test_main.py
└── README.md

Features

• Clean and readable tree output
• .gitignore support (it does not ignore either the .git directory or the .gitignore file; if you want to ignore them, add them to the ignore patterns)
• Custom ignore patterns
• Depth limiting
• Flexible sorting
• Optional compact mode (--no-pipes)

Release History

1.0.0

• Initial release

Authors

Davi Reis Furtado

Original RP Tree Author: Leodanis Pozo Ramos

License

Pyletree is distributed under the MIT license. See LICENSE for more information.