agentleFS

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 19Worked for most · soon
halideCLAUDE.md

Halide

halide/Halide/.claude/CLAUDE.md

comments or PR descriptions require a 'Generated with' footer that names the tool used. - Documentation, comments, and tutorials should match the existing style and prose — keep explanations simple and concise

6.6k18d agoReviewMountCreate a free account to mount
k3d-ioCLAUDE.md

k3d

k3d-io/k3d/CLAUDE.md

fault ## Deep Dive References For detailed analysis beyond this summary, see `.planning/codebase/`: | Document | Contents | |----------|----------| | `STACK.md` | Full dependency inventory, Go version, build toolchain, Docker SDK usage | | `ARCHITECTURE.md` | Layer diagrams, data flow

Steady5 mentions in 2 weeks

No other project uses it yet

6.6k4y agoReviewMountCreate a free account to mount
j3ssieReads credentialsCLAUDE.md

osmedeus

j3ssie/osmedeus/CLAUDE.md

Installation make install # Install to $GOBIN (or $GOPATH/bin) make swagger # Generate Swagger documentation # Docker Toolbox make docker-toolbox # Build toolbox image (all tools pre-installed) make docker-toolbox-run # Start

6.6k7mo agoReviewMountCreate a free account to mount
thedevdojoCLAUDE.md

wave

thedevdojo/wave/CLAUDE.md

Auto-loading via `PluginServiceProvider` - Plugin creation command available ## Configuration ### Environment Variables - `WAVE_DOCS` - Show/hide documentation - `WAVE_DEMO` - Enable demo mode - `WAVE_BAR` - Show development bar - `BILLING_PROVIDER` - Set to 'stripe

6.6k10mo agoReviewMountCreate a free account to mount
YunYouJunReads credentialsCLAUDE.md

cook

YunYouJun/cook/CLAUDE.md

core the iOS CookCore mirrors), and the CLI (`convert`, `fetch`) - **docs** — VitePress documentation site - **scripts** — Build/utility scripts - **Root** — Workspace tooling, tests (`test/`) and `cloudfunctions/`; no legacy native shells ### App Source

6.5k15d agoReviewMountCreate a free account to mount
SentryCLAUDE.md

MobileBuildMCP

getsentry/MobileBuildMCP/CLAUDE.md

alternate path. Add a fallback only when explicitly requested or when it is a documented product requirement. - Review the complete merge-base diff and trace changed or reused helper contracts

6.5k40d agoReviewMountCreate a free account to mount
rizsottoCLAUDE.md

Bear

rizsotto/Bear/CLAUDE.md

page | `man/CLAUDE.md` | | Write or modify a docs site page | `site/CLAUDE.md` | | Find project documentation or how it is organized | `docs/CLAUDE.md` | | Add, modify, or review a requirement (contract) | `docs/requirements/CLAUDE.md` | | Record or look

6.5k3mo agoReviewMountCreate a free account to mount
rizsottoCLAUDE.md

Bear

rizsotto/Bear/docs/CLAUDE.md

CLAUDE.md - `docs/` guide This is the index for project documentation - start here to find what each part holds. The two role-based subdirectories: | Directory | Holds | Guide | |---|---|---| | [`requirements/`](requirements/) | Contracts: what

6.5k3mo agoReviewMountCreate a free account to mount
rizsottoCLAUDE.md

Bear / site

rizsotto/Bear/site/CLAUDE.md

CLAUDE.md - `site/` guide This directory is Bear's user-facing documentation site: an [mdBook](https://rust-lang.github.io/mdBook/) book that is published to GitHub Pages at `https://rizsotto.github.io/Bear/

6.5k3mo agoReviewMountCreate a free account to mount
czlonkowskiCLAUDE.md

n8n-skills

czlonkowski/n8n-skills/CLAUDE.md

hook) ├── hooks/ # Enforcement layer: hooks.json + SessionStart/PreToolUse/PostToolUse scripts ├── evaluations/ # Test scenarios for each skill ├── docs/ # Documentation ├── dist/ # Build output (gitignored — zips ship as GitHub Release assets, never committed; committed zips broke

Steady4 mentions in 2 weeks

No other project uses it yet

6.5k2mo agoReviewMountCreate a free account to mount
petyosiCLAUDE.md

react-virtuoso

petyosi/react-virtuoso/CLAUDE.md

