Generate and audit CLAUDE.md files for AI coding agents
Project description
ClaudeMD Forge
Generate optimized CLAUDE.md files for AI coding agents in seconds.
Stop hand-rolling CLAUDE.md. Let Forge analyze your codebase and generate a production-grade configuration file that makes Claude Code, Cursor, Windsurf, and Codex actually understand your project.
Why?
AI coding agents are only as good as the context you give them. A well-crafted CLAUDE.md is the difference between an agent that writes idiomatic code and one that fights your conventions on every change.
ClaudeMD Forge:
- Scans your codebase to detect languages, frameworks, and patterns
- Generates a complete CLAUDE.md with coding standards, commands, and anti-patterns
- Audits existing CLAUDE.md files and scores them against best practices
- Framework-aware presets for React, FastAPI, Rust, Django, Next.js, and more
Install
pip install claudemd-forge
Quick Start
# Generate a CLAUDE.md for your project
claudemd-forge generate .
# Audit an existing CLAUDE.md
claudemd-forge audit ./CLAUDE.md
# Interactive setup
claudemd-forge init .
# See what would change
claudemd-forge diff .
# List available presets
claudemd-forge presets
# List framework-specific presets
claudemd-forge frameworks
Example Output
Running claudemd-forge generate . on a FastAPI project produces:
# CLAUDE.md — my-api
## Project Overview
my-api — TODO: Add project description.
## Current State
- **Version**: 0.1.0
- **Language**: Python
- **Files**: 47 across 2 languages
- **Lines**: 3,204
## Tech Stack
- **Language**: Python
- **Framework**: fastapi
- **Package Manager**: pip
- **Linters**: ruff
- **Test Frameworks**: pytest
- **CI/CD**: GitHub Actions
## Coding Standards
- **Naming**: snake_case
- **Type Hints**: present
- **Docstrings**: google style
- **Imports**: absolute
## Common Commands
...
## Anti-Patterns (Do NOT Do)
- Do NOT use synchronous database calls in async endpoints
- Do NOT return raw dicts — use Pydantic response models
- Do NOT use `os.path` — use `pathlib.Path` everywhere
...
GitHub Action
Add automated CLAUDE.md auditing to your CI pipeline:
# .github/workflows/claudemd-audit.yml
name: Audit CLAUDE.md
on: [pull_request]
jobs:
audit:
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- uses: actions/checkout@v6
- uses: Arete-Consortium/claudemd-forge@v0.1.0
with:
fail-below: 40 # Minimum passing score (0-100)
comment: true # Post results as PR comment
The action posts a formatted comment on your PR with score, findings, and recommendations.
Free vs Pro
| Feature | Free | Pro ($8/mo) |
|---|---|---|
generate — scan and produce CLAUDE.md |
Yes | Yes |
audit — score existing CLAUDE.md |
Yes | Yes |
| 11 community presets (FastAPI, React, Rust, Django...) | Yes | Yes |
init — interactive guided setup |
- | Yes |
diff — detect drift between CLAUDE.md and codebase |
- | Yes |
| CI integration — GitHub Action auto-audit on PR | - | Yes |
| 6 premium presets (monorepo, data-science, devops...) | - | Yes |
| Team templates (shared org standards) | - | Planned |
Activate Pro:
export CLAUDEMD_FORGE_LICENSE=CMDF-XXXX-XXXX-XXXX
Framework Presets
| Preset | Description |
|---|---|
python-fastapi |
FastAPI + async patterns |
python-cli |
Python CLI with typer/click |
react-typescript |
React + TypeScript + hooks |
nextjs |
Next.js App Router conventions |
django |
Django with ORM patterns |
rust |
Rust with clippy + proper error handling |
go |
Go with standard project layout |
node-express |
Express.js backend |
Audit Scoring
Forge scores your CLAUDE.md on:
- Section coverage — does it have the essentials?
- Accuracy — does it match your actual codebase?
- Specificity — are instructions actionable or vague?
- Anti-patterns — does it prevent common mistakes?
- Freshness — is it up to date?
Development
# Clone and install
git clone https://github.com/Arete-Consortium/claudemd-forge.git
cd claudemd-forge
python3 -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
# Run tests
pytest tests/ -v
# Lint
ruff check src/ tests/
ruff format src/ tests/
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file claudemd_forge-0.2.0.tar.gz.
File metadata
- Download URL: claudemd_forge-0.2.0.tar.gz
- Upload date:
- Size: 93.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d2616749b19a6c9e01195ea923802dd2207fd847e10254a24e1b76b77cd4724a
|
|
| MD5 |
9d0916dd7005fa62cdc47464d9354c32
|
|
| BLAKE2b-256 |
5ad5edc59f131457fcb084caa8a2bfd1c76dfefca48a871a27aa1f8d6899644b
|
Provenance
The following attestation bundles were made for claudemd_forge-0.2.0.tar.gz:
Publisher:
publish.yml on Arete-Consortium/claudemd-forge
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
claudemd_forge-0.2.0.tar.gz -
Subject digest:
d2616749b19a6c9e01195ea923802dd2207fd847e10254a24e1b76b77cd4724a - Sigstore transparency entry: 975666495
- Sigstore integration time:
-
Permalink:
Arete-Consortium/claudemd-forge@ffb52364fec6f7ff8a363f745f9f66c102b791bf -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/Arete-Consortium
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@ffb52364fec6f7ff8a363f745f9f66c102b791bf -
Trigger Event:
release
-
Statement type:
File details
Details for the file claudemd_forge-0.2.0-py3-none-any.whl.
File metadata
- Download URL: claudemd_forge-0.2.0-py3-none-any.whl
- Upload date:
- Size: 49.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
0e426ed725d01ad4465b57b8caf1a1dd21cb8e7c2c0193d81ec4a3d6cf4f9922
|
|
| MD5 |
c495cf35f1a539d65400c6484fa9aeeb
|
|
| BLAKE2b-256 |
e114b476ed86041fe6b7f0ba02ddceeb123fa7f0bf3dc7972f2e9cf91be432f8
|
Provenance
The following attestation bundles were made for claudemd_forge-0.2.0-py3-none-any.whl:
Publisher:
publish.yml on Arete-Consortium/claudemd-forge
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
claudemd_forge-0.2.0-py3-none-any.whl -
Subject digest:
0e426ed725d01ad4465b57b8caf1a1dd21cb8e7c2c0193d81ec4a3d6cf4f9922 - Sigstore transparency entry: 975666501
- Sigstore integration time:
-
Permalink:
Arete-Consortium/claudemd-forge@ffb52364fec6f7ff8a363f745f9f66c102b791bf -
Branch / Tag:
refs/tags/v0.2.0 - Owner: https://github.com/Arete-Consortium
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@ffb52364fec6f7ff8a363f745f9f66c102b791bf -
Trigger Event:
release
-
Statement type: