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 13Worked for most · soon

patrickchughCLAUDE.md

terravision

patrickchugh/terravision/docs/CLAUDE.md

Decision**: - ✅ If baseline is clear → **STOP! No handler needed.** - ❌ If baseline is confusing → Document specific issues, proceed to handler 4. **Document Justification**: - What specific diagram problem does the handler solve

1.6k6d agoReads credentialsDiscuss

ddalcuCLAUDE.md

mlx-serve / app

ddalcu/mlx-serve/app/CLAUDE.md

size for, and snapping its ladder would collapse the prose/code gap its own comment documents. The console is the web half of the same rule: `rem`, never

1.6k3d agoReads credentialsDiscuss

ddalcuCLAUDE.md

mlx-serve

ddalcu/mlx-serve/CLAUDE.md

queue`; app flow load→generate→unload; headless starts idle. `model_discovery.isMediaModelType` and `gen.modalityFromType` are documented duplication — keep in sync. Downloads → `~/.mlx-serve/models` (Swift + Zig). - `POST /v1/images/edits` = OpenAI multipart translated by `gen.openaiEditFormToJson` into

1.6k3d agoDeletes or force-pushesDiscuss

ddalcuCLAUDE.md

mlx-serve / tests

ddalcu/mlx-serve/tests/CLAUDE.md

# tests/ — test matrix & guard reference (auto-loaded when working here) Root CLAUDE.md carries the

1.6k3d agoDeletes or force-pushesDiscuss

Asymptote-LabsCLAUDE.md

agent-beacon

Asymptote-Labs/agent-beacon/CLAUDE.md

sandbox/AGENTS.md`. - `packaging`: macOS, Linux, and Windows packaging and deployment assets. - `docs`: the published documentation site (docs.asymptotelabs.ai). Do not recreate or depend on removed `asymptote` mirror trees. Keep new work

1.6k6d agoReads credentialsDiscuss

e2b-devCLAUDE.md

infra

e2b-dev/infra/CLAUDE.md

anything it describes (service responsibilities, ports, protocols, data stores, flows, deployment topology), update the document in the same change. ## Common Development Commands ### Setup & Environment ```bash # Switch between environments (prod, staging

1.6k17d agoReads credentialsDiscuss

pedrohcgsCLAUDE.md

claude-code-my-workflow

pedrohcgs/claude-code-my-workflow/CLAUDE.md

consumers pinned by commit SHA. **How we write** — [`writing-with-ai.md`](.claude/rules/writing-with-ai.md): internal vs external-facing documents, why a model cannot make its own output stop reading as model output

1.6k4d agoDiscuss

actionbookCLAUDE.md

actionbook

actionbook/actionbook/CLAUDE.md

Always use context7 when I need code generation, setup or configuration steps, or library/API documentation. This means you should automatically use the Context7 MCP tools to resolve library

1.6k2mo agoReads credentialsDiscuss

DockerCLAUDE.md

mcp-gateway

docker/mcp-gateway/CLAUDE.md

commands - `cmd/docker-mcp/tools/` - Tool execution and management - `examples/` - Usage examples and compose configurations - `docs/` - Technical documentation ## Key Configuration Files The CLI uses these configuration files (typically in `~/.docker/mcp/`): - `docker-mcp.yaml` - Server catalog

1.6k9mo agoDiscuss

svnschaCLAUDE.md

mcp-windbg

svnscha/mcp-windbg/CLAUDE.md

