CLAUDE.md examples from real projects

How real projects brief Claude Code: the commands, conventions and warnings they put in CLAUDE.md.

Best matches · from page 14Worked for most · soon

Open-Source-LegalCLAUDE.md

OpenContracts

Open-Source-Legal/OpenContracts/CLAUDE.md

working with code in this repository. ## Project Overview OpenContracts is an MIT-licensed enterprise document analytics platform for PDFs and text-based formats. It features a Django/GraphQL backend with PostgreSQL

1.5k12mo agoDiscuss

umputunCLAUDE.md

ralphex

umputun/ralphex/CLAUDE.md

ralphex Autonomous plan execution with Claude Code - Go rewrite of ralph.py. ## LLM Documentation See @llms.txt for usage instructions and Claude Code integration commands. ## Build Commands ```bash make build # build binary

1.5k42d agoReads credentialsDiscuss

yigitkonurCLAUDE.md

cli-continues

yigitkonur/cli-continues/CLAUDE.md

reasoning), and injects it into a different tool as a structured markdown handoff document. ## Build & Development Commands ```bash pnpm install # Install dependencies pnpm run build # TypeScript compile (tsc) → dist/ pnpm

1.5k6mo agoDiscuss

ghostwrightCLAUDE.md

phantom

ghostwright/phantom/CLAUDE.md

install script for Ubuntu/Debian docker-entrypoint.sh # Docker bootstrap (wait for deps, model pull, init) docs/ # Documentation (architecture, channels, mcp, security, etc.) ``` ## Architecture Overview Message flow: Slack message -> SlackChannel adapter -> ChannelRouter -> SessionManager

1.5k6mo agoReads credentialsDiscuss

daymadeCLAUDE.md

claude-code-skills

daymade/claude-code-skills/CLAUDE.md

required) # Core skill instructions with YAML frontmatter ├── scripts/ (optional) # Executable Python/Bash scripts ├── references/ (optional) # Documentation loaded as needed └── assets/ (optional) # Update-owned templates and resources for output ``` ### Progressive Disclosure Pattern

1.4k6mo agoPipes a download into a shellDiscuss

yohey-wCLAUDE.md

multi-agent-shogun

yohey-w/multi-agent-shogun/CLAUDE.md

Claude Code + tmux multi-agent parallel dev platform with sengoku military hierarchy

1.4k4mo agoPipes a download into a shellDiscuss

CloudAI-XCLAUDE.md

claude-workflow-v2

CloudAI-X/claude-workflow-v2/CLAUDE.md

Claude Code Development Guidelines > Team-maintained workflow document. Update frequently with new learnings. ## Quick Reference - **Plugin validation**: `claude plugin validate` - **Test locally**: `claude --plugin-dir ./` - **Formatting**: Prettier for MD/JSON, Black

1.4k9mo agoDiscuss

nrslibCLAUDE.md

takt

nrslib/takt/CLAUDE.md

/code) when working with code in this repository. > **This file is not user-facing documentation.** It exists for Claude Code to read while working in the repository — it does

1.4k16d agoReads credentialsDiscuss

m0n0x41dCLAUDE.md

haft

m0n0x41d/haft/CLAUDE.md

related labels are Haft local-practice carriers, not FPF Core kinds by label alone. Documents and graph nodes do not act. Name the acting system, role, method, work, and evidence

1.4k51d agoDiscuss

peterkrueckCLAUDE.md

Claude-Code-Development-Kit / templates

peterkrueck/Claude-Code-Development-Kit/templates/CLAUDE.md

/deploy` for deployments. - **Context7 first**: When working with external libraries, check Context7 for current documentation before relying on training data. ## 2. Operator Model ## 3. Key Architecture Decisions ## 4. Tool Usage

1.4k4mo agoDiscuss

elirantutiaCLAUDE.md

vibeyard

elirantutia/vibeyard/CLAUDE.md

never complete. (3) **Every field name in `INSPECTOR_FIELDS` (`claude-cli.ts`) must exist in a documented per-event schema, and be read by something.** A compile-time assertion against `keyof InspectorEvent

1.4k4mo agoReads credentialsDiscuss

mbaileyCLAUDE.md