files) After docs changes: run `pnpm lint` from the app directory or root. **IMPORTANT - Documentation Locations:** **DO NOT EDIT** the following auto-generated directories: - `apps/virtuoso.dev/src/content/docs/data-table/` - `apps/virtuoso.dev/src/content/docs/react-virtuoso/` - `apps/virtuoso.dev/src/content/docs/masonry/` - `apps/virtuoso.dev/src/content/docs/gurx/` - `apps/virtuoso.dev/src/content/docs/message-list/` These

Steady12 mentions in 2 weeks

No other project uses it yet

6.5k5mo agoReviewMountCreate a free account to mount
Arthur-FicialCLAUDE.md

apfel

Arthur-Ficial/apfel/CLAUDE.md

refactors are covered by existing tests; new behavior gets a new failing test first. ### Documentation style: - **Links in docs and README:** Always use the URL/path as the anchor text

6.5k3mo agoReviewMountCreate a free account to mount
jacob-bdCLAUDE.md

notebooklm-mcp

jacob-bd/notebooklm-mcp/CLAUDE.md

exhausted window needs to wait for the reset time that `nlm usage` reports. ## Documentation ### API Reference **For detailed API documentation** (RPC IDs, parameter structures, response formats), see: **[docs/API_REFERENCE.md](./docs/API_REFERENCE.md)** This

Steady8 mentions in 2 weeks

2 projects use a version of this

6.4k5d agoReviewMountCreate a free account to mount
builderz-labsReads credentialsCLAUDE.md

mission-control

builderz-labs/mission-control/CLAUDE.md

database, utilities .data/ SQLite database + runtime state (gitignored) scripts/ Install, deploy, diagnostics scripts docs/ Documentation and guides ``` Path alias: `@/*` maps to `./src/*` ## Data Directory Set `MISSION_CONTROL_DATA

6.4k4mo agoReviewMountCreate a free account to mount
bfirshCLAUDE.md

jsnes

bfirsh/jsnes/CLAUDE.md

familiar with the NES or emulation, so add more comments and documentation than you might otherwise do, and explain context. ## Essential Commands - `npm test` - Run code formatting check and tests

6.4k8mo agoReviewMountCreate a free account to mount
Provenance-EmuReads credentialsCLAUDE.md

Provenance

Provenance-Emu/Provenance/CLAUDE.md

user root is Caches.** `PVAzaharCore.userRootURL` is `Documents/Azahar` on iOS and `Library/Caches/Azahar` on tvOS, where Documents is not writable. - **`-fcxx-modules` is on** so the ObjC++ glue can `@import

6.4k13d agoReviewMountCreate a free account to mount
valhallaCLAUDE.md

valhalla

valhalla/valhalla/CLAUDE.md

changes" restating the diff, no summaries of files touched, no closing recap, no inline documentation links unless the link itself is the load-bearing reference. After the draft

No other project uses it yet

6.4k46d agoReviewMountCreate a free account to mount
cvxpyCLAUDE.md

cvxpy

cvxpy/cvxpy/CLAUDE.md

Register** it in `CANON_METHODS` in `cvxpy/reductions/dcp2cone/canonicalizers/__init__.py` 4. **Export** the atom in `cvxpy/atoms/__init__.py` 5. **Document** it (see `doc/` folder; renders at [cvxpy.org](https://www.cvxpy.org/)) Steps 3-5 fail silently

No other project uses it yet

6.4k8y agoReviewMountCreate a free account to mount
cryticCLAUDE.md

slither

crytic/slither/CLAUDE.md

logic; separate analyze → suggest → apply for composability. ### Code quality - **Comments** - Code should be self-documenting. No commented-out code (delete it). No comments that repeat what code does. - **Errors** - Fail

No other project uses it yet

6.4k10mo agoReviewMountCreate a free account to mount
rundeckCLAUDE.md

rundeck

rundeck/rundeck/CLAUDE.md

Project Conventions ## Documentation Detailed conventions and guidance organized by topic: ### Architecture & Setup - **`.claude/docs/architecture.md`** — Project structure, module organization, technology stack - **`.claude/docs/build-commands.md`** — All build, test, and plugin commands with examples - **`.claude/docs/file-locations.md`** — Where

Steady2 mentions in 2 weeks

No other project uses it yet

6.4k27d agoReviewMountCreate a free account to mount
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.