claudegen

Generate smart CLAUDE.md files from your codebase

Stop writing CLAUDE.md by hand. One command analyzes your project and generates intelligent context for Claude Code.

Features

• 🔍 Auto-detect your stack (Node.js, Python, Go, Rust)
• 📁 Map your directory structure
• ⚡ Extract build/test commands
• 🎯 Detect conventions from your code
• ⚠️ Scan for TODO/FIXME gotchas
• 📝 Generate compact, useful CLAUDE.md (50-100 lines)

Quick Start

# Using npx (no install)
npx claudegen

# Or install globally
npm install -g claudegen
claudegen

Usage

# Generate CLAUDE.md in current directory
claudegen

# Specify a project path
claudegen ./my-project

# Output to different file
claudegen --output ./docs/CLAUDE.md

# Print to stdout
claudegen --stdout

# Overwrite existing file
claudegen --force

# Verbose output
claudegen --verbose

Example Output

# my-app

TypeScript Next.js project.

## Stack

- Runtime: Node.js >=18
- Language: TypeScript (strict mode)
- Framework: Next.js
- Testing: Vitest
- Linting: ESLint

## Structure

├── src/
│   ├── app/
│   ├── components/
│   └── lib/
├── tests/
└── scripts/

## Commands

npm run dev               # Start development server
npm run build             # Production build
npm run test              # Run tests
npm run lint              # Lint code

## Configuration

- TypeScript strict mode enabled
- ESLint configured
- Prettier configured

## Gotchas

- Requires `.env` file — see `.env.example`
- Database migrations required — check migrations folder
- Found 5 TODO comments in codebase

Options

| Flag | Description | |------|-------------| | -o, --output <path> | Output file path (default: ./CLAUDE.md) | | --stdout | Print to stdout instead of file | | -f, --force | Overwrite existing CLAUDE.md | | -v, --verbose | Show detailed output | | --no-gotchas | Skip TODO/FIXME scanning | | -h, --help | Show help | | --version | Show version |

Supported Stacks

| Stack | Detection | Commands | Conventions | |-------|-----------|----------|-------------| | Node.js/TypeScript | ✅ | ✅ | ✅ | | Python | ✅ | ⚠️ basic | ❌ | | Go | ✅ | ✅ | ❌ | | Rust | ✅ | ❌ | ❌ |

More stacks coming in v1.0!

Comparison

| Feature | /init | claudegen | |---------|---------|-----------| | Runs anywhere | ❌ Claude session | ✅ Terminal | | Stack-aware | ⚠️ Basic | ✅ Full | | Conventions | ❌ | ✅ | | TODO scanning | ❌ | ✅ | | Customizable | ❌ | ✅ Flags | | Works offline | ❌ | ✅ |

How It Works

1. Detect — Identifies your project type from package.json, pyproject.toml, go.mod, etc.
2. Analyze — Scans directory structure, extracts commands, detects conventions
3. Scan — Finds TODO/FIXME comments, .env files, Docker configs
4. Generate — Creates a compact, well-structured CLAUDE.md

Contributing

Contributions welcome! Please read our contributing guidelines.

# Clone and install
git clone https://github.com/your-username/claudegen
cd claudegen
npm install

# Run in development
npm run dev -- ./test-project

# Run tests
npm test

# Build
npm run build

License

MIT © Your Name

Made for the Claude Code community ❤️