Skip to content

Hello Data Points 👋

Desorption

A small, fast CLI to display styled file/folder trees — perfect for documenting project structure, exporting to Markdown, or quickly inspecting repos.

Show File Tree Downloads PyPI License: MIT Python versions GitHub Issues GitHub pull requests Repo Size Fast & Lightweight Made with 💜 Python Contributions Welcome

Install

1
2
# From PyPI
pip install show-file-tree

1
2
# From UV
uv pip install show-file-tree
From Source
1
2
3
4
5
# From source (dev)
git clone https://github.com/Rudra-G-23/show-file-tree.git

cd show-file-tree
python -m venv .venv
Windows PowerShell
1
2
.venv\Scripts\Activate.ps1
pip install -e ".[all]"

Basic

Command Line Interface of show-file-tree

1
2
# This is the first message you’ll see if you encounter any errors.
show-file-tree [OPTIONS] [ROOT_PATH] COMMAND [ARGS]...

[OPTIONS]:  TThe specific command or action to perform, e.g., `--count` or `--size`.

[ROOT_PATH]: The root directory to start the file tree from. Default is current directory (.)

File Path

File path miss Match

show-file-tree [ROOT_PATH] COMMAND

Incorrect File Path Examples

# Why Incorrect ✖️: Dot is default path,so no need to use
show-file-tree . --size

# Why Incorrect ✖️: First Path used 
show-file-tree "C:\Users\Rudra\Desktop\MLOPs" --count

# Why Incorrect ✖️: First Path used 
show-file-tree "C:\Users\Rudra\Desktop\MLOPs"  --format md

File path Match

 show-file-tree COMMAND [ROOT_PATH]

Correct File Path Examples

# Why Correct ✔️: Directly used the command 
show-file-tree  --size 

# Why Correct ✔️: First command -> Path
show-file-tree --count "C:\Users\Rudra\Desktop\MLOPs" 

Why Correct ✔️: First command -> Path 
show-file-tree  --format md "C:\Users\Rudra\Desktop\MLOPs"

Error Handing

When a typo error occurs

Error

Usage: show-file-tree [OPTIONS] [ROOT_PATH] COMMAND [ARGS]...
Try 'show-file-tree --help' for help.
╭─ Error ──────────────────────────────────────────────────────────────────────────╮
│ Invalid value for '[ROOT_PATH]': Directory 'count' does not exist.               │
╰──────────────────────────────────────────────────────────────────────────────────╯

Used --help command

show-file-tree --help

Examples

1. Exported in Markdown format
show-file-tree --format md [ROOT_PATH]
2. Limit depth and show sizes & counts
show-file-tree  -d 2 --size --count

Why use show-file-tree?

  • Fast, memory-safe traversal — suitable for large directories.
  • Pretty terminal output — icons, counts, human-readable sizes.
  • Powerful filtering — globs, mtime/ctime windows.
  • Markdown export — create readable project documentation automatically.
  • Themes & ASCII fallback — works in CI or minimal terminals.
  • and many more .....