agentleFS

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 15Worked for most · soon
corsairdevCLAUDE.md

corsair

corsairdev/corsair/CLAUDE.md

docs/pr-review-bot.md`). ## Commands - `pnpm lint` / `pnpm lint:fix` (biome), `pnpm typecheck`, `pnpm build`, `pnpm test` - `pnpm generate:plugin` — scaffold a new plugin (correct footprint: its own package + one registration edit

No other project uses it yet

16k3mo agoReviewMountCreate a free account to mount
k2-fsaCLAUDE.md

sherpa-onnx

k2-fsa/sherpa-onnx/CLAUDE.md

Build CMake project; the root `CMakeLists.txt` options are `SHERPA_ONNX_*` (e.g. `SHERPA_ONNX_ENABLE_TESTS`, `SHERPA_ONNX_ENABLE_PYTHON`, `SHERPA_ONNX_ENABLE_GPU`, `SHERPA_ONNX_ENABLE_TTS`, `SHERPA_ONNX_ENABLE

16k6mo agoReviewMountCreate a free account to mount
CoplayDevCLAUDE.md

unity-mcp

CoplayDev/unity-mcp/CLAUDE.md

enables AI-driven game development workflows - creating GameObjects, editing scripts, managing assets, running tests, and more. ## Architecture ```text AI Assistant (Claude/Cursor) ↓ MCP Protocol (stdio/HTTP) Python Server (Server/src/) ↓ WebSocket + HTTP Unity

No other project uses it yet

16k10mo agoReviewMountCreate a free account to mount
gpujsReads credentialsCLAUDE.md

gpu.js

gpujs/gpu.js/CLAUDE.md

something recent within 22. `npm run make` runs build → beautify → minify → build-tests, from plain Node scripts in `scripts/`. It rewrites `dist/` and regenerates `test/all.html`, so run it before anything

No other project uses it yet

15k3mo agoReviewMountCreate a free account to mount
mauriceboeReads credentialsCLAUDE.md

NOMAD

mauriceboe/NOMAD/CLAUDE.md

files, exports, types, deps may only shrink against scripts/ci/knip-baseline.json (CI gate; --update lowers it) ``` Tests: ```bash npm run test # all workspaces npm run test --workspace=server # vitest run (server); also

15k4mo agoReviewMountCreate a free account to mount
mauriceboeCLAUDE.md

NOMAD / client

mauriceboe/NOMAD/client/CLAUDE.md

count per rule above scripts/eslint-baseline.json and on any entry above its count (app code, tests and eslint-disable'd messages counted apart; a `/* eslint : ... */` config comment fails outright; --update lowers

15k4mo agoReviewMountCreate a free account to mount
mauriceboeCLAUDE.md

NOMAD / plugin-sdk

mauriceboe/NOMAD/plugin-sdk/CLAUDE.md

build + tsc CJS build + scripts/finish-cjs.mjs npm run typecheck # tsc --noEmit (CI) npm test # vitest run npm run test:coverage # what CI runs (feeds the Sonar new-code coverage gate

15k4mo agoReviewMountCreate a free account to mount
mauriceboeReads credentialsCLAUDE.md

NOMAD / server

mauriceboe/NOMAD/server/CLAUDE.md

below) npm run typecheck # tsc --noEmit — the real type gate npm run typecheck:tests # tsc over tests/ — CI runs this too; vitest green does NOT mean typed mocks compile

15k4mo agoReviewMountCreate a free account to mount
mauriceboeCLAUDE.md

NOMAD / shared

mauriceboe/NOMAD/shared/CLAUDE.md

lint:format # Prettier outside scripts/format-baseline.json, which only shrinks (lint-prettier.yml) npm run test # vitest run — co-located *.spec.ts files npm run i18n:parity # audit locale drift, exits 0 npm run i18n

15k4mo agoReviewMountCreate a free account to mount
Bash-itCLAUDE.md

bash-it

Bash-it/bash-it/CLAUDE.md

THEME is set) 5. Custom files from BASH_IT_CUSTOM directory ## Development Commands ### Testing ```bash # Run all tests using BATS (Bash Automated Testing System) test/run # Run specific test suites test/run

15k13mo agoReviewMountCreate a free account to mount
storytoldDeletes or force-pushesCLAUDE.md

