claudefy

Setup and maintain CLAUDE.md files for your projects with opinionated best practices.

Installation

# Using bunx (no installation required)
bunx claudefy

# Using npx
npx claudefy

# Or install globally
bun add -g claudefy
npm install -g claudefy

Usage

# Create or update CLAUDE.md in the current directory
bunx claudefy

# Add framework-specific guidance (flavors)
bunx claudefy nextjs

# Create CLAUDE.local.md (gitignored) for personal preferences
bunx claudefy --local
bunx claudefy -l

# Combine options
bunx claudefy nextjs --local

Available Flavors

| Flavor | Description | |--------|-------------| | nextjs | Next.js App Router conventions, Server Components, Server Actions, routing patterns |

More flavors coming soon! Contributions welcome.

What it does

1. Fetches the latest CLAUDE.md template from the claudefy repository
2. Creates or updates your project's CLAUDE.md (or CLAUDE.local.md)
3. Adds framework-specific guidance based on selected flavors
4. Preserves any custom content you've added outside the managed section
5. Adds to .gitignore (local mode only)

Managed Section

The template content is wrapped in markers:

<!-- CLAUDEFY:START -->
... template content from GitHub ...
<!-- CLAUDEFY:END -->

You can add your own project-specific content outside these markers, and it will be preserved when you update:

# My Project-Specific Notes

Custom content here is preserved!

<!-- CLAUDEFY:START -->
... auto-managed template ...
<!-- CLAUDEFY:END -->

## More Custom Content

This is also preserved!

Local Mode

Use --local or -l to create CLAUDE.local.md instead:

bunx claudefy --local

This will:

• Create/update CLAUDE.local.md instead of CLAUDE.md
• Automatically add CLAUDE.local.md to your .gitignore

This is useful when you want project-specific Claude instructions that shouldn't be committed to the repository (personal preferences, local paths, etc.).

Options

| Option | Description | |--------|-------------| | nextjs | Add Next.js flavor | | -l, --local | Create/update CLAUDE.local.md (gitignored) | | -h, --help | Show help message |

Contributing Flavors

To add a new flavor:

1. Create a new file in CLAUDE/flavors/<flavor-name>.md
2. Add the flavor name to AVAILABLE_FLAVORS in src/claudefy.ts
3. Submit a PR!

License

MIT