CLAUDE.md examples from real projects

How real projects brief Claude Code: the commands, conventions and warnings they put in CLAUDE.md.

Most stars first · from page 12Worked for most · soon

Hiding risky files

GitHubCLAUDE.md

gh-aw / engines

github/gh-aw/pkg/workflow/data/engines/claude.md

Shared engine configuration for Claude Code. -->

5.2k4mo agoDiscuss

awarexoneCLAUDE.md

This repo is a Claude Code plugin for professional bug bounty hunting across HackerOne, Bugcrowd, Intigriti, and Immunefi. Note: All commands are prefixed to avoid conflicts with Claude Code's built-in commands. /resume is a reserved Claude Code command — use /pickup to continue a previous hunt.

5.2k4mo agoDiscuss

VercelCLAUDE.md

examples / cms-sanity-graphql-fragments

vercel/examples/starter/cms-sanity-graphql-fragments/CLAUDE.md

No summary in the file. Open it to read it.

5.2k8mo agoDiscuss

entireioCLAUDE.md

cli

entireio/cli/CLAUDE.md

Go CLI built with Cobra and Charmbracelet Huh. AGENTS.md is a symlink to this file. Keep this entry point short: repo-wide rules and pointers, not command catalogs, implementation histories, or subsystem specifications. - cmd/entire/: entry point and external-command dispatch. - cmd/entire/cli/: Cobra commands, group roots, and CLI helpers. Group/verb files use <noun>group.go and <noun><verb>.go. - cmd/entire/cli/agent/: built-in agent integrations and external-agent protocol. - cmd/entire/cli/strategy/: manual-commit strategy and lifecycle/git hooks. - cmd/entire/cli/checkpoint/: ephemeral and persistent checkpoint storage. - cmd/entire/cli/session/: session state…

5.1k3mo agoDiscuss

clideyCLAUDE.md

whodb

clidey/whodb/CLAUDE.md

No summary in the file. Open it to read it.

5k7d agoDiscuss

PeonPingCLAUDE.md

peon-ping

PeonPing/peon-ping/CLAUDE.md

Developer guide for AI coding agents working on this codebase. For user-facing docs (install, configuration, CLI usage, sound packs, remote dev, mobile notifications), see README.md. There is no build step, linter, or formatter configured for the shell codebase. See RELEASING.md for the full release process (version bumps, tagging, Homebrew tap updates). peon-ping is part of the PeonPing org: IDE triggers hook → peon.sh reads JSON stdin → single Python call maps events to CESP categories (session.start, task.complete, input.required, user.spam, etc.)

5k6mo agoPipes a download into a shellDiscuss

RyanFitzgeraldCLAUDE.md

devportfolio

RyanFitzgerald/devportfolio/CLAUDE.md

This is a modern, minimalist portfolio template built with Astro and Tailwind CSS v4. It's designed to be easily customizable through a single configuration file while maintaining a clean, professional appearance. The project follows a component-based architecture with all customization centralized in src/config.ts: When modifying components: 1. Components read directly from the imported siteConfig object 2. Use Tailwind utility classes for styling 3. Maintain the existing monospace font aesthetic 4. Use Tabler Icons for consistency with existing icons The src/config.ts…

5k14mo agoDiscuss

NVIDIACLAUDE.md

Model-Optimizer / debugger

NVIDIA/Model-Optimizer/tools/debugger/CLAUDE.md

This directory contains a file-based command relay for executing commands inside a remote Docker container from the host machine (where Claude Code runs). The user must start the server inside Docker first: Then Claude Code performs the handshake:

5k7d agoDiscuss

NVIDIACLAUDE.md

Model-Optimizer / launcher

NVIDIA/Model-Optimizer/tools/launcher/CLAUDE.md

The launcher submits ModelOpt quantization, training, and evaluation jobs to Slurm clusters or runs them locally with Docker. The --yaml format maps top-level keys to launch() function arguments: Key conventions: 65 unit tests in tests/. Run standalone without installing modelopt: From the launcher directory: Tests cover: core dataclasses, factory registry, global_vars interpolation, YAML formats, Docker/Slurm executor construction (mocked), environment merging, metadata writing, and end-to-end Docker launch via subprocess.

5k7d agoDiscuss

MicrosoftCLAUDE.md

poml

microsoft/poml/CLAUDE.md

POML (Prompt Orchestration Markup Language) is a structured markup language for advanced prompt engineering with LLMs. It provides an HTML-like syntax with semantic components, comprehensive data handling, and a CSS-like styling system. The project consists of: The core POML processor is built with TypeScript and React:

5k13mo agoDiscuss

MicrosoftCLAUDE.md

poml / poml-browser

