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

nizosCLAUDE.md

tdd-guard

nizos/tdd-guard/CLAUDE.md

clients └── index.ts # Package entry point test/ # Main test suite (hooks, integration, utils) docs/ # Documentation (ADRs, configuration, etc.) ``` ### Architecture TDD Guard is organized as a TypeScript project with integrated language-specific

2.3k3mo agoDiscuss

antonbabenkoCLAUDE.md

terraform-skill

antonbabenko/terraform-skill/CLAUDE.md

contributors, maintainers, and skill developers. ## What This Is A **Claude Code skill** - executable documentation that Claude loads to provide Terraform/OpenTofu expertise. It encodes terraform-best-practices.com patterns into Claude's context

2.3k4mo agoDiscuss

jnMetaCodeCLAUDE.md

agency-orchestrator

jnMetaCode/agency-orchestrator/CLAUDE.md

Endpoints in `web/server.js`: `GET /api/community/templates`, `POST /api/community/import` (engine-validated, saved to 我的工作流). Contribution flow documented in CONTRIBUTING.md. Listing/de-listing needs only a website push, no release. NOTE: manifest `relayPresets` that duplicate

2.3k6mo agoReads credentialsDiscuss

lhferCLAUDE.md

claude-howto-zh-cn

lhfer/claude-howto-zh-cn/CLAUDE.md

CLAUDE.md 这个文件给 Claude Code 提供“如何在这个仓库里协作”的工作说明。 ## 项目定位 `claude-howto-zh-cn` 是一个 **documentation-as-code** 仓库。 - 主体产物是 Markdown 教程与示例，不是可执行应用 - 核心目标是把上游 `luongnv89/claude-howto` 做成更适合中国小白的中文主线指南 - 兼容性优先级很高：命令名、frontmatter、JSON/YAML key、环境变量

2.3k56d agoDiscuss

K-Dense-AICLAUDE.md

claude-scientific-writer

K-Dense-AI/claude-scientific-writer/CLAUDE.md

Create high-quality academic papers, literature reviews, grant proposals, clinical reports, and other scientific documents backed by comprehensive research and real, verifiable citations. **Default Format:** LaTeX with BibTeX citations unless

2.3k49d agoReads credentialsDiscuss

muxy-appCLAUDE.md

muxy

muxy-app/muxy/CLAUDE.md

Never run the app. User will run and test visually - When code changes affect documented behavior, public APIs, hooks, configuration, or workflows, update the related documentation accurately. - If contributed using

2.3k6mo agoDiscuss

tractorjuiceCLAUDE.md

arc-kit

tractorjuice/arc-kit/CLAUDE.md

generate strategy, architecture, delivery, and assurance artifacts. It transforms architecture governance from scattered documents into a systematic, template-driven process. **Nine distribution formats** exist side-by-side in this repo

2.2k5mo agoReads credentialsDiscuss

HermannBjorgvinCLAUDE.md

Clawdmeter

HermannBjorgvin/Clawdmeter/CLAUDE.md

display power, P5 = touch power, P7 = audio amp**. `io_expander_init()` runs the documented power-on sequence (P4/P5 LOW → 200 ms → HIGH) and **MUST run before `display_hal_init

2.2k11d agoDiscuss

oh-my-mermaidCLAUDE.md

oh-my-mermaid

oh-my-mermaid/oh-my-mermaid/CLAUDE.md

/README.ko.md) | [日本語](./README.ja.md) | [中文](./README.zh.md) ``` - Translated READMEs include a disclaimer at the top: > This document was translated from the English README. Some phrasing may be unnatural. - When updating `README.md`, update

2.2k6mo agoDiscuss

jhlee0409CLAUDE.md

claude-code-history-viewer

jhlee0409/claude-code-history-viewer/CLAUDE.md

server_tool_use"`) - e.g., web_search - ✅ Web search results (`type: "web_search_tool_result"`) - ✅ Document content (`type: "document"`) - PDF and plain text - ✅ Search results (`type: "search_result"`) - ✅ MCP tool

