🌳 repo-tree

A zero-config, lightning-fast CLI tool that generates clean, markdown-ready directory structures.

Built for developers who need to quickly document their code, share project context with AI (like ChatGPT or Claude), or drop folder structures into GitHub PRs.

⚡ Quick Start (No Installation Required)

You don't need to install anything. As long as you have Node.js installed, you can run this tool instantly inside any project folder using npx:

npx repo-tree

📸 Demo: What it looks like

Command:

npx repo-tree

Output:

├── src/
│   ├── cli.js
│   ├── formatter.js
│   └── treeGenerator.js
├── package.json
└── README.md

(Want folder and file icons? Just run npx repo-tree --emoji)

🪄 The Magic --update-readme Command

Tired of manually copying and pasting folder structures into your documentation? Let repo-tree do it for you.

Step 1: Add a standard heading anywhere in your README.md file (e.g., ## Project Structure or ## 📁 Folder Structure).

Step 2: Run this command:

npx repo-tree --update-readme

Result: The tool will automatically find that heading and safely inject the fresh folder tree directly below it. If you run it again tomorrow, it will flawlessly overwrite the old tree without touching the rest of your README!

🛠️ Useful Commands & Flags

Need to customize the output? Just add these flags to your npx command:

| Command | What it does | |---|---| | npx repo-tree --copy | Silently copies the markdown-formatted tree directly to your clipboard. | | npx repo-tree --output=tree.md | Saves the markdown-formatted tree to a specific file. | | npx repo-tree --emoji | Adds folder and file icons (📁, 📄) to the output. | | npx repo-tree --folders-only | Hides all files and only prints the directory architecture. | | npx repo-tree --all-files | Forces the tool to show every file, bypassing smart defaults. | | npx repo-tree --depth=2 | Limits how many folders deep the recursion goes. | | npx repo-tree --ignore=logs,tmp | Comma-separated list of extra files/folders to ignore. |

⚙️ Optional: Configuration File

If you find yourself using the same flags over and over, you can create a .repo-tree.json file in the root of your project to set your defaults.

{
  "mode": "default",
  "depth": 3,
  "emoji": false,
  "showFiles": true,
  "ignore": ["logs", "tmp"]
}

(Note: Any CLI flags you type will always override this config file).