agentleFS
Sign inSign up

CLAUDE.md examples from real projects

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

Popular:code reviewtestingpdfMCP serverfrontendsecuritydocumentation
Most stars firstWorked for most · soon
GitHub remove filter
GitHubCLAUDE.md

gh-aw / engines

github/gh-aw/docs/src/content/docs/engines/claude.md

Select and authenticate Claude Code as the AI engine for GitHub Agentic Workflows, understand its capabilities and limitations, and start from an example.

5.2k4mo agoReads credentialsDiscuss
GitHubCLAUDE.md

gh-aw / engines

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

Shared engine configuration for Claude Code. -->

5.2k4mo agoDiscuss
GitHubCLAUDE.md

gh-aw-firewall

github/gh-aw-firewall/CLAUDE.md

awf (Agentic Workflow Firewall, package @github/awf) is a CLI that wraps any command in a sandboxed Docker network. It provides L7 (HTTP/HTTPS) egress control using Squid proxy, restricting network access to a whitelist of approved domains while giving the agent access to the host workspace and selected system paths via chroot and selective bind mounts. The system is orchestrated by src/cli.ts and managed by src/docker-manager.ts. Squid, the primary agent, and the general API proxy are the baseline services; private-repository enclaves…

1463d agoDiscuss
GitHubCLAUDE.md

gh-aw-threat-detection

github/gh-aw-threat-detection/CLAUDE.md

gh-aw-threat-detection is the threat detection component for GitHub Agentic Workflows (gh-aw). It is a Go CLI (threat-detect) that analyzes artifacts produced by AI agents — prompts, agent output, git patches, comment memory — and decides whether to allow or block the downstream safe-outputs job. The component runs in two main contexts: It detects three categories: prompt injection, secret leak, and malicious patch, and emits a strict JSON contract. Run these from the repo root. They are the canonical entry points…

1412d agoReads credentialsDiscuss
GitHubCLAUDE.md

gh-aw-harness

github/gh-aw-harness/CLAUDE.md

gh-aw-threat-detection is the threat detection component for GitHub Agentic Workflows (gh-aw). It is a Go CLI (threat-detect) that analyzes artifacts produced by AI agents — prompts, agent output, git patches, comment memory — and decides whether to allow or block the downstream safe-outputs job. The component runs in two main contexts: It detects three categories: prompt injection, secret leak, and malicious patch, and emits a strict JSON contract. Run these from the repo root. They are the canonical entry points…

34mo agoReads credentialsDiscuss

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.