A simple CLI tool written in Go that generates Markdown-formatted tree structures of any directory. Perfect for creating README documentation that shows your project structure.
Technologies
GoCLIMarkdownTree StructureBox Drawing CharactersFile SystemMakefileDocumentation
Terminal Preview
project-tree-md — Tree Generator
$ project-tree-md --depth 3 ./my-project
my-project/
├── cmd/
│ └── root.go
├── internal/
│ ├── config/
│ │ └── config.go
│ ├── scanner/
│ │ ├── filter.go
│ │ └── walker.go
│ └── renderer/
│ ├── markdown.go
│ └── tree.go
├── testdata/
│ ├── sample-project/
│ └── expected-output.md
├── .gitignore
├── go.mod
├── go.sum
├── Makefile
└── README.md
6 directories, 12 files
✓ Output copied to clipboard
✓ Written to TREE.md
Overview
Overview
Project Tree MD is a command-line tool that generates clean, Markdown-formatted tree structures of any directory.
It’s designed specifically for developers who want to include project structure documentation in their README files.
The tool supports comprehensive filtering options including gitignore patterns, custom ignore lists, and file extension filtering.
Features
Features
Core Features
- Markdown-formatted tree output with box-drawing characters
- Gitignore-aware filtering
- Custom ignore patterns and file extension filters
- Configurable depth limits
- Copy-paste ready output for README files
Filtering System
- Default ignores (node_modules, .git, etc.)
- Gitignore pattern support
- Custom additional ignore patterns
- File extension include/exclude filters
- Directory-only mode
- Hidden file handling