CLAUDE.md examples from real projects

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

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Worked for most · soon

rivet-dev Hiding risky files

rivet-devCLAUDE.md

agent-os

rivet-dev/agent-os/CLAUDE.md

Always spell the product name agentOS, never AgentOS; do not alter type identifiers such as AgentOSActorConfig. agentOS owns the runtime, kernel, VFS, language execution, registry packages, agentOS client APIs, docs, and publish machinery. agentOS Exec is the JavaScript, TypeScript, and Python execution surface of agentOS. - Keep agentOS product versions pinned at 0.0.1 in committed files. Release workflows apply real versions transiently with scripts/publish; never commit release-version rewrites. - agentOS-owned npm packages must use the @rivet-dev/agentos-* namespace. Registry software packages…

4.9k43d agoReviewMount

rivet-devCLAUDE.md

agent-os

rivet-dev/agent-os/docs/CLAUDE.md

Rules for the docs in this repo. These pages are not rendered here — they are published on rivet.dev by the rivet-website repo, which symlinks this directory in. Everything below exists so a page written here renders correctly there. The website links docs/content into its content collection, so only real pages belong under content/. Anything else (scripts, fixtures, notes) goes elsewhere in the repo or it will be published as a docs page. Every page needs title and description. Both…

4.9k43d agoReviewMount

rivet-devCLAUDE.md

agent-os / packages

rivet-dev/agent-os/packages/CLAUDE.md

- Client packages must stay same-version with the sidecar: assert the single protocol version integer, and do not add wire back-compat, runtime negotiation, or converters. - Generated client layers return raw generated protocol types. The embedded AgentOs facade is publicly exported from @rivet-dev/agentos-core. - Generic agentos clients must stay application-agnostic and forward only the sandbox protocol. - agentos packages must never depend on agent-os packages; dependency direction is strictly agent-os to agentos and must be CI-enforced after the split. -…

4.9k43d agoReviewMount

rivet-devCLAUDE.md

agents

rivet-dev/agents/CLAUDE.md

This repository holds Rivet's agent projects. Project-specific rules live next to each project; read them before working there.

Steady2 mentions in 2 weeks

1 project uses a version of this

1.6k10mo agoReviewMount

rivet-devCLAUDE.md

agents

rivet-dev/agents/docs/CLAUDE.md

Rules for the Agents docs in this repo. These pages are not rendered here. They are published on rivet.dev by the website repo. .github/workflows/docs-sync.yml copies this directory and examples/ into the website's vendor/agents/ on every merge to main. Everything below exists so a page written here renders correctly there. Sandbox Agent's own docs (sandboxagent.dev) live in sandbox-agent/docs/ and follow different rules. Nothing in this file applies to them. The website links content/ into its content collection, so only real pages…

Steady2 mentions in 2 weeks

1 project uses a version of this

1.6k10mo agoReviewMount

rivet-devCLAUDE.md

agents / sandbox-agent

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

No summary in the file. Open it to read it.

1 project uses a version of this

1.6k10mo agoReviewMount

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.