folder-md

A CLI tool to generate folder tree structure as ASCII art in a new file FOLDER.md.

Quick Start 🚀

No installation required! Just run:

npx folder-md

💡 You can also use npx tree-folder as an alias.

Installation (Optional)

npm install -g folder-md

Then use:

folder-md

Usage

# Generate folder tree in current directory
npx folder-md

# Generate folder tree with all files included
npx folder-md -f

# Generate folder tree and log to console (with colors!)
npx folder-md -log

# Generate folder tree for a specific path
npx folder-md /path/to/directory

# Combine options
npx folder-md -f -log

# Ignore custom patterns
npx folder-md --ignore ".cache" --ignore "tmp"

Options

• -f, --files: Include all files in the tree (default: only shows README.md, package.json, LICENSE, tsconfig.json, .gitignore)
• -log, --log: Print the tree structure to console in addition to saving to file (with colored output!)
• --ignore <pattern>: Add custom ignore patterns (in addition to default ignores)

Colored Output 🎨

When using -log option, the output is colorized in the terminal:

• 📁 Folders: Bold Blue
• 📄 .ts/.tsx files: Cyan
• 📄 .js/.jsx files: Yellow
• 📄 .json files: Green
• 📄 .md files: Magenta
• 📄 Config files (.gitignore, etc): Gray

Default Ignored Folders

The following folders are ignored by default:

• node_modules
• .git
• dist
• build
• venv
• __pycache__
• .next
• .nuxt
• coverage
• .vscode
• .idea

Output

The tool generates a FOLDER.md file in the target directory with the folder structure in ASCII tree format.

Example output:

my-project/
├─ src/
│  ├─ index.ts
│  └─ utils.ts
├─ package.json
└─ README.md

License

ISC