microsoft/poml/packages/poml-browser/CLAUDE.md

This file provides guidance to Claude Code when working with the POML browser extension package. The POML Browser Extension (packages/poml-browser/) provides POML support in web browsers through a Chrome extension. It enables users to extract content from web pages, manage it as cards, and convert it to POML format. Important notes on building and testing for Claude: As developers usually run a long-running watch process, please do not emit build commands by yourself. Do not run tests on your own.…

5k13mo agoDiscuss

MicrosoftCLAUDE.md

FluidFramework

microsoft/FluidFramework/.claude/CLAUDE.md

This file is mirrored in .github/copilot-instructions.md. Changes here should be duplicated there, and vice versa. Follow the Coding Guidelines when writing / modifying code. Follow the Documentation Guidelines when writing or modifying code or documentation. Read and follow the linked guides relevant to the task, including the language-specific guides for source-code documentation. These requirements apply to source-code comments and API documentation as well as standalone documentation. Add a changeset for user-facing changes only if the affected release group uses changesets.…

4.9k56d agoDiscuss

MicrosoftCLAUDE.md

FluidFramework / gitrest

microsoft/FluidFramework/server/gitrest/CLAUDE.md

GitRest provides a REST API to Git repositories, modeled after GitHub's REST APIs. It is part of the Fluid Framework server infrastructure. Endpoints follow the GitHub API pattern:

4.9k56d agoDiscuss

MicrosoftCLAUDE.md

FluidFramework / historian

microsoft/FluidFramework/server/historian/CLAUDE.md

Historian is a service that tracks the historical record for a Fluid document. It acts as a proxy to the underlying git repository that maintains versioned snapshots. This is a release group root with two packages: Runtime config is in packages/historian/config.json and loaded via nconf.

4.9k56d agoDiscuss

Agenta-AICLAUDE.md

agenta

Agenta-AI/agenta/CLAUDE.md

Please read and follow all instructions in: Project conventions, guidelines, and best practices are documented there.

4.8k2mo agoDiscuss

jakubkrehelCLAUDE.md

skills

jakubkrehel/skills/CLAUDE.md

Everything about this repository lives in one place: what it is, how skills are structured, which skill owns which rule and the authoring conventions. Read it before changing anything under skills/. Nothing in this file duplicates it; when a repository fact changes, change it there.

4.8k32d agoDiscuss

formkitCLAUDE.md

formkit

formkit/formkit/CLAUDE.md

Vue.js form building library. Monorepo with framework-agnostic core and Vue-specific integration. Node tree: Every <FormKit> component owns a node (packages/core/src/node.ts). Three node types: - input: single value (scalar, object, or array) - group: children as object (keys = child names). <FormKit type="form"> is a group. - list: children as array Schema: JSON-serializable data format for DOM/component structures. Rendered via <FormKitSchema>. Four node types: - Text: plain strings - $el: HTML elements ({ $el: 'div', attrs: {}, children: [] }) -…

4.8k10mo agoDiscuss

conorbronsdonCLAUDE.md

avoid-ai-writing

conorbronsdon/avoid-ai-writing/CLAUDE.md

A directory-based writing skill (SKILL.md plus references/patterns.md) that audits and rewrites content to remove AI writing patterns. The skill is a markdown file consumed by AI coding assistants; the repository also includes a dependency-free deterministic detector and test suite. Edit SKILL.md and references/patterns.md directly. When making changes: The skill has three modes (rewrite default, detect flag-only, edit in-place) and processes text through this pipeline:

4.7k27d agoDiscuss

eugeniughelburCLAUDE.md

obsidian-second-brain

eugeniughelbur/obsidian-second-brain/CLAUDE.md

Operating instructions for Claude Code when working inside this repo. This is the source repo for obsidian-second-brain, a Claude Code skill that turns any Obsidian vault into a living AI-first second brain. The skill ships 47 slash commands across 4 layers (vault management, thinking tools, research toolkit, scheduled agents). If you are Claude operating on a user's vault, you want _CLAUDE.md inside their vault, not this file. This file is for working on the skill's source code. Source files in…

4.6k2mo agoDiscuss

JetBrainsCLAUDE.md

koog / a2a

JetBrains/koog/a2a/CLAUDE.md

The A2A (Agent-to-Agent) module is a meta-module within the larger Koog project that implements a comprehensive client and server library for the A2A protocol, a standardized communication protocol for AI agents based on the specification at https://a2a-protocol.org/latest/specification/. Important: Since this is a meta-module inside a bigger root project, the Gradle wrapper executable is located one directory up. All Gradle commands must use ../gradlew when running from the a2a directory.

4.6k5mo 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.