voicemode

mbailey/voicemode/CLAUDE.md

Release workflow (bumps version, tags, pushes) — see "Releases & Changelog" below before running make release ``` ### Documentation ```bash # Serve docs locally at http://localhost:8000 make docs-serve # Build documentation site make

1.4k3mo agoReads credentialsDiscuss

miscusi-peekCLAUDE.md

cheatengine-mcp-bridge

miscusi-peek/cheatengine-mcp-bridge/CLAUDE.md

enabled, memory scans on DBVM-protected pages trigger `CLOCK_WATCHDOG_TIMEOUT` BSODs. This is documented as a hard requirement in both `README.md` and `AI_Context/AI_Guide_MCP_Server_Implementation.md`; don't weaken the assumption

1.4k5mo agoDiscuss

Team-CommonlyCLAUDE.md

commonly

Team-Commonly/commonly/CLAUDE.md

SERVICE_ACCOUNT`) or via ExternalSecrets. - **UI verification**: Use MCP Playwright (`mcp__playwright__*`) ### 📁 Key Documentation Files - **Code Review Rubric**: `/REVIEW.md` — **REQUIRED READING** before any code review, implementation planning, or pre-commit

1.4k3mo agoReads credentialsDiscuss

specstoryaiCLAUDE.md

getspecstory / specstory-cli

specstoryai/getspecstory/specstory-cli/CLAUDE.md

date with the latest changes. - When planning, never write time/calendar estimates into documents. ## Development Workflow When searching for code, ALWAYS exclude the `.specstory` directory. Don't just make your

1.3k4mo agoDiscuss

jayminwestCLAUDE.md

overstory

jayminwest/overstory/CLAUDE.md

# Overstory Project-agnostic swarm system for Claude Code agent orchestration. Overstory turns a single

1.3k7mo agoDiscuss

sipyourdrink-ltdCLAUDE.md

bernstein

sipyourdrink-ltd/bernstein/CLAUDE.md

docs` - `frontend` - `manager` - `ml-engineer` - `prompt-engineer` - `qa` - `resolver` - `retrieval` - `reviewer` - `security` - `visionary` - `vp` ## Documentation duty Every PR that adds or changes a feature MUST update docs in the same

1.3k9d agoDiscuss

GanyuanRanCLAUDE.md

Aegis

GanyuanRan/Aegis/CLAUDE.md

claude-plugin/`. - Hooks live in `hooks/`. - On Windows, hook commands should use the documented wrapper strategy in `docs/windows/polyglot-hooks.md`. - Do not hard-code private machine paths, local session IDs, or personal

1.3k5mo agoDiscuss

conorluddyCLAUDE.md

ios-simulator-skill

conorluddy/ios-simulator-skill/CLAUDE.md

app_launcher.py**: App lifecycle ### Testing & Analysis (9) - **accessibility_audit.py**: WCAG compliance - **visual_diff.py**: Screenshot comparison - **test_recorder.py**: Test documentation - **app_state_capture.py**: Debugging snapshots - **sim_health_check.sh**: Environment verification - **model_inspector.py**: Core Data and SwiftData model inspection - **container.py

1.2k19d agoDiscuss

SupabaseCLAUDE.md

postgres-meta

supabase/postgres-meta/CLAUDE.md

package.json": "./package.json" } ``` This allows importing package.json metadata in ESM without path resolution issues. ## OpenAPI Documentation Generate OpenAPI spec: ```bash npm run docs:export > openapi.json ``` Uses Fastify's `@fastify/swagger` plugin. Routes

1.2k31d agoDiscuss

CLAUDE.md vs AGENTS.md

About CLAUDE.md

What is CLAUDE.md?

A file Claude Code reads at the start of every session. It holds the commands, conventions and warnings the agent needs for this project.

Where does it go?

At the repository root. Claude Code also reads CLAUDE.md files in subdirectories when it works there.

What should it contain?

Build and test commands, the project's layout, conventions that aren't obvious from the code, and mistakes to avoid. Short files tend to work better than long ones.

CLAUDE.md or AGENTS.md?

Claude Code reads CLAUDE.md; most other agents read AGENTS.md. Many projects keep one and point the other at it.