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.

Worked for most · soon

Known publishers Hiding risky files

MongoDBCLAUDE.md

tines-claude

mongodb/tines-claude/CLAUDE.md

When the MCP server is connected, prefer using MCP tools over raw curl API calls.

28mo agoReviewMount

PostHogCLAUDE.md

Housekeeper is an MCP-first application: by default it runs an HTTP MCP server (streamable HTTP transport) that gives AI assistants read-only access to ClickHouse and Prometheus/Victoria Metrics, plus an optional in-account LLM diagnosis tool. With --analyze, runs a one-shot Gemini-based error analysis (agent.go, slack.go, clickhouse.go) and posts to Slack. Legacy; not used in MCP server deployments. Priority: CLI flags > env vars > config file > defaults. Notable keys beyond connection params: The server is deployment-agnostic: everything operator-facing is set…

252d agoReviewMount

StripeCLAUDE.md

hark

stripe/hark/.claude/CLAUDE.md

A Go CLI that validates and compiles markdown changefiles (.change.md) into a unified changelog. Used across Stripe SDK repos, both as a standalone CLI and as a Go dependency. Module: github.com/stripe/hark changefile/ and releases/ are the public API — other Go code imports them, so treat their names and signatures as a compatibility surface. cmd/ is not: the CLI is not meant to be embedded, and exports only Execute. The paths hark uses are hardcoded, not configurable: .hark/releases.json, .hark/changes/*.change.md, .hark/intros/intro-<version>.md,…

22mo agoReviewMount

VercelCLAUDE.md

dx0

vercel-labs/dx0/.claude/CLAUDE.md

This project uses Ultracite, a zero-config preset that enforces strict code quality standards through automated formatting and linting. Oxlint + Oxfmt (the underlying engine) provides robust linting and formatting. Most…

29mo agoReviewMount

Microsoft AzureCLAUDE.md

kcl-azure-pipelines

Azure/kcl-azure-pipelines/CLAUDE.md

This document describes the coding conventions and patterns used in this repository for implementing Azure Pipelines schemas in KCL. Don't use relative imports: For file-level documentation (especially for types): Pattern: type Name = SimpleForm | ComplexForm | ... Don't create separate schemas for identical structures:

19mo agoReviewMount

Microsoft AzureCLAUDE.md

sap-automation-gh-bootstrap

Azure/sap-automation-gh-bootstrap/CLAUDE.md

@.github/copilot-instructions.md

13mo agoReviewMount

ElasticCLAUDE.md

esql-dotnet

elastic/esql-dotnet/CLAUDE.md

This project follows strict C# coding standards. All code must adhere to these guidelines. Every .cs file must start with: These are error-level requirements:

110mo agoReviewMount

SentryCLAUDE.md

n8n-nodes-sentry

getsentry/n8n-nodes-sentry/CLAUDE.md

This is an n8n community node package for integrating Sentry with n8n workflows. The package provides a custom node that sends structured log messages to Sentry using the official @sentry/node SDK. It follows the n8n node development standards and uses TypeScript with strict type checking. The Sentry node allows users to send structured logs from n8n workflows to Sentry. Features include: - Configurable Sentry DSN (Data Source Name) - Support for all Sentry log levels: trace, debug, info, warn, error,…

113mo agoReviewMount

SentryCLAUDE.md

sentry-build-academy-guide

getsentry/sentry-build-academy-guide/CLAUDE.md

This is an Astro Starlight documentation site for the Sentry Build Academy workshop. The site teaches developers how to implement comprehensive observability with Sentry in fullstack JavaScript applications using Vite…

118mo agoReviewMount

SentryCLAUDE.md

sentry-build-ai-workshop-guide

getsentry/sentry-build-ai-workshop-guide/CLAUDE.md

116mo agoReviewMount

JetBrainsCLAUDE.md

jcp-cli

JetBrains/jcp-cli/CLAUDE.md

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

19mo agoReviewMount

JetBrainsCLAUDE.md

teamcity-oidc-auth-plugin

JetBrains/teamcity-oidc-auth-plugin/CLAUDE.md

TeamCity API JARs are resolved from https://download.jetbrains.com/teamcity-repository. No local TeamCity installation is required to compile or test. This is a TeamCity server-side plugin that adds OIDC authentication. It is not…

14mo agoReviewMount

MicrosoftCLAUDE.md

m365-copilot-studio-what-to-build-where

microsoft/m365-copilot-studio-what-to-build-where/CLAUDE.md

Static Astro + strict TypeScript. Read README.md before source changes. Use npm run check, npm test, and targeted Playwright tests. Do not publish or create a GitHub repository without the user's request. This is a folder-backed app session with a local Git repository. - State guidance and caveats directly. Avoid rhetorical "this is X, not Y" phrasing; retain explicit factual limitations where they affect a decision. - Use informative, formal headings and labels. Avoid slogans, clever phrasing, and marketing-style copy…

132d agoReviewMount

MicrosoftCLAUDE.md

read_for_you

microsoft/read_for_you/CLAUDE.md

Read for You is a web application that extracts text and multimedia content from PDF documents using Azure Document Intelligence (Intelligent OCR), displays them in an accessible format, and provides text-to-speech (TTS) capabilities for reading aloud. Configure these in frontend/read_for_you/src/constants.js: Backend service URLs in backend/read_for_you/settings.py: Critical: The TTS implementation uses a sophisticated strategy documented in frontend/read_for_you/docs/TTS_Strategy.md. Key features: State management (ReadingPage.vue): - audioMap: Map storing elementIndex → audioBlob - isLoadingAudio: Loading state for UI feedback - hasUsedTTS: Tracks if user…

112mo agoReviewMount

PostHogCLAUDE.md

terraform-aws-sso-elevator

PostHog/terraform-aws-sso-elevator/CLAUDE.md

Always run these commands before committing changes: Terraform module that deploys AWS Lambda functions for just-in-time AWS SSO access management via Slack. Two access models exist: account access (temporary permission set assignment on AWS accounts) and group access (temporary SSO group membership). Config & Models: - config.py — Loads config from S3 (load_approval_config_from_s3), parses into Statement/GroupStatement via parse_statement/parse_group_statement. Config is a Pydantic BaseSettings singleton with frozenset fields for statements, accounts, groups, permission_sets. - statement.py — BaseStatement (has permission_set, required_group_membership, etc.)…

17mo agoReviewMount

StripeCLAUDE.md

stripe-commercetools-tax-app

stripe/stripe-commercetools-tax-app/CLAUDE.md

Client-owned Stripe Tax connector for commercetools. Deploys two independent CT Connect applications from a single connect.yaml: tax-calculator (service) and order-syncer (event handler). They do not call each other and can be deployed, operated, and read about independently — each has its own context/ and CLAUDE.md. Read the specific module's CLAUDE.md and context/ARCHITECTURE.md before working on it — there is no shared context between the two modules, so reading one does not give you knowledge of the other.

14mo agoReviewMount

SupabaseCLAUDE.md

instantdb-to-supabase

supabase/instantdb-to-supabase/CLAUDE.md

Follow AGENTS.md.

110d agoReviewMount

Microsoft AzureCLAUDE.md

AKSInvestigator

Azure/AKSInvestigator/CLAUDE.md

AKS-flavored fork of the HolmesGPT Helm chart. This repo contains Helm/deployment, model packaging, and a native kubectl CLI wrapper, not the HolmesGPT runtime application source. HolmesGPT itself lives upstream; this repo packages and deploys it for AKS with AKS-specific add-ons layered on top. The kubectl plugin invokes Holmes inside the cluster; it is not a local HolmesGPT runtime. The model-image Dockerfile is build packaging for model files and copy tools, not a new runtime application. helm/ is synced from the…

052d agoReviewMount

Microsoft AzureCLAUDE.md

aks-traffic-ingress-competitive-testing

Azure/aks-traffic-ingress-competitive-testing/CLAUDE.md

This is a load-testing framework for comparing Kubernetes ingress controllers (nginx via Ingress, Istio via Gateway API). It orchestrates: spin up a Kind cluster → install a traffic controller → deploy a backend server via Helm → run vegeta load tests → collect JSON results → tear down. master.sh handles everything including cleanup (via EXIT trap). Requires kubectl, helm, jq, and curl on the host. scripts/master.sh is the single entry point that orchestrates these steps in order: Each module under…

06mo agoReviewMount

BlockCLAUDE.md

proto-distro / hermit-packages

block/proto-distro/bin/hermit-packages/CLAUDE.md

This directory contains custom Hermit package definitions for tools not available in the official Hermit registry. Hermit is a tool manager that provides consistent, reproducible tool versions across development environments. Follow these steps to create a new Hermit package for tools that publish binaries to GitHub releases: Create a new .hcl file named after the tool (e.g., mytool.hcl) with this structure: CRITICAL: When initially creating the package file: - The sha256sums field must be present but empty: sha256sums = {}…

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