pipx run` - while every variant keeps identical tool names and one set of documentation. Change `plugin.json`'s name and you rename its tools with it. The skills-only entry

1.6k4mo agoReads credentialsDiscuss

rivet-devCLAUDE.md

sandbox-agent

rivet-dev/sandbox-agent/CLAUDE.md

user-facing terms instead. - Do not describe the underlying protocol implementation in docs. Only document the SDK surface (methods, types, options). ACP protocol details belong exclusively in ACP-specific pages

1.6k7mo agoDiscuss

rivet-devCLAUDE.md

sandbox-agent / sdks

rivet-dev/sandbox-agent/sdks/CLAUDE.md

specific shells such as session selection, session headers, and control-plane actions in `frontend/packages/inspector/`. - Document all shared React components in `docs/react-components.mdx`, and keep that page aligned with the exported surface

1.6k7mo agoDiscuss

rivet-devCLAUDE.md

sandbox-agent / server

rivet-dev/sandbox-agent/server/CLAUDE.md

real ACP methods internally and not send fabricated fields over the wire. ## Source Documents - ACP protocol specification (full LLM-readable reference): `https://agentclientprotocol.com/llms-full.txt` - `~/misc/acp-docs/schema/schema.json` - `~/misc/acp-docs/schema/meta.json` - `research/acp/spec.md` - `research/acp/v1-schema-to-acp-mapping.md` - `research/acp/friction.md` - `research/acp/todo.md

1.6k7mo agoDiscuss

GWUDCAPCLAUDE.md

cc-sessions

GWUDCAP/cc-sessions/CLAUDE.md

handling - **Todo Change Blocking**: Enhanced feedback with diff display and prescribed response format ## Related Documentation - **RELEASE.md** - Maintainer guide for version releases - **README.md** - User-facing feature overview - **docs/INSTALL.md** - Detailed installation instructions

1.6k12mo agoDiscuss

StripeCLAUDE.md

stripe-dotnet

stripe/stripe-dotnet/.claude/CLAUDE.md

just test`, `just format` complete successfully. ### Comments - Comments MUST only be used to: 1. Document a function 2. Explain the WHY of a piece of code 3. Explain a particularly

1.5k7mo agoDiscuss

fim-aiCLAUDE.md

fim-one

fim-ai/fim-one/CLAUDE.md

pytest tests/test_foo.py`, restart + check Z). Communication only — doesn't replace automated tests. ## Post-Commit Documentation Sync (MANDATORY — DO NOT SKIP) > After EVERY `git commit`, run the checklist below BEFORE responding

1.5k15d agoReads credentialsDiscuss

silversteinCLAUDE.md

minutes

silverstein/minutes/CLAUDE.md

helpers ├── .opencode/commands/ # OpenCode /minutes-* slash-command wrappers └── tests/integration/ # Integration tests (including real whisper tests) ``` ## Documentation Structure Documentation is organized under `docs/` by purpose. See [docs/README.md](docs/README.md) for the index. - `docs/architecture

1.5k29d agoDiscuss

NeoLabHQCLAUDE.md

context-engineering-kit

NeoLabHQ/context-engineering-kit/CLAUDE.md

claude-plugin/ │ │ └── plugin.json # Plugin manifest │ ├── README.md │ ├── commands/ # Slash commands (*.md) │ └── skills/ # Skills (*.md) ├── docs/ # Documentation (GitBook) │ └── plugins/ │ └── / # Plugin documentation │ └── README.md ├── specs/ # Feature specifications ├── justfile # Development commands └── CONTRIBUTING.md # Contribution guidelines ``` ## Available

1.5k6mo agoDiscuss

dvdsglCLAUDE.md

claude-canvas / canvas

dvdsgl/claude-canvas/canvas/CLAUDE.md

components (React/Ink) │ ├── scenarios/ # Scenario definitions │ ├── ipc/ # IPC server/client │ └── api/ # High-level API ├── skills/ # Skill documentation ├── commands/ # User commands └── package.json # Plugin dependencies ``` ## Adding a New Canvas Type 1. Create component

1.5k9mo agoDiscuss

hyhmrrightCLAUDE.md

brooks-lint

hyhmrright/brooks-lint/CLAUDE.md

from every `README*.md` and `docs/getting-started.md` **and** add the name to each of those documents' ` = …` enumeration (the `<平台> = …` line in the zh translations). That enumeration must list every `PLATFORMS` entry

1.5k11d agoReads credentialsDiscuss

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.