v1.6.0 — Free & Open Source

Is your project ready
for Claude Code?

One command scores your project 0-100 for Claude Code optimization. Smart auto-fix generates framework-aware CLAUDE.md, hooks, and commands. Never overwrites your existing config.

$ npx claudex-setup Copy
No install needed. Node.js 18+. Zero dependencies. 100% local — no data sent.
1,107
Cataloged Entries
954
Tested
63
Audit Checks
18
Stacks

How it works

Three steps to a fully optimized Claude Code project.

1

Audit

Scans your project against 63 best practices. Detects your framework, TypeScript, Docker, and more.

npx claudex-setup
2

Setup

Generates smart CLAUDE.md with Mermaid diagrams, hooks, commands, agents, and rules — all tailored to your stack.

npx claudex-setup setup
3

Watch

Monitors your project live. Re-audits on every change and shows score delta in real time.

npx claudex-setup watch
Before
10
No CLAUDE.md
No hooks or automation
No slash commands
No verification loop
No architecture diagram
No secrets protection
After setup
78
Smart CLAUDE.md with Mermaid
PreToolUse + PostToolUse hooks
/test, /review, /fix, /deploy
Security reviewer agent
Stack-specific rules
XML constraints + verification

See it in action

~/my-project
$ npx claudex-setup

claudex-setup audit
═════════════════════════════════════
Detected: React, TypeScript, Docker

████████████████░░░░ 78/100

✅ Passing
CLAUDE.md project instructions
Mermaid architecture diagram
Hooks (PreToolUse + PostToolUse)
Custom slash commands (5 commands)
XML constraint blocks
Secrets protection configured

🟡 High Impact
CI pipeline configured
→ Add .github/workflows/ for automated testing

⚡ Quick wins
1. Add LICENSE file
2. Add CHANGELOG.md

─────────────────────────────────────
42/63 checks passing
Run npx claudex-setup setup to fix

Seven modes. One tool.

Every way you might want to optimize your Claude Code experience.

🔍 Audit

Score 0-100 against 63 checks. Detects framework, TypeScript, Docker. Shows critical, high, and quick wins.

npx claudex-setup

🛠️ Smart Setup

Generates CLAUDE.md that detects your scripts, creates Mermaid diagrams from your directory structure, adds framework-specific rules.

npx claudex-setup setup

🧙 Interactive Wizard

Step-by-step guided tour through every improvement. Pick what to fix, skip what you don't need.

npx claudex-setup interactive

👁️ Watch Mode

Live monitoring. Re-audits on every config change, shows score delta in real time. Keep it running while you work.

npx claudex-setup watch

🏅 Badge

Generate a shields.io badge for your README. Show the world your Claude Code readiness score.

npx claudex-setup badge

🧠 Deep Review

Claude reads your actual config and gives intelligent, specific feedback. Not pattern matching — real AI analysis. Requires API key.

npx claudex-setup deep-review

🔄 CI Action

GitHub Action that audits every PR. Set a minimum score threshold. Fail the build if standards drop.

uses: DnaFin/claudex-setup@main

Smart CLAUDE.md generation

Not a generic template. Actually analyzes your project.

Detects your scripts

Reads package.json and includes your actual test, build, lint, and dev commands.

Framework-aware

Next.js Server Components, Django models, FastAPI Pydantic, React hooks — each gets specific guidelines.

TypeScript-aware

Detects strict mode, adds TS-specific rules. No @ts-ignore without tracking.

Auto Mermaid diagram

Scans your directories and generates an architecture diagram. More token-efficient than prose (per Anthropic docs).

XML constraint blocks

Adds <constraints> and <verification> blocks with context-aware rules. 30% quality improvement.

Verification criteria

Auto-generates a checklist based on your actual test, lint, and build commands.

63 checks across 13 categories

Every check is backed by tested research from the CLAUDEX catalog.

📋

CLAUDE.md Critical

Project instructions Claude reads every session

Verification Critical

Test/lint commands so Claude checks its own work

🔒

Secrets Protection Critical

Block .env reads, deny rules for sensitive files

Hooks High

PreToolUse + PostToolUse automation

🔷

Mermaid Diagram High

Architecture visualization. More token-efficient than prose

🏷️

XML Tags High

Structured prompts. 30% quality boost

Commands High

Custom /test, /deploy, /review, /fix

🔍

Security Review High

Built-in OWASP Top 10 scanning

🛡️

Agents Medium

Security reviewer, test writer subagents

📐

Rules Medium

Path-specific conventions per file type

🧩

Skills Medium

On-demand domain knowledge

🔌

MCP Servers Medium

Context7, database, and API integrations

Auto-detects your stack

React Vue Angular Next.js Svelte Python Django FastAPI Node.js TypeScript Rust Go Docker Flutter Ruby Java Kotlin Swift

Frequently asked

Is it safe? Does it modify my code?

Audit is read-only — it never touches your files. Setup only creates new files in .claude/ and a CLAUDE.md. It never modifies existing source code. Everything runs locally on your machine — no data is sent anywhere.

How is this different from /init?

Claude Code's /init generates a basic CLAUDE.md. We go much further: 63 audit checks, smart CLAUDE.md with Mermaid diagrams, PreToolUse/PostToolUse hooks, security agents, framework-specific rules, XML constraint blocks, and verification criteria — all backed by research from 1,107 cataloged Claude Code entries.

What's the real impact on productivity?

Based on our research: Mermaid diagrams are more token-efficient than prose descriptions (per Anthropic docs). Hooks enforce rules at 100% (vs ~80% for CLAUDE.md instructions alone). Verification loops are Anthropic's #1 recommended best practice. The impact depends on your project and workflow.

Does it work with Cursor, Codex, or other AI tools?

The audit is Claude Code-specific. However, CLAUDE.md files are recognized by many AI coding tools. The skills format was adopted as a cross-platform standard by OpenAI Codex CLI in December 2025. Hooks and agents are Claude Code-only features.

Where do the 1,107 techniques come from?

From a systematic research project covering all 73 official Claude Code documentation pages, 100+ community tools and MCP servers verified via GitHub API, Anthropic blog posts, benchmark papers, and hands-on experiments. The count includes features, techniques, patterns, tools, stats, and limitations — not all are actionable. 954 were verified with real evidence. The research is ongoing.

My project already has a good CLAUDE.md. Will this help?

Audit will still show you what else you might be missing (hooks, agents, rules, MCP config). Setup will never overwrite your existing files — it only creates what's missing. If your project is already well-configured, the tool will tell you. A hand-crafted CLAUDE.md that reflects your real conventions will always be better than a generated one.

MIT Licensed
Zero dependencies
Runs 100% locally
No data sent anywhere

Find out what you're missing.
Fix it in 10 seconds.

63 checks. Read-only audit. Never overwrites your existing setup. If you already have a good config, it'll tell you.

$ npx claudex-setup Copy