2.2k3mo agoDeletes or force-pushesDiscuss

mrgoonieCLAUDE.md

claudekit-skills

mrgoonie/claudekit-skills/CLAUDE.md

symlink) ``` ### 12 Plugin Categories `ai-ml-tools`, `web-dev-tools`, `devops-tools`, `backend-tools`, `document-processing`, `debugging-tools`, `problem-solving-tools`, `platform-tools`, `meta-tools`, `media-tools`, `research-tools`, `specialized

2.2k11mo agoReads credentialsDiscuss

carlvellottiCLAUDE.md

free-ai-courses

carlvellotti/free-ai-courses/CLAUDE.md

facing interactive course content (distributed via GitHub Releases as a zip) 2. **website/** - Next.js documentation site (deployed to Vercel at ccforpms.com) Students download course-materials/ as a zip, extract

2.2k2mo agoDiscuss

StripeCLAUDE.md

stripe-ruby

stripe/stripe-ruby/.claude/CLAUDE.md

test section of @.github/workflows/ci.yml) ### Comments - Comments MUST only be used to: 1. Document a function 2. Explain the WHY of a piece of code 3. Explain a particularly complicated piece

2.2k55d agoDiscuss

wondelaiCLAUDE.md

skills

wondelai/skills/CLAUDE.md

patterns, software-design-philosophy, pragmatic-programmer, domain-driven-design, working-with-legacy-code, technical-documentation | | **Systems/Architecture** | ddia-systems, system-design, clean-architecture, release-it, high-perf-browser, team-topologies | | **Team/Management

2.2k3mo agoDiscuss

ShopifyCLAUDE.md

hydrogen / cookbook

Shopify/hydrogen/cookbook/CLAUDE.md

reproducible recipes. **IMPORTANT: This file provides quick reference and common patterns. For comprehensive command documentation, implementation details, and additional context, read `cookbook/README.md`.** ## Quick Reference ```bash pnpm run cookbook -- validate # Validate

2.1k6mo agoDiscuss

CloudflareCLAUDE.md

templates

cloudflare/templates/CLAUDE.md

content section wrapped in ` ` and ` ` - Screenshot of live application - Description of products used with documentation links ### Technical Requirements - **Package-lock.json**: Required for 80% faster module resolution - **Tests**: Mandatory minimum

2.1k9mo agoDiscuss

LumiwealthCLAUDE.md

lumibot

Lumiwealth/lumibot/CLAUDE.md

hostnames, private URLs, cookies, local profile paths, or absolute personal filesystem paths. - Do not document real `.env` locations, credential-file paths, secret store values, or commands that write real credentials

2.1k18d agoReads credentialsDiscuss

gregghCLAUDE.md

claude-code.nvim

greggh/claude-code.nvim/CLAUDE.md

Code: `env -C /home/gregg/Projects/neovim/plugins/claude-code stylua lua/` - Run Linter: `env -C /home/gregg/Projects/neovim/plugins/claude-code luacheck lua/` - Build Documentation: `env -C /home/gregg/Projects/neovim/plugins/claude-code mkdocs build` ## Project Structure - `/lua/claude-code`: Main plugin code - `/lua/claude-code/cli`: Claude Code

2.1k17mo agoDiscuss

digitalsambaCLAUDE.md

claude-code-video-toolkit

digitalsamba/claude-code-video-toolkit/CLAUDE.md

Curated showcase projects (shared) ├── assets/ # Shared assets (voices, images) ├── playwright/ # Browser recording infrastructure ├── docs/ # Documentation └── _internal/ # Toolkit metadata & registry ``` ## Registry `_internal/toolkit-registry.json` is the canonical source for all skills, commands, tools

2.1k21d agoReads credentialsDiscuss

agentset-aiCLAUDE.md

agentset

agentset-ai/agentset/docs/CLAUDE.md

Agentset documentation (powered by Mintlify) ## Project context - Format: MDX files with YAML frontmatter - Config: docs.json for navigation, theme, settings - Components: Mintlify components ## Product context - Agentset is RAG-as-a-service

2.1k8mo 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.