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.

Best matches · from page 12Worked for most · soon

“pdf” bradautomates

CalyPdfCLAUDE.md

Caly

CalyPdf/Caly/CLAUDE.md

when working with code in this repository. ## Project Overview Caly is a cross-platform PDF reader built with Avalonia UI and .NET. It targets Windows, Linux, macOS, Android

23410d agoReviewMount

versyxdigitalCLAUDE.md

toolbar. Exports use the File System Access API or `window.open` + `print()` for PDF. Mode branching lives in [index.ts](src/browser/index.ts), [EditorManager](src/browser/core/EditorManager.ts), [SettingsProvider](src/browser/core/providers/SettingsProvider.ts), [ExportSettingsProvider](src/browser/core/providers/ExportSettingsProvider.ts), and a few React components

2346mo agoReviewMount

danmolitorCLAUDE.md

forme

danmolitor/forme/CLAUDE.md

CLAUDE.md ## What This Is Forme is a **page-native PDF rendering engine** written in Rust. It takes a tree of document nodes (like a simplified DOM) and produces PDF bytes

2303mo agoReviewMount

civilian7CLAUDE.md

sql-tutorial

civilian7/sql-tutorial/CLAUDE.md

mermaid, 버전 치환) │ └── version.json # 버전 정보 ├── .github/workflows/ # CI (verify.yml) ├── serve.bat # 로컬 튜토리얼 서버 ├── pdf.bat # PDF 내보내기 └── output/ # 생성된 DB/SQL 파일 출력 디렉토리 ├── ecommerce-ko.db # SQLite DB (한국어) ├── sqlite/ # SQLite SQL 스크립트

2287mo agoReviewMount

timothywarner-orgReads credentialsCLAUDE.md

claude-code / mcp-teaching-kit-main

timothywarner-org/claude-code/mcp-teaching-kit-main/CLAUDE.md

Corpus The `docs` dict in `mcp_server.py` ships six audience-calibrated documents (2 `.md`, 2 `.pdf`, 1 `.docx`, 1 `.txt`). All are 150-250 words with embedded structure cues

2234mo agoReviewMount

fabriqaaiCLAUDE.md

specs.md

fabriqaai/specs.md/.claude/claude.md

MUST read these files **IN ORDER**: ### Primary Source (ALWAYS FIRST) 1. **AI-DLC Specification** - PDF: `/resources/aidlc.pdf` (original AWS specification) - Text: `/resources/ai-dlc-specification.md` (readable version) - This is the authoritative source

2189mo agoReviewMount

franklee16CLAUDE.md

academic-research-skills

franklee16/academic-research-skills/CLAUDE.md

2187mo agoReviewMount

RLabs-IncReads credentialsCLAUDE.md

gemini-mcp

RLabs-Inc/gemini-mcp/CLAUDE.md

summarization 12. **Document Analysis** (`document.ts`): - `gemini-analyze-document`: Analyze PDFs, DOCX, spreadsheets - `gemini-summarize-pdf`: Quick PDF summarization - `gemini-extract-tables`: Extract tables from documents 13. **URL Context** (`url-context.ts`): - `gemini

21710mo agoReviewMount

Agents365-aiReads credentialsCLAUDE.md

zotero-cli-cc

Agents365-ai/zotero-cli-cc/CLAUDE.md

pytest tests/test_reader.py::test_name -v uv run pytest -k "search and not pdf" -v # Run the CLI from source uv run zot search "foo" uv run zot schema # emit full

2143mo agoReviewMount

gustavoeenriquezCLAUDE.md

MakerAi / Docs

gustavoeenriquez/MakerAi/Docs/CLAUDE.md

based workflows) │ ├── MCPServer/ ← Model Context Protocol server implementation │ ├── RAG/ ← Retrieval-Augmented Generation (vector + graph) │ └── PDF/ ← Distribution-ready consolidated PDFs └── Reportes/ ← Informes de campo desde consumidores del framework ``` ## Language Documentation

21441d agoReviewMount

mduongvandinhCLAUDE.md

llm-wiki

