filetree-cli 0.1.0

Generate ASCII or Markdown directory trees with smart filtering

filetree

Generate ASCII or Markdown directory trees with smart filtering.

Installation

pip install filetree-cli

Usage

# Basic usage - current directory
filetree

# Specific path with depth limit
filetree ~/projects -d 2

# Markdown output for documentation
filetree . --md

# Ignore additional patterns
filetree . -I "*.log" -I "tmp"

# Show only directories
filetree . -D

# Show hidden files with sizes and stats
filetree . -a --size --stats

# JSON output for programmatic use
filetree . --json

Features

• Smart defaults: Ignores common cruft (.git, node_modules, pycache, etc.)
• Depth limiting: Control how deep the tree goes
• Pattern ignoring: Glob patterns to exclude files/directories
• Multiple formats: ASCII (default), Markdown, or JSON
• Size display: Optional file size annotations
• Statistics: File/directory counts and total size
• Hidden files: Toggle visibility of dotfiles

Default Ignored Patterns

These patterns are ignored by default (use --no-default-ignore to include them):

• .git, .svn, .hg
• __pycache__, *.pyc
• node_modules
• .venv, venv, .env
• *.egg-info, .pytest_cache, .mypy_cache
• dist, build
• .idea, .vscode
• .DS_Store

Examples

Basic Tree

$ filetree
myproject/
├── README.md
├── pyproject.toml
└── src/
    ├── __init__.py
    └── main.py

Markdown Output

$ filetree --md

myproject/
├── README.md
├── pyproject.toml
└── src/
    ├── __init__.py
    └── main.py

With Stats

$ filetree --stats --size
myproject/
├── README.md (1.2KB)
├── pyproject.toml (856B)
└── src/
    ├── __init__.py (45B)
    └── main.py (2.3KB)

1 directories, 4 files
Total size: 4.4KB

JSON Output

$ filetree --json
{
  "root": "/path/to/myproject",
  "tree": [
    "myproject/",
    "├── README.md",
    "├── pyproject.toml",
    "└── src/",
    "    ├── __init__.py",
    "    └── main.py"
  ],
  "stats": {
    "directories": 1,
    "files": 4,
    "total_size": 4501,
    "total_size_human": "4.4KB"
  }
}

Options

Option	Description
-d, --depth N	Maximum depth (-1 for unlimited)
-I, --ignore PATTERN	Patterns to ignore (repeatable)
--no-default-ignore	Don't use default ignore patterns
-a, --all	Show hidden files/directories
-D, --dirs-only	Show only directories
-s, --size	Show file sizes
--stats	Show summary statistics
--md, --markdown	Output as markdown code block
--json	Output as JSON
--version	Show version

For AI Agents

See SKILL.md for agent-optimized documentation.

License

MIT