automarkdown

Convert any codebase into LLM-ready markdown.

npx automarkdown .

Why

Large language models understand markdown better than raw code directories. AutoMarkdown converts your entire codebase into a single, well structured markdown file that AI can analyze, review, and understand completely.

What you get

• Token analysis for all major LLMs (GPT, Claude, Gemini)
• Smart filtering removes lock files, binaries, generated content
• Zero setup works instantly with any project
• Auto-organization creates clean folder structure

Install

# No installation needed
npx automarkdown .

# Or install globally
npm install -g automarkdown

Use

# Convert current directory
npx automarkdown .

# Custom output
npx automarkdown . -o docs.md

# JSON format
npx automarkdown . -f json

# Enable verbose logging
npx automarkdown . -v

# Custom ignore patterns
npx automarkdown . --exclude "tests/**,*.spec.ts"

# Include hidden files
npx automarkdown . --include-hidden

Configuration

Ignore Files

AutoMarkdown supports two types of ignore files:

1. .gitignore - Uses your existing Git ignore patterns
2. .automarkdownignore - Specific patterns for AutoMarkdown

Create a .automarkdownignore file in your project root to exclude files from processing:

# Dependencies
node_modules/
__pycache__/

# Build outputs
dist/
build/

# Lock files
package-lock.json
yarn.lock

# IDE files
.vscode/
.idea/

Output

Token Analysis:
   Estimated tokens: 11,782

Compatible LLMs (11):
   • Gemini 2.5 Pro - 1% of limit
   • GPT-5 - 3% of limit
   • Claude Opus 4.1 - 6% of limit

Recommendations:
   Good compatibility with most popular LLMs!

Perfect for AI code reviews, documentation, and legacy analysis.

---

GitHub • NPM

Made with 💜 by harsh