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

zcagCLAUDE.md

tela

zcag/tela/CLAUDE.md

module scripts. That is exactly how pdf.js ships its worker (`pdf.worker.min-*.mjs`), so every PDF preview ran without one in production while vite's dev server typed it correctly — invisible

693mo agoReads credentialsDiscuss

Benboerba620CLAUDE.md

6844d agoReads credentialsDiscuss

rsarverCLAUDE.md

stella-decks

rsarver/stella-decks/CLAUDE.md

PDFs viewer/index.html # Browser-based slide viewer scripts/ export-deck.mjs # Screenshot slides to PNG, compose into PDF export-deck-md.mjs # Export deck content as Markdown generate-image.mjs # Generate images via OpenAI API (optional) DESIGN.md # Design

686mo agoReads credentialsDiscuss

imdinuCLAUDE.md

apple-mail-mcp

imdinu/apple-mail-mcp/CLAUDE.md

FTS5 column; JXA fallback without index) search("deadline", scope="body") # Body only (FTS5) search("pdf", scope="attachments") # By attachment filename (SQL) search("invoice", after="2025-01-01") # Date-range filtering

6617d agoDiscuss

0xPabloxxCLAUDE.md

introduction-to-agents-cn

0xPabloxx/introduction-to-agents-cn/CLAUDE.md

tags are mandatory for all Chinese text - **Image positioning is critical**: Must match original PDF layout - **Endnotes must be translated**: Complete coverage required - **License**: Translation released under

6411mo agoDiscuss

shredEngineerCLAUDE.md

Archive-Agent

shredEngineer/Archive-Agent/CLAUDE.md

agent/data/FileData.py` - File processing and payload creation - `archive_agent/core/ProgressManager.py` - Centralized hierarchical progress management - `archive_agent/data/loader/pdf.py` - PDF processing with business logic (OCR strategy resolution) - `archive_agent/data/loader/PdfDocument.py` - Clean PDF abstraction interfaces (PdfDocument, PdfPage

647d agoReads credentialsDiscuss

lonexrebCLAUDE.md

site2cli

lonexreb/site2cli/CLAUDE.md

markdown/text conversion, main content extraction │ ├── chunker.py # RAG chunking (fixed / sentence / heading strategies) │ └── pdf.py # PDF parsing via pdfplumber (text / markdown / page count) ├── search/ │ └── engine.py # DuckDuckGo search + chained scrape / extract ├── crawl/ │ ├── crawler.py

627mo agoDiscuss

fang503CLAUDE.md

antflow / backend

fang503/antflow/backend/CLAUDE.md

Multi-file upload with automatic document conversion: - Endpoint: `POST /api/threads/{thread_id}/uploads` - Supports: PDF, PPT, Excel, Word documents (converted via `markitdown`) - Rejects directory inputs before copying so uploads stay

616mo agoReads credentialsDiscuss

zoharbabinCLAUDE.md

web-researcher-mcp

zoharbabin/web-researcher-mcp/CLAUDE.md

SSRF-safe client; link verifier (liveness + Wayback archive) ├── documents/ # PDF, DOCX, PPTX extraction ├── cache/ # Cache interface + hybrid impl (memory L1 + optional Redis L2 + AES-encrypted disk L3) ├── persist/ # Generic

613mo agoReads credentialsDiscuss

color4-altCLAUDE.md

CiteCheck

color4-alt/CiteCheck/CLAUDE.md

pipeline ## Project Structure ``` CiteCheck/ ├── src/citecheck/ # Python package source │ ├── cli.py # CLI entry point │ ├── parser.py # LaTeX / PDF dispatcher │ ├── bibtex_parser.py # BibTeX .bib parser │ ├── pdf_parser.py # PDF text extraction │ ├── verifier.py # Crossref / Semantic Scholar verification │ ├── matcher.py

594mo agoDiscuss

yoloshiiCLAUDE.md

gigaxity-deep-research

yoloshii/gigaxity-deep-research/CLAUDE.md

595mo agoReads credentialsDiscuss

blackwell-systemsCLAUDE.md

gcf

blackwell-systems/gcf/CLAUDE.md

paper 5. Commit all repos ### What NOT to update on every run - Whitepaper PDF on Zenodo (only republish for major changes) - LinkedIn/Reddit posts (they're snapshots in time) - Merge barriers

5252d agoDiscuss

glukicovCLAUDE.md

slideops

glukicov/slideops/CLAUDE.md

invariants, manifest versions uv run python scripts/smoke_test.py # render every slide, export and verify a PDF (needs Chromium) ``` Single test: `uv run pytest tests/test_freshness.py::test_a_deleted_file_reports_missing

5233d agoDiscuss

longbridgeCLAUDE.md

skills

longbridge/skills/CLAUDE.md

shouldn't try to) do inline — for example: - DOCX / XLSX / PDF generation (`python-docx`, `openpyxl`, etc.) - Chart generation with bilingual fonts (`matplotlib` + CJK font fallback) - A safety-gate runtime check

524mo agoDiscuss

ItMeDiaTechCLAUDE.md

rag-cli

ItMeDiaTech/rag-cli/CLAUDE.md

RecursiveCharacterTextSplitter from langchain - Add contextual headers (document title, section) - Support formats: MD, PDF, DOCX, HTML, TXT - Max file size: `MAX_FILE_SIZE_MB` (10 MB) ### 2. Embeddings (core/embeddings.py) - Model: sentence

5111mo agoReads credentialsDiscuss

jgouviergmailCLAUDE.md

LIA-Assistant

jgouviergmail/LIA-Assistant/CLAUDE.md

# CLAUDE.md This file provides guidance to Claude Code (claude.ai/code) when working with code

507mo agoReads credentialsDiscuss

zscalerCLAUDE.md

zscaler-mcp-server

zscaler/zscaler-mcp-server/CLAUDE.md

# Zscaler MCP Server 254 read tools (plus write tools, off by default) for managing

506mo agoReads credentialsDiscuss

aviz85CLAUDE.md

claude-skills-library

aviz85/claude-skills-library/CLAUDE.md

assets/`** - Static files (templates, images) ### Naming Conventions - Skill folder: `kebab-case` (e.g., `html-to-pdf`) - SKILL.md name field: same as folder name - Documentation page: `{skill-name}.html` ### Skills with

498mo agoReads credentialsDiscuss

ojspaceCLAUDE.md

md-anything

ojspace/md-anything/CLAUDE.md

source of truth for optional capability reporting. ```bash brew install poppler # pdftotext for stronger PDF extraction brew install tesseract # OCR for images brew install --cask calibre # ebook-convert for MOBI/AZW

4913d agoReads credentialsDiscuss

Aaryan-KapoorCLAUDE.md

Surface

Aaryan-Kapoor/Surface/.claude/claude.md

metadata.display_role` (`surface slot`). - Surfaces render from real routes with a `sandbox` iframe attr; PDF via SSRF-guarded `/proxy/pdf`; linked artifacts respect `SURFACE_LINK_ROOTS`. - `.env` has OPENROUTER and webhook

483mo agoReads credentialsDiscuss

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.