Skip to content

CLAUDE.md

CLAUDE.md is the quick-reference companion to AGENTS.md. While AGENTS.md provides comprehensive project context, CLAUDE.md gives Claude Code (and other AI assistants) a compact summary of principles, commands, and critical rules.

SectionPurpose
Core PrinciplesNumbered list of all 11 principles
Jimmy’s WorkflowQuick summary with phase diagram
Documentation NavigationHow to find and follow project docs
Template ComplianceHow to run audit checks
Critical RulesDo/don’t list for quick scanning
GitHub OperationsCommon gh CLI commands
Common CommandsProject-specific dev/test/build commands

AGENTS.md is the universal standard — any AI tool reads it. It’s comprehensive (600+ lines) with full project context, architecture, and troubleshooting.

CLAUDE.md is Claude Code-specific. It’s a compact (~125 lines) reference that:

  • Points to AGENTS.md as the authoritative source
  • Lists commands the AI can run immediately
  • Provides the critical rules at-a-glance
  • Includes template compliance audit triggers

Claude Code reads CLAUDE.md automatically on session start. Other AI tools read AGENTS.md. Both files work together.

CLAUDE.md includes a trigger pattern:

When user says “check templates” OR “check if we’re following the rules”:

  1. Read AGENTS.md first
  2. Follow the compliance audit workflow
  3. Execute audit-project.sh
  4. Generate a compliance report
  5. Offer remediation

This means saying “check templates” in a Claude Code session automatically triggers a full project audit.

CLAUDE.md has fewer placeholders than AGENTS.md. The main ones:

# Common Commands
[DEV_COMMAND] # e.g., bun run dev
[TEST_COMMAND] # e.g., bun test
[BUILD_COMMAND] # e.g., bun run build
[TYPECHECK_COMMAND] # e.g., bun run typecheck
[LINT_COMMAND] # e.g., bun run lint

Replace these with your project’s actual commands.

Terminal window
git clone https://github.com/ydun-code-library/Ydun_ai_workflow.git
cd Ydun_ai_workflow
cp templates/core/CLAUDE.md.template /path/to/your-project/CLAUDE.md
# Fill in [DEV_COMMAND], [TEST_COMMAND], etc.
# Verify: grep "\[.*COMMAND\]" CLAUDE.md