mduongvandinh/llm-wiki/CLAUDE.md

hệ thống ├── raw/ ← Nguồn thô (KHÔNG ĐƯỢC SỬA) │ ├── articles/ ← Web articles (markdown, text) │ ├── papers/ ← PDF, research papers │ ├── notes/ ← Ghi chú cá nhân │ ├── media/ ← Screenshots, diagrams │ └── assets/ ← Downloaded images từ articles

2147mo agoReviewMount

DaveMoudyCLAUDE.md

SalesforceDocGen

DaveMoudy/SalesforceDocGen/CLAUDE.md

Keep them relative. The `Blob.toPdf()` engine resolves relative Salesforce paths internally. ## Critical: Zero-Heap PDF Image Rendering For PDF output, `{%ImageField}` tags with ContentVersion IDs MUST skip blob loading

2118mo agoReviewMount

FarzamHejaziKCLAUDE.md

claude-linkedin-assistant

FarzamHejaziK/claude-linkedin-assistant/CLAUDE.md

needs about the user comes from their resume in `resumes/`. Read whatever's there (PDF / .tex / .md / .docx) whenever a flow needs: - The user's **name** (top of resume) → used

2115mo agoReviewMount

jgravelleReads credentialsCLAUDE.md

jdocmunch-mcp

jgravelle/jdocmunch-mcp/CLAUDE.md

span: a text-layer page 1 sits before the first span. The mixed-PDF test pins it. (v1.149.0) - ⚠⚠ **An empty conversion is not an error, so nothing downstream sees

20625d agoReviewMount

OWWZOReads credentialsCLAUDE.md

ai-agent / ui

OWWZO/ai-agent/ui/CLAUDE.md

Task 等） │ │ ├── message.ts # 消息协议类型（SSE 返回的数据结构） │ │ └── global.ts # 全局类型（CuteType 命名空间） │ │ │ └── assets/ # 静态资源 │ ├── icon/ # 文件类型图标（pdf、docx、excel 等） │ ├── relayFonts/ # 自定义 iconfont 图标字体 │ └── styles/ # 样式文件 │ ├── RelayIcon.css # 图标字体 CSS │ ├── common.css # 公共样式 │ └── github-markdown.css

20637d agoReviewMount

rekal-devCLAUDE.md

rekal-cli

rekal-dev/rekal-cli/CLAUDE.md

# Rekal CLI ## Soul Before making any design decision, read `SOUL.md`. It defines the two

2069d agoReviewMount

RobThePCGuyReads credentialsCLAUDE.md

Claude-Patent-Creator

RobThePCGuy/Claude-Patent-Creator/CLAUDE.md

2068mo agoReviewMount

crownleoCLAUDE.md

ClaudeViewer

crownleo/ClaudeViewer/CLAUDE.md

导出 - MD：`convToMd()` + `shiftMdHeadings()`（把正文标题整体降 2 级，围栏内不动）+ `mdFence()`（围栏长度 = 内容中最长反引号串 +1，防击穿）。文件名以对话创建时间开头。 - PDF：`renderMdForExport()` 在父窗口用已内联的 marked + KaTeX **预渲染**，把 HTML 烘焙进弹窗——弹窗里没有任何脚本，才能离线打印。 - 批量：`exportAllZip()` 用 JSZip 打包

2022mo agoReviewMount

freecomputinglabCLAUDE.md

rheo

freecomputinglab/rheo/CLAUDE.md

CLAUDE.md ## Project **rheo** compiles Typst documents to PDF, HTML, and EPUB. Written in Rust using the Typst compiler as a library. A `FormatPlugin` does format transport — compile, write, serve

2015mo agoReviewMount

hiyeshuCLAUDE.md

codeck

hiyeshu/codeck/CLAUDE.md

user's project. codeck reads materials here, writes final deliverables here (HTML, PDF, PPTX). - **`~/.codeck/projects/{slug}/`** — codeck's deck room. Reads and writes MEMORY.md, channel/tasks/threads/roles, diagnosis.md, deck.md, DESIGN.md, custom.css, slides.html

1993mo 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.