agentleFS
Sign inSign up

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 20Worked for most · soon
magicyuan876CLAUDE.md

mineru-tianshu

magicyuan876/mineru-tianshu/CLAUDE.md

Failures route through `on_child_task_failed`. ### Format engine plugin system To add a document format: subclass `FormatEngine` (`backend/format_engines/base.py`), set `SUPPORTED_EXTENSIONS` / `FORMAT_NAME` / `FORMAT_DESCRIPTION`, implement `parse()` returning `{format

82311d agoReads credentialsDiscuss
VercelCLAUDE.md

next-devtools-mcp

vercel/next-devtools-mcp/CLAUDE.md

provides Playwright-based browser automation. It exposes **tools only** — no prompts or resources. Documentation ships with Next.js itself (`node_modules/next/dist/docs/`), and upgrade/Cache Components workflows are distributed as agent skills

82312mo agoDiscuss
tfriedelCLAUDE.md

claude-office-skills

tfriedel/claude-office-skills/CLAUDE.md

with code in this repository. ## Repository Overview This is a skills repository for Office document manipulation (PPTX, DOCX, XLSX, PDF). Each skill provides workflows, scripts, and documentation for working with

81912mo agoDiscuss
terrysoCLAUDE.md

claude-auto-resume

terryso/claude-auto-resume/CLAUDE.md

single-file architecture: - **claude-auto-resume.sh**: Main script containing all logic - **Makefile**: Simple installation/uninstallation script - **docs/**: Documentation including PRD, architecture, and user stories ### Core Logic Flow 1. Parses command line arguments

81715mo agoDiscuss
H-mmerCLAUDE.md

pentest-agents

H-mmer/pentest-agents/CLAUDE.md

behavior, include scaffold-specific tests. If a change alters provider rendering, include drift detection. ## Documentation Expectations Update docs in the same change when behavior changes: - `README.md` for user workflows

8155mo agoDiscuss
obieCLAUDE.md

claude-on-rails

obie/claude-on-rails/CLAUDE.md

dependency, so no need to tell users to install it separately ### 4. Documentation Clarity - Clearly distinguish between shell commands and Claude prompts - Use `>` prefix for Claude prompts to avoid confusion

81315mo agoDiscuss
ruvnetCLAUDE.md

agentic-flow

ruvnet/agentic-flow/CLAUDE.md

ALWAYS prefer editing an existing file to creating a new one - NEVER proactively create documentation files (\*.md) or README files unless explicitly requested - NEVER save working files, text/mds, or tests

8128mo agoReads credentialsDiscuss
AVIDS2CLAUDE.md

memorix

AVIDS2/memorix/CLAUDE.md

long-running release or development work. - It is the only living work-status document. Update it after material cross-session work; do not create parallel progress or dev-log files

8097mo agoDiscuss
gotempshCLAUDE.md

temps

gotempsh/temps/CLAUDE.md

spec:update` (see [Regenerating the OpenAPI clients](#regenerating-the-openapi-clients)) - Create markdown documentation files unless explicitly requested - Mark Docker tests with `#[ignore]` -- they MUST skip gracefully at runtime instead

8017d agoReads credentialsDiscuss
23blocks-OSCLAUDE.md

ai-maestro

23blocks-OS/ai-maestro/CLAUDE.md

terminal.ts - xterm.js configuration, dimensions websocket.ts - Message protocol, connection states docs/ images/ - Screenshots for README documentation REQUIREMENTS.md - Installation prerequisites OPERATIONS-GUIDE.md - Session management, troubleshooting plugin/ - Plugin submodule (git submodule from 23blocks

79916d agoReads credentialsDiscuss
AvdLeeCLAUDE.md

RocketSimApp

AvdLee/RocketSimApp/docs/CLAUDE.md

site's content model), see [CONTEXT.md](./CONTEXT.md). For feature cards, feature pages, product documentation, and blog posts, follow the scoped [Content Authoring Guide](./CONTENT-AUTHORING.md

79914mo agoDiscuss
StripeCLAUDE.md

link-cli

stripe/link-cli/CLAUDE.md

expires_at is not supported for this client"`) if they try it — don't document or suggest it to general agents. ### payment-methods command - `payment-methods update --nickname ` requires

7986d agoReads credentialsDiscuss
regent-vcsCLAUDE.md

re_gent

regent-vcs/re_gent/CLAUDE.md

which prompt), and lets you blame, log, and inspect steps across sessions. This document is the project's source of truth for context, vocabulary, and architectural decisions

7895mo agoDiscuss
LangChainCLAUDE.md

deep_research_from_scratch

langchain-ai/deep_research_from_scratch/CLAUDE.md

source code (DO NOT MODIFY) │ ├── multi_agent_supervisor.py │ ├── prompts.py │ ├── research_agent.py │ ├── research_agent_mcp.py │ ├── state_*.py │ └── utils.py └── README.md # Comprehensive documentation ``` ## 🚨 Important Development Workflow **The notebooks in `notebooks/` are the source of truth and should

78214mo agoDiscuss
MongoDBCLAUDE.md

docs

mongodb/docs/CLAUDE.md

Claude Code when working in this repository. ## Repository Overview This is the MongoDB Documentation Monorepo. It combines three areas in one repo: - `content/` — RST documentation source files for all MongoDB

77713d agoDiscuss
MongoDBCLAUDE.md

docs / code-example-tests

mongodb/docs/code-example-tests/CLAUDE.md

Testing Platform Grove is the infrastructure for creating **tested, snippeted code examples** for MongoDB documentation. Writers create example files with Bluehawk markup, test files that verify the examples work

77713d agoDiscuss
alirezarezvaniCLAUDE.md

claude-code-tresor

alirezarezvani/claude-code-tresor/CLAUDE.md

code-reviewer, test-generator, git-commit-helper │ ├── security/ # security-auditor, secret-scanner, dependency-auditor │ └── documentation/ # api-documenter, readme-updater ├── subagents/ # 133 Agents - PRIMARY LOCATION (v2.7+) │ ├── core/ # 8 core production agents

76811mo agoDiscuss
bruin-dataCLAUDE.md

dac

bruin-data/dac/CLAUDE.md

types (metric, chart, table, text), filters, query templating (Jinja), grid layout, and CLI usage. ## Documentation After every code change, scan `docs/` for areas the change touches and update them

7685mo agoDiscuss
aeonfunCLAUDE.md

aeon

aeonfun/aeon/CLAUDE.md

fields, severity, categories, lifecycle) is owned by `skills/skill-health/SKILL.md`; the end-to-end loop is documented in `docs/CORE.md`. Only active once `INDEX.md` exists. - **`memory/skill-health/`** — Per-run quality scores the health loop

75742d agoReads credentialsDiscuss
Kc1tCLAUDE.md

alethe-agents

Kc1t/alethe-agents/CLAUDE.md

English is the default language for all versioned repository content, including source comments, JSDoc, documentation, changelog entries, user-facing strings, commit messages, and pull requests. - Never add Portuguese prose

75511d 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.