TreeMark is a lightweight Python CLI tool that generates a clean, readable Markdown (or plain text) representation of your project’s directory structure. Perfect for documentation, code walkthroughs, and feeding structured project info to LLMs.

• 📁 Recursively walks through your folder structure
• 📝 Outputs a Markdown tree that works in GitHub, Notion, etc.
• 🧾 Option to output in plain text instead of Markdown
• 📏 Limit directory depth with --max-depth
• 📦 Show file sizes with --sizes
• 💾 Save output to a file with --output
• 🎯 Supports ignoring files/folders
• 🎯 Supports selecting only certain top-level items
• ✅ No external dependencies, pure Python!

Clone the repository:

git clone https://github.com/avirsaha/treemark.git
cd treemark
pip install .

Or install in editable mode (for development):

pip install -e .

treemark

This generates a Markdown tree of the current directory.

treemark --root myproject --ignore __pycache__ venv .git --max-depth 2 --sizes --output structure.md

Output (Markdown):

# Project Structure

├── README.md (1.2 KB)
├── requirements.txt (57 B)
└── src/
    ├── main.py (2.1 KB)
    └── utils.py (800 B)

• Project READMEs
• Codebase onboarding docs
• Prompting LLMs with structural context
• Static documentation sites

pytest

Tests are located in the tests/ directory.

To remove build artifacts before packaging or publishing:

Windows:

Remove-Item -Recurse -Force build, dist, *.egg-info

macOS/Linux:

rm -rf build dist *.egg-info

• PermissionError: TreeMark now skips inaccessible directories (e.g., System Volume Information on Windows).
• Output formatting issues? Make sure you’re viewing the result in a Markdown-capable viewer like GitHub or VSCode.

We welcome PRs and suggestions!

1. Fork the repo
2. Create a feature branch
3. Make your changes
4. Write or update tests
5. Submit a pull request 🚀

MIT License © 2025 Aviraj Saha

• tree — Classic CLI directory viewer
• py-tree — CLI tree views, not markdown-focused

• Add output to file support
• Add folder depth limit
• Add format options (Markdown vs plain text)
• Show file sizes
• Add color themes (for terminal output)
• Add Git integration (e.g., show tracked/untracked)

• GitHub: @avirsaha
• Issues or feature requests? Submit here
• Email: [email protected]