Skip to content

QUICKREF.md

Latest commit

 

History

History
158 lines (127 loc) · 5.14 KB

QUICKREF.md

File metadata and controls

158 lines (127 loc) · 5.14 KB

CLAUDE.md Builder Quick Reference

Essential commands and patterns for immediate use. All commands work in natural language.

Core Commands

Command What It Does Example
"analyze patterns" Extract reusable components from CLAUDE.md files "analyze patterns in this example"
"create template" Generate domain-specific CLAUDE.md "create template for web development"
"optimize context" Reduce token usage and improve efficiency "optimize this CLAUDE.md for token efficiency"
"validate setup" Run sanity checks and effectiveness tests "validate CLAUDE.md effectiveness"
"generate library" Build pattern collections from multiple examples "generate pattern library from these files"

Template Creation Commands

Domain Command Result
Web Development "create template for web development" Frontend/backend patterns, testing, deployment
Automation "create template for automation scripts" Task workflows, error handling, logging
Research "create template for research assistant" Information gathering, analysis, documentation
DevOps "create template for devops workflows" Infrastructure, monitoring, deployment
Data Science "create template for data analysis" Data processing, visualization, modeling

Pattern Analysis Commands

Type Command What You Get
Structure "analyze structure patterns" Organization, hierarchy, modular design
Commands "analyze command patterns" Natural language to technical mappings
Context "analyze context patterns" File references, import strategies
Validation "analyze validation patterns" Sanity checks, effectiveness tests
Optimization "analyze optimization patterns" Token efficiency, performance improvements

Common Requests

Building New CLAUDE.md

  • "create simple CLAUDE.md for [project type]"
  • "design command system for [specific use case]"
  • "generate complete CLAUDE.md with validation"
  • "build template with import system"

Improving Existing CLAUDE.md

  • "optimize this CLAUDE.md for efficiency"
  • "improve instruction adherence"
  • "add validation checkpoints"
  • "enhance parallel execution"

Learning and Analysis

  • "explain why this pattern works"
  • "show me best practices for [domain]"
  • "compare these CLAUDE.md approaches"
  • "extract common patterns from examples"

Advanced Features

  • "add hooks integration"
  • "design slash command system"
  • "create team collaboration patterns"
  • "build MCP integration"

Quick Pattern Snippets

Basic Identity Pattern

# My name is [PROJECT]_Assistant
## Rules
- **IMPERATIVE**: [PRIMARY_BEHAVIOR]
- **CRITICAL**: [SECONDARY_BEHAVIOR]
- **IMPORTANT**: [TERTIARY_BEHAVIOR]

Command Translation Pattern

## Commands
- "test" → `npm test`
- "build" → `npm run build` 
- "dev" → `npm run dev`

Validation Pattern

## Checkpoint
"What is my name?" → [PROJECT]_Assistant

Import Pattern

@package.json for dependencies
@README.md for project overview
@~/.claude/personal-prefs.md for individual settings

File Organization Patterns

Simple Project

# My name is ProjectAssistant
@package.json @README.md
## Rules + Commands + Validation

Team Project

# Team StandardsAssistant  
@team-standards.md
@~/.claude/personal-prefs.md
## Shared rules + Individual overrides

Complex Project

# DomainExpert
@core-rules.md
@domain-patterns.md
@project-config.md
## Modular + Hierarchical + Extensible

Troubleshooting Commands

Problem Command Solution
Instructions ignored "validate instruction adherence" Test and fix priority issues
Poor performance "optimize token usage" Reduce context size
Inconsistent behavior "add validation checkpoints" Systematic testing
Team conflicts "design team standards" Shared configuration patterns

Advanced Integration

MCP Integration

  • "add database MCP patterns"
  • "integrate external API access"
  • "enable MCP tool chaining"

Hooks Integration

  • "add automated formatting hooks"
  • "create security validation hooks"
  • "design workflow automation"

Slash Commands

  • "create project slash commands"
  • "design personal command shortcuts"
  • "build command translation system"

Reference Quick Links

  • CLAUDE.md: Complete meta-builder with all patterns, import system, hooks, and commands inline
  • examples/: Complete working CLAUDE.md files for different domains
  • patterns/: Specialized advanced template components
  • claude-md-complete-examples.md: Advanced system templates and examples

Pro Tips

  1. Start Simple: Use basic patterns, add complexity gradually
  2. Copy-Paste First: Use existing patterns as starting points
  3. Validate Early: Test instruction adherence frequently
  4. Optimize Later: Get working version first, then optimize
  5. Team Coordination: Use import system for shared standards