treemd

Open a markdown file in interactive TUI mode

$ treemd [path/to/file.md]

$ treemd [[-l|--list]] [path/to/file.md]

$ treemd --tree [path/to/file.md]

$ treemd [[-s|--section]] [heading_name] [path/to/file.md]

$ treemd [[-l|--list]] --filter [pattern] [path/to/file.md]

$ treemd [[-q|--query]] '[.h2 | text]' [path/to/file.md]

treemd [OPTIONS] [DIR]

-h, --help
    Show help message and exit.

-V, --version
    Display program version.

-f, --file FILE
    Output to file (default: tree.md)

-i, --indent INT
    Set indent size (default: 2)

-d, --dirsfirst
    List directories before files.

-D, --maxdepth INT
    Limit maximum depth (default: unlimited)

--gitignore
    Respect .gitignore patterns.

--gitattributes
    Respect .gitattributes patterns.

-I, --ignore PATTERN
    Ignore matching files/dirs (repeatable).

-E, --exclude PATTERN
    Exclude matching files/dirs (repeatable).

treemd is a command-line utility that scans a directory and produces a visually appealing tree structure output in Markdown format. Ideal for GitHub README files, project documentation, or any scenario needing a quick overview of folder hierarchies.

It supports customization like ignoring common directories (e.g., node_modules, .git), limiting depth, and respecting .gitignore files. The output is hierarchical with Unicode box-drawing characters, branches, and proper indentation, rendering beautifully in Markdown viewers.

Unlike the standard tree command, treemd focuses on Markdown export, making it perfect for static site generators, wikis, or code repos. Install via pip (pip install treemd) or cargo for Rust versions. Usage is straightforward, outputting to stdout or a file like tree.md.

Not a standard Linux utility; requires installation (e.g., pip install treemd). Output uses Unicode, may not render in all terminals. Relative paths in output.

treemd . -f README.md --gitignore
Generates tree.md in current dir, ignoring git files.

Python: pip install treemd
Rust: cargo install treemd

Developed by newAM as a Python CLI tool (GitHub: newAM/treemd, ~2019). Inspired by tree command. Available on PyPI; Rust ports exist for performance.

tree(1), ls(1), find(1)