lightcraft

storytold/lightcraft/CLAUDE.md

panic path, and fix a crash before building on top of it. - **Non-test code never panics:** no `unwrap()`, `expect()`, `panic!`, `unreachable!`, `todo!`, `unimplemented!`, and no `unsafe`. Return the crate

15k1d agoReviewMountCreate a free account to mount
apexchartsCLAUDE.md

apexcharts.js

apexcharts/apexcharts.js/CLAUDE.md

truth is `src/` and `samples/source/`. - Pipe noisy command output through `tail`, `head` or `grep` (test runs, builds, `git log`). Report failures, not full passing logs. - Screenshots: crop or downscale before

15k3y agoReviewMountCreate a free account to mount
grokabilityReads credentialsCLAUDE.md

snipe-it

grokability/snipe-it/CLAUDE.md

writing a new one. ## Verification Scripts - Do not create verification scripts or tinker when tests cover that functionality and prove they work. Unit and feature tests are more important. ## Application

Steady15 mentions in 2 weeks

No other project uses it yet

15k13mo agoReviewMountCreate a free account to mount
yusufkaraaslanReads credentialsCLAUDE.md

Skill_Seekers

yusufkaraaslan/Skill_Seekers/CLAUDE.md

phases done; remaining cosmetic items listed there). ## Essential Commands ```bash # REQUIRED before running tests or CLI (src/ layout) pip install -e . # Run all tests (NEVER skip - all must pass before

15k13mo agoReviewMountCreate a free account to mount
NVIDIACLAUDE.md

TensorRT-LLM / agent-flow

NVIDIA/TensorRT-LLM/agent-flow/CLAUDE.md

command to make sure that there are no style issue. * Always add tests when adding new features, and always make sure that all test cases can pass before committing

15k3mo agoReviewMountCreate a free account to mount
Usagi-orgReads credentialsCLAUDE.md

ai-goofish-monitor

Usagi-org/ai-goofish-monitor/CLAUDE.md

自定义配置文件 ``` ## 测试 ```bash pytest # 运行所有测试 pytest --cov=src # 覆盖率报告 pytest tests/unit/test_utils.py # 运行单个测试文件 pytest tests/unit/test_utils.py::test_safe_get # 运行单个测试函数 ``` 测试规范:文件 `tests/**/test_*.py`,函数 `test_*` ## 配置 环境变量 (`.env`): - AI 模型

15k24d agoReviewMountCreate a free account to mount
xcanwinCLAUDE.md

KeepChatGPT

xcanwin/KeepChatGPT/CLAUDE.md

开发模式:HTTP 服务(8888) + Jest watch 同时运行 npm run dev # 单次运行测试(CI / 快速验证) npm test # 检查当前脚本版本号 rg "^// @version" KeepChatGPT.user.js # 更新多语言文本输出(产物写入 temp/lang.txt) python3 tools/kcg_i18n.py # 生成 CDN 图片链接版 README(产物写入 temp/README_CDN.md

15k4mo agoReviewMountCreate a free account to mount
mindfold-aiCLAUDE.md

Trellis

mindfold-ai/Trellis/CLAUDE.md

YOUR changes made unused. - Don't remove pre-existing dead code unless asked. The test: Every changed line should trace directly to the user's request. ## 4. Goal-Driven Execution

15k51d agoReviewMountCreate a free account to mount
MicrosoftCLAUDE.md

playwright-cli

microsoft/playwright-cli/CLAUDE.md

Build and test The CLI source lives in `microsoft/playwright`, in `packages/playwright-core/src/tools/`. This repo ships `@playwright/cli`: `playwright-cli.js` runs the CLI of the `playwright-core` alpha that `package.json` pins, and adds

15k7mo agoReviewMountCreate a free account to mount
d2phapCLAUDE.md

ImageGlass / source

d2phap/ImageGlass/source/CLAUDE.md

CsWin32 code generation. - Avoid reflection-based serialization; use custom JSON converters in `Common/Types/JsonTypeConverters/`. - Test AOT builds: `dotnet publish ImageGlass.Win32 -c Release` produces a self-contained, trimmed executable. ### 2. Thread-Safety

15k12mo agoReviewMountCreate a free account to mount
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.