diff --git a/01-slash-commands/README.md b/01-slash-commands/README.md index 656e3ba..aba26b2 100644 --- a/01-slash-commands/README.md +++ b/01-slash-commands/README.md @@ -404,10 +404,10 @@ Access with: `/deploy/production`, `/test/unit`, `/docs/api` ## Related Concepts -- **[Subagents](../02-subagents/)** - For complex, delegated tasks -- **[Memory](../03-memory/)** - For persistent context -- **[Skills](../05-skills/)** - For auto-invoked capabilities -- **[Plugins](../06-plugins/)** - For bundled command collections +- **[Memory](../02-memory/)** - For persistent context +- **[Skills](../03-skills/)** - For auto-invoked capabilities +- **[Subagents](../04-subagents/)** - For complex, delegated tasks +- **[Plugins](../07-plugins/)** - For bundled command collections ## Resources diff --git a/03-memory/README.md b/02-memory/README.md similarity index 98% rename from 03-memory/README.md rename to 02-memory/README.md index 3d10fc4..40e65b8 100644 --- a/03-memory/README.md +++ b/02-memory/README.md @@ -533,9 +533,9 @@ graph LR - [Memory Hierarchy](./examples/) ### Integration Points -- [MCP Protocol](../04-mcp/) - Live data access alongside memory -- [Slash Commands](../02-slash-commands/) - Session-specific shortcuts -- [Skills](../05-skills/) - Automated workflows with memory context +- [MCP Protocol](../05-mcp/) - Live data access alongside memory +- [Slash Commands](../01-slash-commands/) - Session-specific shortcuts +- [Skills](../03-skills/) - Automated workflows with memory context ### Best Practices - [Code Organization](./examples/) diff --git a/03-memory/directory-api-CLAUDE.md b/02-memory/directory-api-CLAUDE.md similarity index 100% rename from 03-memory/directory-api-CLAUDE.md rename to 02-memory/directory-api-CLAUDE.md diff --git a/03-memory/memory-ask-claude.png b/02-memory/memory-ask-claude.png similarity index 100% rename from 03-memory/memory-ask-claude.png rename to 02-memory/memory-ask-claude.png diff --git a/03-memory/memory-saved.png b/02-memory/memory-saved.png similarity index 100% rename from 03-memory/memory-saved.png rename to 02-memory/memory-saved.png diff --git a/03-memory/personal-CLAUDE.md b/02-memory/personal-CLAUDE.md similarity index 100% rename from 03-memory/personal-CLAUDE.md rename to 02-memory/personal-CLAUDE.md diff --git a/03-memory/project-CLAUDE.md b/02-memory/project-CLAUDE.md similarity index 100% rename from 03-memory/project-CLAUDE.md rename to 02-memory/project-CLAUDE.md diff --git a/05-skills/README.md b/03-skills/README.md similarity index 99% rename from 05-skills/README.md rename to 03-skills/README.md index 0f71e71..39632a1 100644 --- a/05-skills/README.md +++ b/03-skills/README.md @@ -615,7 +615,7 @@ const users = fetchUsersWithPosts(); // 1 query **File:** `.claude/skills/brand-voice/SKILL.md` -```yaml +```md --- name: Brand Voice Consistency description: Ensure all communication matches brand voice and tone guidelines @@ -681,7 +681,6 @@ Help teams automate their development workflows with AI - "Leverage" (corporate-speak) - "Utilize" (use "use") - "Paradigm shift" (unclear) -``` **Good Example:** "Claude automates your code review process. Instead of manually checking each PR, Claude reviews security, performance, and qualityβ€”saving your team hours every week." @@ -693,6 +692,8 @@ Why it works: Clear value, specific benefits, action-oriented Why it doesn't work: Vague, corporate jargon, no specific value +``` + **Template:** `email-template.txt` ``` @@ -741,7 +742,7 @@ Educational blog post: **File:** `.claude/skills/doc-generator/SKILL.md` -```yaml +```md --- name: API Documentation Generator description: Generate comprehensive, accurate API documentation from source code @@ -767,8 +768,7 @@ when_to_use: When creating or updating API documentation ## Documentation Structure ### For Each Endpoint - -```markdown + ## GET /api/v1/users/:id ### Description @@ -781,50 +781,41 @@ Brief explanation of what this endpoint does | id | string | Yes | User ID | ### Response - **200 Success** -```json + { "id": "usr_123", "name": "John Doe", "email": "john@example.com", "created_at": "2025-01-15T10:30:00Z" } -``` **404 Not Found** -```json + { "error": "USER_NOT_FOUND", "message": "User does not exist" } -``` ### Examples **cURL** -```bash curl -X GET "https://api.example.com/api/v1/users/usr_123" \ -H "Authorization: Bearer YOUR_TOKEN" -``` **JavaScript** -```javascript const user = await fetch('/api/v1/users/usr_123', { headers: { 'Authorization': 'Bearer token' } }).then(r => r.json()); -``` **Python** -```python response = requests.get( 'https://api.example.com/api/v1/users/usr_123', headers={'Authorization': 'Bearer token'} ) user = response.json() + ``` -``` - **Python Script:** `.claude/skills/doc-generator/scripts/generate-docs.py` ```python diff --git a/05-skills/brand-voice/SKILL.md b/03-skills/brand-voice/SKILL.md similarity index 100% rename from 05-skills/brand-voice/SKILL.md rename to 03-skills/brand-voice/SKILL.md diff --git a/05-skills/brand-voice/templates/email-template.txt b/03-skills/brand-voice/templates/email-template.txt similarity index 100% rename from 05-skills/brand-voice/templates/email-template.txt rename to 03-skills/brand-voice/templates/email-template.txt diff --git a/05-skills/brand-voice/templates/social-post-template.txt b/03-skills/brand-voice/templates/social-post-template.txt similarity index 100% rename from 05-skills/brand-voice/templates/social-post-template.txt rename to 03-skills/brand-voice/templates/social-post-template.txt diff --git a/05-skills/brand-voice/tone-examples.md b/03-skills/brand-voice/tone-examples.md similarity index 100% rename from 05-skills/brand-voice/tone-examples.md rename to 03-skills/brand-voice/tone-examples.md diff --git a/05-skills/code-review/SKILL.md b/03-skills/code-review/SKILL.md similarity index 100% rename from 05-skills/code-review/SKILL.md rename to 03-skills/code-review/SKILL.md diff --git a/05-skills/code-review/scripts/analyze-metrics.py b/03-skills/code-review/scripts/analyze-metrics.py similarity index 100% rename from 05-skills/code-review/scripts/analyze-metrics.py rename to 03-skills/code-review/scripts/analyze-metrics.py diff --git a/05-skills/code-review/scripts/compare-complexity.py b/03-skills/code-review/scripts/compare-complexity.py similarity index 100% rename from 05-skills/code-review/scripts/compare-complexity.py rename to 03-skills/code-review/scripts/compare-complexity.py diff --git a/05-skills/code-review/templates/finding-template.md b/03-skills/code-review/templates/finding-template.md similarity index 100% rename from 05-skills/code-review/templates/finding-template.md rename to 03-skills/code-review/templates/finding-template.md diff --git a/05-skills/code-review/templates/review-checklist.md b/03-skills/code-review/templates/review-checklist.md similarity index 100% rename from 05-skills/code-review/templates/review-checklist.md rename to 03-skills/code-review/templates/review-checklist.md diff --git a/05-skills/doc-generator/SKILL.md b/03-skills/doc-generator/SKILL.md similarity index 100% rename from 05-skills/doc-generator/SKILL.md rename to 03-skills/doc-generator/SKILL.md diff --git a/05-skills/doc-generator/generate-docs.py b/03-skills/doc-generator/generate-docs.py similarity index 100% rename from 05-skills/doc-generator/generate-docs.py rename to 03-skills/doc-generator/generate-docs.py diff --git a/02-subagents/README.md b/04-subagents/README.md similarity index 98% rename from 02-subagents/README.md rename to 04-subagents/README.md index aacc1d9..6c1dd3a 100644 --- a/02-subagents/README.md +++ b/04-subagents/README.md @@ -719,10 +719,10 @@ Main Agent receives: "Build a new authentication feature" ### Related Features - **[Slash Commands](../01-slash-commands/)** - Quick user-invoked shortcuts -- **[Memory](../03-memory/)** - Persistent cross-session context -- **[MCP Protocol](../04-mcp-protocol/)** - Real-time external data access -- **[Agent Skills](../05-agent-skills/)** - Reusable autonomous capabilities -- **[Plugins](../06-plugins/)** - Bundled extension packages +- **[Memory](../02-memory/)** - Persistent cross-session context +- **[MCP Protocol](../05-mcp/)** - Real-time external data access +- **[Skills](../03-skills/)** - Reusable autonomous capabilities +- **[Plugins](../07-plugins/)** - Bundled extension packages ### Comparison with Other Features @@ -803,8 +803,8 @@ Subagent provides: - [Claude Code Documentation](https://docs.claude.com/en/docs/claude-code/overview) - [Subagents in Claude Concepts Guide](../claude_concepts_guide.md#subagents) -- [Agent Skills Guide](../05-agent-skills/) -- [Memory and Context](../03-memory/) +- [Skills Guide](../03-skills/) +- [Memory and Context](../02-memory/) --- diff --git a/02-subagents/code-reviewer.md b/04-subagents/code-reviewer.md similarity index 100% rename from 02-subagents/code-reviewer.md rename to 04-subagents/code-reviewer.md diff --git a/02-subagents/documentation-writer.md b/04-subagents/documentation-writer.md similarity index 100% rename from 02-subagents/documentation-writer.md rename to 04-subagents/documentation-writer.md diff --git a/02-subagents/implementation-agent.md b/04-subagents/implementation-agent.md similarity index 100% rename from 02-subagents/implementation-agent.md rename to 04-subagents/implementation-agent.md diff --git a/02-subagents/secure-reviewer.md b/04-subagents/secure-reviewer.md similarity index 100% rename from 02-subagents/secure-reviewer.md rename to 04-subagents/secure-reviewer.md diff --git a/02-subagents/test-engineer.md b/04-subagents/test-engineer.md similarity index 100% rename from 02-subagents/test-engineer.md rename to 04-subagents/test-engineer.md diff --git a/04-mcp/README.md b/05-mcp/README.md similarity index 100% rename from 04-mcp/README.md rename to 05-mcp/README.md diff --git a/04-mcp/database-mcp.json b/05-mcp/database-mcp.json similarity index 100% rename from 04-mcp/database-mcp.json rename to 05-mcp/database-mcp.json diff --git a/04-mcp/filesystem-mcp.json b/05-mcp/filesystem-mcp.json similarity index 100% rename from 04-mcp/filesystem-mcp.json rename to 05-mcp/filesystem-mcp.json diff --git a/04-mcp/github-mcp.json b/05-mcp/github-mcp.json similarity index 100% rename from 04-mcp/github-mcp.json rename to 05-mcp/github-mcp.json diff --git a/04-mcp/multi-mcp.json b/05-mcp/multi-mcp.json similarity index 100% rename from 04-mcp/multi-mcp.json rename to 05-mcp/multi-mcp.json diff --git a/07-hooks/README.md b/06-hooks/README.md similarity index 97% rename from 07-hooks/README.md rename to 06-hooks/README.md index b83fea1..8bbd8de 100644 --- a/07-hooks/README.md +++ b/06-hooks/README.md @@ -398,7 +398,7 @@ See the example files in this directory: For more information on related Claude Code features, see: - **[Checkpoints and Rewind](../08-checkpoints/)** - Save and restore conversation state -- **[Custom Commands](../06-commands/)** - Create custom slash commands -- **[Settings Configuration](../settings/)** - Configure Claude Code behavior -- **[Advanced Features](../advanced-features/)** - Explore advanced Claude Code capabilities +- **[Slash Commands](../01-slash-commands/)** - Create custom slash commands +- **[Plugins](../07-plugins/)** - Bundled extension packages +- **[Advanced Features](../09-advanced-features/)** - Explore advanced Claude Code capabilities - **[Main Concepts Guide](../claude_concepts_guide.md)** - Complete reference documentation diff --git a/07-hooks/format-code.sh b/06-hooks/format-code.sh similarity index 100% rename from 07-hooks/format-code.sh rename to 06-hooks/format-code.sh diff --git a/07-hooks/log-bash.sh b/06-hooks/log-bash.sh similarity index 100% rename from 07-hooks/log-bash.sh rename to 06-hooks/log-bash.sh diff --git a/07-hooks/notify-team.sh b/06-hooks/notify-team.sh similarity index 100% rename from 07-hooks/notify-team.sh rename to 06-hooks/notify-team.sh diff --git a/07-hooks/pre-commit.sh b/06-hooks/pre-commit.sh similarity index 100% rename from 07-hooks/pre-commit.sh rename to 06-hooks/pre-commit.sh diff --git a/07-hooks/security-scan.sh b/06-hooks/security-scan.sh similarity index 100% rename from 07-hooks/security-scan.sh rename to 06-hooks/security-scan.sh diff --git a/07-hooks/validate-prompt.sh b/06-hooks/validate-prompt.sh similarity index 100% rename from 07-hooks/validate-prompt.sh rename to 06-hooks/validate-prompt.sh diff --git a/06-plugins/README.md b/07-plugins/README.md similarity index 96% rename from 06-plugins/README.md rename to 07-plugins/README.md index 18ac4cb..cb657a5 100644 --- a/06-plugins/README.md +++ b/07-plugins/README.md @@ -526,11 +526,11 @@ Complete PR review workflow with security, testing, and documentation checks. The following Claude Code features work together with plugins: - **[Slash Commands](../01-slash-commands/)** - Individual commands bundled in plugins -- **[Subagents](../03-subagents/)** - Specialized agents included as plugin components -- **[MCP Servers](../04-mcp-servers/)** - Model Context Protocol integrations bundled in plugins -- **[Hooks](../05-hooks/)** - Event handlers that trigger plugin workflows -- **[Skills](../02-skills/)** - Domain expertise that can be wrapped into plugins -- **[Environments](../07-environments/)** - Configuration and secrets management for plugins +- **[Memory](../02-memory/)** - Persistent context for plugins +- **[Skills](../03-skills/)** - Domain expertise that can be wrapped into plugins +- **[Subagents](../04-subagents/)** - Specialized agents included as plugin components +- **[MCP Servers](../05-mcp/)** - Model Context Protocol integrations bundled in plugins +- **[Hooks](../06-hooks/)** - Event handlers that trigger plugin workflows ## Complete Example Workflow @@ -592,5 +592,5 @@ The following Claude Code features work together with plugins: - [Official Plugin Examples](https://github.com/anthropic/claude-plugins) - [Plugin Development Guide](https://docs.claude.com/plugins/development) - [MCP Server Reference](https://spec.modelcontextprotocol.io/) -- [Subagent Configuration Guide](../03-subagents/README.md) -- [Hook System Reference](../05-hooks/README.md) +- [Subagent Configuration Guide](../04-subagents/README.md) +- [Hook System Reference](../06-hooks/README.md) diff --git a/06-plugins/devops-automation/README.md b/07-plugins/devops-automation/README.md similarity index 100% rename from 06-plugins/devops-automation/README.md rename to 07-plugins/devops-automation/README.md diff --git a/06-plugins/devops-automation/agents/alert-analyzer.md b/07-plugins/devops-automation/agents/alert-analyzer.md similarity index 100% rename from 06-plugins/devops-automation/agents/alert-analyzer.md rename to 07-plugins/devops-automation/agents/alert-analyzer.md diff --git a/06-plugins/devops-automation/agents/deployment-specialist.md b/07-plugins/devops-automation/agents/deployment-specialist.md similarity index 100% rename from 06-plugins/devops-automation/agents/deployment-specialist.md rename to 07-plugins/devops-automation/agents/deployment-specialist.md diff --git a/06-plugins/devops-automation/agents/incident-commander.md b/07-plugins/devops-automation/agents/incident-commander.md similarity index 100% rename from 06-plugins/devops-automation/agents/incident-commander.md rename to 07-plugins/devops-automation/agents/incident-commander.md diff --git a/06-plugins/devops-automation/commands/deploy.md b/07-plugins/devops-automation/commands/deploy.md similarity index 100% rename from 06-plugins/devops-automation/commands/deploy.md rename to 07-plugins/devops-automation/commands/deploy.md diff --git a/06-plugins/devops-automation/commands/incident.md b/07-plugins/devops-automation/commands/incident.md similarity index 100% rename from 06-plugins/devops-automation/commands/incident.md rename to 07-plugins/devops-automation/commands/incident.md diff --git a/06-plugins/devops-automation/commands/rollback.md b/07-plugins/devops-automation/commands/rollback.md similarity index 100% rename from 06-plugins/devops-automation/commands/rollback.md rename to 07-plugins/devops-automation/commands/rollback.md diff --git a/06-plugins/devops-automation/commands/status.md b/07-plugins/devops-automation/commands/status.md similarity index 100% rename from 06-plugins/devops-automation/commands/status.md rename to 07-plugins/devops-automation/commands/status.md diff --git a/06-plugins/devops-automation/hooks/post-deploy.js b/07-plugins/devops-automation/hooks/post-deploy.js similarity index 100% rename from 06-plugins/devops-automation/hooks/post-deploy.js rename to 07-plugins/devops-automation/hooks/post-deploy.js diff --git a/06-plugins/devops-automation/hooks/pre-deploy.js b/07-plugins/devops-automation/hooks/pre-deploy.js similarity index 100% rename from 06-plugins/devops-automation/hooks/pre-deploy.js rename to 07-plugins/devops-automation/hooks/pre-deploy.js diff --git a/06-plugins/devops-automation/mcp/kubernetes-config.json b/07-plugins/devops-automation/mcp/kubernetes-config.json similarity index 100% rename from 06-plugins/devops-automation/mcp/kubernetes-config.json rename to 07-plugins/devops-automation/mcp/kubernetes-config.json diff --git a/06-plugins/devops-automation/plugin.yaml b/07-plugins/devops-automation/plugin.yaml similarity index 100% rename from 06-plugins/devops-automation/plugin.yaml rename to 07-plugins/devops-automation/plugin.yaml diff --git a/06-plugins/devops-automation/scripts/deploy.sh b/07-plugins/devops-automation/scripts/deploy.sh similarity index 100% rename from 06-plugins/devops-automation/scripts/deploy.sh rename to 07-plugins/devops-automation/scripts/deploy.sh diff --git a/06-plugins/devops-automation/scripts/health-check.sh b/07-plugins/devops-automation/scripts/health-check.sh similarity index 100% rename from 06-plugins/devops-automation/scripts/health-check.sh rename to 07-plugins/devops-automation/scripts/health-check.sh diff --git a/06-plugins/devops-automation/scripts/rollback.sh b/07-plugins/devops-automation/scripts/rollback.sh similarity index 100% rename from 06-plugins/devops-automation/scripts/rollback.sh rename to 07-plugins/devops-automation/scripts/rollback.sh diff --git a/06-plugins/documentation/README.md b/07-plugins/documentation/README.md similarity index 100% rename from 06-plugins/documentation/README.md rename to 07-plugins/documentation/README.md diff --git a/06-plugins/documentation/agents/api-documenter.md b/07-plugins/documentation/agents/api-documenter.md similarity index 100% rename from 06-plugins/documentation/agents/api-documenter.md rename to 07-plugins/documentation/agents/api-documenter.md diff --git a/06-plugins/documentation/agents/code-commentator.md b/07-plugins/documentation/agents/code-commentator.md similarity index 100% rename from 06-plugins/documentation/agents/code-commentator.md rename to 07-plugins/documentation/agents/code-commentator.md diff --git a/06-plugins/documentation/agents/example-generator.md b/07-plugins/documentation/agents/example-generator.md similarity index 100% rename from 06-plugins/documentation/agents/example-generator.md rename to 07-plugins/documentation/agents/example-generator.md diff --git a/06-plugins/documentation/commands/generate-api-docs.md b/07-plugins/documentation/commands/generate-api-docs.md similarity index 100% rename from 06-plugins/documentation/commands/generate-api-docs.md rename to 07-plugins/documentation/commands/generate-api-docs.md diff --git a/06-plugins/documentation/commands/generate-readme.md b/07-plugins/documentation/commands/generate-readme.md similarity index 100% rename from 06-plugins/documentation/commands/generate-readme.md rename to 07-plugins/documentation/commands/generate-readme.md diff --git a/06-plugins/documentation/commands/sync-docs.md b/07-plugins/documentation/commands/sync-docs.md similarity index 100% rename from 06-plugins/documentation/commands/sync-docs.md rename to 07-plugins/documentation/commands/sync-docs.md diff --git a/06-plugins/documentation/commands/validate-docs.md b/07-plugins/documentation/commands/validate-docs.md similarity index 100% rename from 06-plugins/documentation/commands/validate-docs.md rename to 07-plugins/documentation/commands/validate-docs.md diff --git a/06-plugins/documentation/mcp/github-docs-config.json b/07-plugins/documentation/mcp/github-docs-config.json similarity index 100% rename from 06-plugins/documentation/mcp/github-docs-config.json rename to 07-plugins/documentation/mcp/github-docs-config.json diff --git a/06-plugins/documentation/plugin.yaml b/07-plugins/documentation/plugin.yaml similarity index 100% rename from 06-plugins/documentation/plugin.yaml rename to 07-plugins/documentation/plugin.yaml diff --git a/06-plugins/documentation/templates/adr-template.md b/07-plugins/documentation/templates/adr-template.md similarity index 100% rename from 06-plugins/documentation/templates/adr-template.md rename to 07-plugins/documentation/templates/adr-template.md diff --git a/06-plugins/documentation/templates/api-endpoint.md b/07-plugins/documentation/templates/api-endpoint.md similarity index 100% rename from 06-plugins/documentation/templates/api-endpoint.md rename to 07-plugins/documentation/templates/api-endpoint.md diff --git a/06-plugins/documentation/templates/function-docs.md b/07-plugins/documentation/templates/function-docs.md similarity index 100% rename from 06-plugins/documentation/templates/function-docs.md rename to 07-plugins/documentation/templates/function-docs.md diff --git a/06-plugins/pr-review/README.md b/07-plugins/pr-review/README.md similarity index 100% rename from 06-plugins/pr-review/README.md rename to 07-plugins/pr-review/README.md diff --git a/06-plugins/pr-review/agents/performance-analyzer.md b/07-plugins/pr-review/agents/performance-analyzer.md similarity index 100% rename from 06-plugins/pr-review/agents/performance-analyzer.md rename to 07-plugins/pr-review/agents/performance-analyzer.md diff --git a/06-plugins/pr-review/agents/security-reviewer.md b/07-plugins/pr-review/agents/security-reviewer.md similarity index 100% rename from 06-plugins/pr-review/agents/security-reviewer.md rename to 07-plugins/pr-review/agents/security-reviewer.md diff --git a/06-plugins/pr-review/agents/test-checker.md b/07-plugins/pr-review/agents/test-checker.md similarity index 100% rename from 06-plugins/pr-review/agents/test-checker.md rename to 07-plugins/pr-review/agents/test-checker.md diff --git a/06-plugins/pr-review/commands/check-security.md b/07-plugins/pr-review/commands/check-security.md similarity index 100% rename from 06-plugins/pr-review/commands/check-security.md rename to 07-plugins/pr-review/commands/check-security.md diff --git a/06-plugins/pr-review/commands/check-tests.md b/07-plugins/pr-review/commands/check-tests.md similarity index 100% rename from 06-plugins/pr-review/commands/check-tests.md rename to 07-plugins/pr-review/commands/check-tests.md diff --git a/06-plugins/pr-review/commands/review-pr.md b/07-plugins/pr-review/commands/review-pr.md similarity index 100% rename from 06-plugins/pr-review/commands/review-pr.md rename to 07-plugins/pr-review/commands/review-pr.md diff --git a/06-plugins/pr-review/hooks/pre-review.js b/07-plugins/pr-review/hooks/pre-review.js similarity index 100% rename from 06-plugins/pr-review/hooks/pre-review.js rename to 07-plugins/pr-review/hooks/pre-review.js diff --git a/06-plugins/pr-review/mcp/github-config.json b/07-plugins/pr-review/mcp/github-config.json similarity index 100% rename from 06-plugins/pr-review/mcp/github-config.json rename to 07-plugins/pr-review/mcp/github-config.json diff --git a/06-plugins/pr-review/plugin.yaml b/07-plugins/pr-review/plugin.yaml similarity index 100% rename from 06-plugins/pr-review/plugin.yaml rename to 07-plugins/pr-review/plugin.yaml diff --git a/08-checkpoints/README.md b/08-checkpoints/README.md index 008f9f1..b8e037f 100644 --- a/08-checkpoints/README.md +++ b/08-checkpoints/README.md @@ -461,12 +461,11 @@ Use both together: ## Related Concepts -- **[Planning Mode](../07-planning/)** - Create detailed implementation plans before coding -- **[Memory Management](../06-memory/)** - Managing conversation history and context -- **[Code Navigation](../05-code-navigation/)** - Understanding and navigating your codebase -- **[Real-time Collaboration](../09-collaboration/)** - Working with teams using Claude Code -- **[Error Handling](../10-error-handling/)** - Handling and recovering from errors -- **[Best Practices](../11-best-practices/)** - General best practices for Claude Code usage +- **[Advanced Features](../09-advanced-features/)** - Planning mode and other advanced capabilities +- **[Memory Management](../02-memory/)** - Managing conversation history and context +- **[Slash Commands](../01-slash-commands/)** - User-invoked shortcuts +- **[Hooks](../06-hooks/)** - Event-driven automation +- **[Plugins](../07-plugins/)** - Bundled extension packages ## Summary diff --git a/09-advanced-features/README.md b/09-advanced-features/README.md index d885fed..97d8d87 100644 --- a/09-advanced-features/README.md +++ b/09-advanced-features/README.md @@ -1038,9 +1038,13 @@ Create `.claude/config.json` in your project: For more information about Claude Code and related features, see: - [Main Claude Code Guide](../README.md) -- [Claude Code Basics](../01-basics/) -- [Advanced Code Analysis](../02-code-analysis/) -- [Collaboration Features](../03-collaboration/) -- [Troubleshooting Guide](../troubleshooting.md) +- [Slash Commands](../01-slash-commands/) +- [Memory](../02-memory/) +- [Skills](../03-skills/) +- [Subagents](../04-subagents/) +- [MCP](../05-mcp/) +- [Hooks](../06-hooks/) +- [Plugins](../07-plugins/) +- [Checkpoints](../08-checkpoints/) - [Claude Documentation](https://docs.claude.com) - [MCP GitHub Servers](https://github.com/modelcontextprotocol/servers) diff --git a/LEARNING-ROADMAP.md b/LEARNING-ROADMAP.md new file mode 100644 index 0000000..ab8fbba --- /dev/null +++ b/LEARNING-ROADMAP.md @@ -0,0 +1,468 @@ +![Claude How To](claude-howto-logo.svg) + +# πŸ“š Claude Code Learning Roadmap + +**New to Claude Code?** This comprehensive guide will help you master Claude Code features progressively, starting with the simplest and most frequently used capabilities. + +--- + +## 🎯 Learning Philosophy + +The folders in this repository are numbered in **recommended learning order** based on three key principles: + +1. **Dependencies** - Foundational concepts come first +2. **Complexity** - Easier features before advanced ones +3. **Frequency of Use** - Most common features taught early + +This approach ensures you build a solid foundation while gaining immediate productivity benefits. + +--- + +## πŸ—ΊοΈ Your Learning Path + +```mermaid +graph TD + A[1. Slash Commands
⭐ START HERE] --> B[2. Memory
Essential Foundation] + B --> C[3. Skills
Auto-invoked Capabilities] + C --> D[4. Subagents
Task Delegation] + D --> E[5. MCP
External Integration] + E --> F[6. Hooks
Event Automation] + F --> G[7. Plugins
Bundled Solutions] + G --> H[8. Checkpoints
Safe Experimentation] + H --> I[9. Advanced Features
Power User Tools] + + style A fill:#90EE90 + style B fill:#87CEEB + style C fill:#87CEEB + style D fill:#FFD700 + style E fill:#FFD700 + style F fill:#FFA500 + style G fill:#FF6347 + style H fill:#FF6347 + style I fill:#8B0000,color:#fff +``` + +**Color Legend:** +- 🟒 Green: Beginner - Start here! +- πŸ”΅ Light Blue: Beginner+ - Essential foundations +- 🟑 Gold: Intermediate - Common usage +- 🟠 Orange: Intermediate-Advanced - Specialized +- πŸ”΄ Red: Advanced - Power user features +- πŸ”΄ Dark Red: Most Advanced - Expert territory + +--- + +## πŸ“Š Complete Roadmap Table + +| Step | Feature | Complexity | Time | Dependencies | Why Learn This | Key Benefits | +|------|---------|-----------|------|--------------|----------------|--------------| +| **1** | [Slash Commands](01-slash-commands/) | ⭐ Beginner | 30 min | None | Quick productivity wins | Instant automation, team standards | +| **2** | [Memory](02-memory/) | ⭐⭐ Beginner+ | 45 min | None | Essential for all features | Persistent context, preferences | +| **3** | [Skills](03-skills/) | ⭐⭐ Intermediate | 1 hour | Slash Commands | Automatic expertise | Reusable capabilities, consistency | +| **4** | [Subagents](04-subagents/) | ⭐⭐⭐ Intermediate+ | 1.5 hours | Memory, Commands | Complex task handling | Delegation, specialized expertise | +| **5** | [MCP](05-mcp/) | ⭐⭐⭐ Intermediate+ | 1 hour | Configuration | Live data access | Real-time integration, APIs | +| **6** | [Hooks](06-hooks/) | ⭐⭐ Intermediate | 1 hour | Tools, Commands | Workflow automation | Validation, quality gates | +| **7** | [Plugins](07-plugins/) | ⭐⭐⭐⭐ Advanced | 2 hours | All previous | Complete solutions | Team onboarding, distribution | +| **8** | [Checkpoints](08-checkpoints/) | ⭐⭐ Intermediate | 45 min | Session management | Safe exploration | Experimentation, recovery | +| **9** | [Advanced Features](09-advanced-features/) | ⭐⭐⭐⭐⭐ Advanced | 2-3 hours | All previous | Power user tools | Planning, headless, permissions | + +**Total Learning Time**: ~10-12 hours (spread across 4-5 weeks recommended) + +--- + +## 🎯 Learning Milestones + +### Milestone 1: Essential Productivity (Week 1) + +**Topics**: Slash Commands + Memory +**Time**: 1-2 hours +**Complexity**: ⭐ Beginner +**Goal**: Immediate productivity boost with custom commands and persistent context + +#### What You'll Achieve +βœ… Create custom slash commands for repetitive tasks +βœ… Set up project memory for team standards +βœ… Configure personal preferences +βœ… Understand how Claude loads context automatically + +#### Hands-on Exercises + +```bash +# Exercise 1: Install your first slash command +mkdir -p .claude/commands +cp 01-slash-commands/optimize.md .claude/commands/ + +# Exercise 2: Create project memory +cp 02-memory/project-CLAUDE.md ./CLAUDE.md + +# Exercise 3: Try it out +# In Claude Code, type: /optimize +``` + +#### Success Criteria +- [ ] Successfully invoke `/optimize` command +- [ ] Claude remembers your project standards from CLAUDE.md +- [ ] You understand when to use slash commands vs. memory + +#### Next Steps +Once comfortable, read: +- [01-slash-commands/README.md](01-slash-commands/README.md) +- [02-memory/README.md](02-memory/README.md) + +--- + +### Milestone 2: Automation (Week 2) + +**Topics**: Skills + Hooks +**Time**: 2-3 hours +**Complexity**: ⭐⭐ Intermediate +**Goal**: Automate common workflows and quality checks + +#### What You'll Achieve +βœ… Auto-invoke specialized capabilities +βœ… Set up event-driven automation +βœ… Enforce code quality standards +βœ… Create custom hooks for your workflow + +#### Hands-on Exercises + +```bash +# Exercise 1: Install a skill +cp -r 03-skills/code-review ~/.claude/skills/ + +# Exercise 2: Set up hooks +mkdir -p ~/.claude/hooks +cp 06-hooks/pre-commit.sh ~/.claude/hooks/ +chmod +x ~/.claude/hooks/pre-commit.sh + +# Exercise 3: Configure hooks in settings +# Add to ~/.claude/config.json: +{ + "hooks": { + "PreCommit": "~/.claude/hooks/pre-commit.sh" + } +} +``` + +#### Success Criteria +- [ ] Code review skill automatically invoked when relevant +- [ ] Pre-commit hook runs before git commits +- [ ] You understand skill auto-invocation vs. hook triggers + +#### Next Steps +- Create your own custom skill +- Set up additional hooks for your workflow +- Read: [03-skills/README.md](03-skills/README.md) +- Read: [06-hooks/README.md](06-hooks/README.md) + +--- + +### Milestone 3: Advanced Integration (Week 3-4) + +**Topics**: Subagents + MCP + Plugins +**Time**: 4-5 hours +**Complexity**: ⭐⭐⭐ Intermediate-Advanced +**Goal**: Integrate external services and delegate complex tasks + +#### What You'll Achieve +βœ… Delegate work to specialized AI agents +βœ… Access live data from GitHub, databases, etc. +βœ… Install complete bundled solutions +βœ… Understand when to use each integration type + +#### Hands-on Exercises + +```bash +# Exercise 1: Set up GitHub MCP +export GITHUB_TOKEN="your_github_token" +cp 05-mcp/github-mcp.json ~/.claude/mcp.json + +# Exercise 2: Test MCP integration +# In Claude Code: /mcp__github__list_prs + +# Exercise 3: Install subagents +mkdir -p .claude/agents +cp 04-subagents/*.md .claude/agents/ + +# Exercise 4: Install a complete plugin +# In Claude Code: /plugin install pr-review +``` + +#### Success Criteria +- [ ] Successfully query GitHub data via MCP +- [ ] Claude delegates complex tasks to subagents +- [ ] You've installed and used a plugin +- [ ] You understand the difference between MCP, subagents, and plugins + +#### Integration Exercise +Try this complete workflow: +1. Use MCP to fetch a GitHub PR +2. Let Claude delegate review to code-reviewer subagent +3. Use hooks to run tests automatically +4. See how the plugin bundles everything together + +#### Next Steps +- Set up additional MCP servers (database, Slack, etc.) +- Create custom subagents for your domain +- Read: [04-subagents/README.md](04-subagents/README.md) +- Read: [05-mcp/README.md](05-mcp/README.md) +- Read: [07-plugins/README.md](07-plugins/README.md) + +--- + +### Milestone 4: Power User (Week 5+) + +**Topics**: Checkpoints + Advanced Features +**Time**: 3-4 hours +**Complexity**: ⭐⭐⭐⭐⭐ Advanced +**Goal**: Master advanced workflows and experimentation + +#### What You'll Achieve +βœ… Safe experimentation with checkpoints +βœ… Planning mode for complex features +βœ… Headless mode for CI/CD +βœ… Fine-grained permission control +βœ… Background task management + +#### Hands-on Exercises + +```bash +# Exercise 1: Try checkpoint workflow +# In Claude Code: +/checkpoint save "Before experiment" +# ... make experimental changes ... +/checkpoint rewind "Before experiment" + +# Exercise 2: Use planning mode +/plan Implement user authentication system + +# Exercise 3: Try headless mode +claude-code --headless --task "Run all tests and generate report" + +# Exercise 4: Configure advanced features +# See 09-advanced-features/config-examples.json +``` + +#### Success Criteria +- [ ] Created and reverted to a checkpoint +- [ ] Used planning mode for a complex feature +- [ ] Ran Claude Code in headless mode +- [ ] Configured permission modes +- [ ] Used background tasks for long operations + +#### Advanced Exercise +Complete this end-to-end workflow: +1. Create checkpoint "Clean state" +2. Use planning mode to design a feature +3. Implement with subagent delegation +4. Run tests in background +5. If tests fail, rewind to checkpoint +6. Try alternative approach +7. Use headless mode in CI/CD + +#### Next Steps +- Set up CI/CD integration +- Create custom configuration for your team +- Read: [08-checkpoints/README.md](08-checkpoints/README.md) +- Read: [09-advanced-features/README.md](09-advanced-features/README.md) + +--- + +## ⚑ Quick Start Paths + +### If You Only Have 15 Minutes +**Goal**: Get your first win + +1. Copy one slash command: `cp 01-slash-commands/optimize.md .claude/commands/` +2. Try it in Claude Code: `/optimize` +3. Read: [01-slash-commands/README.md](01-slash-commands/README.md) + +**Outcome**: You'll have a working slash command and understand the basics + +--- + +### If You Have 1 Hour +**Goal**: Set up essential productivity tools + +1. **Slash commands** (15 min): Copy and test `/optimize` and `/pr` +2. **Project memory** (15 min): Create CLAUDE.md with your project standards +3. **Install a skill** (15 min): Set up code-review skill +4. **Try them together** (15 min): See how they work in harmony + +**Outcome**: Basic productivity boost with commands, memory, and auto-skills + +--- + +### If You Have a Weekend +**Goal**: Become proficient with most features + +**Saturday Morning** (3 hours): +- Complete Milestone 1: Slash Commands + Memory +- Complete Milestone 2: Skills + Hooks + +**Saturday Afternoon** (3 hours): +- Complete Milestone 3: Subagents + MCP +- Install and explore plugins + +**Sunday** (4 hours): +- Complete Milestone 4: Checkpoints + Advanced Features +- Build a custom plugin for your team +- Set up complete CI/CD workflow + +**Outcome**: You'll be a Claude Code power user ready to train others + +--- + +## πŸ’‘ Learning Tips + +### βœ… Do + +- **Follow the numbered order** (01 β†’ 02 β†’ 03...) +- **Complete hands-on exercises** for each topic +- **Start simple** and add complexity gradually +- **Test each feature** before moving to the next +- **Take notes** on what works for your workflow +- **Refer back** to earlier concepts as you learn advanced topics +- **Experiment safely** using checkpoints +- **Share knowledge** with your team + +### ❌ Don't + +- **Skip directly to advanced features** - you'll miss foundations +- **Try to learn everything at once** - it's overwhelming +- **Copy configurations without understanding them** - you won't know how to debug +- **Forget to test** - always verify features work +- **Rush through milestones** - take time to understand +- **Ignore the documentation** - each README has valuable details +- **Work in isolation** - discuss with teammates + +--- + +## πŸŽ“ Learning Styles + +### Visual Learners +- Study the mermaid diagrams in each README +- Watch the command execution flow +- Draw your own workflow diagrams +- Use the visual learning path above + +### Hands-on Learners +- Complete every hands-on exercise +- Experiment with variations +- Break things and fix them +- Create your own examples + +### Reading Learners +- Read each README thoroughly +- Study the code examples +- Review the comparison tables +- Read the blog posts linked in resources + +### Social Learners +- Set up pair programming sessions +- Teach concepts to teammates +- Join Claude Code community discussions +- Share your custom configurations + +--- + +## πŸ“ˆ Progress Tracking + +Use this checklist to track your progress: + +### Week 1: Foundations +- [ ] Completed 01-slash-commands +- [ ] Completed 02-memory +- [ ] Created first custom slash command +- [ ] Set up project memory +- [ ] Milestone 1 achieved + +### Week 2: Automation +- [ ] Completed 03-skills +- [ ] Completed 06-hooks +- [ ] Installed first skill +- [ ] Set up pre-commit hook +- [ ] Milestone 2 achieved + +### Week 3-4: Integration +- [ ] Completed 04-subagents +- [ ] Completed 05-mcp +- [ ] Completed 07-plugins +- [ ] Connected GitHub MCP +- [ ] Created custom subagent +- [ ] Installed plugin +- [ ] Milestone 3 achieved + +### Week 5+: Mastery +- [ ] Completed 08-checkpoints +- [ ] Completed 09-advanced-features +- [ ] Used planning mode successfully +- [ ] Set up headless CI/CD +- [ ] Created team plugin +- [ ] Milestone 4 achieved + +--- + +## πŸ†˜ Common Learning Challenges + +### Challenge 1: "Too many concepts at once" +**Solution**: Focus on one milestone at a time. Complete all exercises before moving forward. + +### Challenge 2: "Don't know which feature to use when" +**Solution**: Refer to the [Use Case Matrix](README.md#use-case-matrix) in the main README. + +### Challenge 3: "Configuration not working" +**Solution**: Check the [Troubleshooting](README.md#troubleshooting) section and verify file locations. + +### Challenge 4: "Concepts seem to overlap" +**Solution**: Review the [Feature Comparison](README.md#feature-comparison) table to understand differences. + +### Challenge 5: "Hard to remember everything" +**Solution**: Create your own cheat sheet. Use checkpoints to experiment safely. + +--- + +## 🎯 What's Next After Completion? + +Once you've completed all milestones: + +1. **Create team documentation** - Document your team's Claude Code setup +2. **Build custom plugins** - Package your team's workflows +3. **Contribute examples** - Share with the community +4. **Mentor others** - Help teammates learn +5. **Optimize workflows** - Continuously improve based on usage +6. **Stay updated** - Follow Claude Code releases and new features + +--- + +## πŸ“š Additional Resources + +### Official Documentation +- [Claude Code Documentation](https://docs.claude.com/en/docs/claude-code) +- [MCP Protocol Specification](https://modelcontextprotocol.io) +- [Plugin Marketplace](https://plugins.claude.com) + +### Blog Posts +- [Discovering Claude Code Slash Commands](https://medium.com/@luongnv89/discovering-claude-code-slash-commands-cdc17f0dfb29) + +### Community +- [Claude Code Examples](https://github.com/anthropic/claude-examples) +- [MCP Servers Repository](https://github.com/modelcontextprotocol/servers) + +--- + +## πŸ’¬ Feedback & Support + +- **Found an issue?** Create an issue in the repository +- **Have a suggestion?** Submit a pull request +- **Need help?** Check the documentation or ask the community + +--- + +**Last Updated**: November 2025 +**Maintained by**: Claude How-To Contributors +**License**: Educational purposes, free to use and adapt + +--- + +[← Back to Main README](README.md) diff --git a/README.md b/README.md index 1f1be78..264310f 100644 --- a/README.md +++ b/README.md @@ -9,17 +9,108 @@ Complete collection of examples for some important Claude Code features and conc | Feature | Description | Folder | |---------|-------------|--------| | **Slash Commands** | User-invoked shortcuts | [01-slash-commands/](01-slash-commands/) | -| **Subagents** | Specialized AI assistants | [02-subagents/](02-subagents/) | -| **Memory** | Persistent context | [03-memory/](03-memory/) | -| **MCP Protocol** | External tool access | [04-mcp/](04-mcp/) | -| **Skills** | Reusable capabilities | [05-skills/](05-skills/) | -| **Plugins** | Bundled features | [06-plugins/](06-plugins/) | -| **Hooks** | Event-driven automation | [07-hooks/](07-hooks/) | +| **Memory** | Persistent context | [02-memory/](02-memory/) | +| **Skills** | Reusable capabilities | [03-skills/](03-skills/) | +| **Subagents** | Specialized AI assistants | [04-subagents/](04-subagents/) | +| **MCP Protocol** | External tool access | [05-mcp/](05-mcp/) | +| **Hooks** | Event-driven automation | [06-hooks/](06-hooks/) | +| **Plugins** | Bundled features | [07-plugins/](07-plugins/) | | **Checkpoints** | Session snapshots & rewind | [08-checkpoints/](08-checkpoints/) | | **Advanced Features** | Planning, thinking, background tasks | [09-advanced-features/](09-advanced-features/) | --- +## πŸ“š Learning Path + +**New to Claude Code?** The folders are numbered in **recommended learning order**: + +| Order | Feature | Level | Time | Start Here | +|-------|---------|-------|------|------------| +| **1** | [Slash Commands](01-slash-commands/) | ⭐ Beginner | 30 min | βœ… **START** | +| **2** | [Memory](02-memory/) | ⭐⭐ Beginner+ | 45 min | Essential | +| **3** | [Skills](03-skills/) | ⭐⭐ Intermediate | 1 hour | Auto-invoke | +| **4** | [Subagents](04-subagents/) | ⭐⭐⭐ Intermediate+ | 1.5 hours | Delegation | +| **5** | [MCP](05-mcp/) | ⭐⭐⭐ Intermediate+ | 1 hour | Live data | +| **6** | [Hooks](06-hooks/) | ⭐⭐ Intermediate | 1 hour | Automation | +| **7** | [Plugins](07-plugins/) | ⭐⭐⭐⭐ Advanced | 2 hours | Bundles | +| **8** | [Checkpoints](08-checkpoints/) | ⭐⭐ Intermediate | 45 min | Safe tests | +| **9** | [Advanced](09-advanced-features/) | ⭐⭐⭐⭐⭐ Advanced | 2-3 hours | Power user | + +**Total**: ~10-12 hours | πŸ“– **[Complete Learning Roadmap β†’](LEARNING-ROADMAP.md)** + +--- + +## 🎯 Quick Reference: Choose Your Features + +### Feature Comparison + +| Feature | Invocation | Persistence | Best For | +|---------|-----------|------------|----------| +| **Slash Commands** | Manual (`/cmd`) | Session only | Quick shortcuts | +| **Memory** | Auto-loaded | Cross-session | Long-term learning | +| **Skills** | Auto-invoked | Filesystem | Automated workflows | +| **Subagents** | Auto-delegated | Isolated context | Task distribution | +| **MCP Protocol** | Auto-queried | Real-time | Live data access | +| **Hooks** | Event-triggered | Configured | Automation & validation | +| **Plugins** | One command | All features | Complete solutions | +| **Checkpoints** | Manual/Auto | Session-based | Safe experimentation | +| **Planning Mode** | Manual/Auto | Plan phase | Complex implementations | +| **Background Tasks** | Manual | Task duration | Long-running operations | + +### Use Case Matrix + +| Use Case | Recommended Features | +|----------|---------------------| +| **Team Onboarding** | Memory + Slash Commands + Plugins | +| **Code Quality** | Subagents + Skills + Memory + Hooks | +| **Documentation** | Skills + Subagents + Plugins | +| **DevOps** | Plugins + MCP + Hooks + Background Tasks | +| **Security Review** | Subagents + Skills + Hooks (read-only mode) | +| **API Integration** | MCP + Memory | +| **Quick Tasks** | Slash Commands | +| **Complex Projects** | All Features + Planning Mode | +| **Refactoring** | Checkpoints + Planning Mode + Hooks | +| **Learning/Experimentation** | Checkpoints + Extended Thinking + Permission Mode | +| **CI/CD Automation** | Headless Mode + Hooks + Background Tasks | +| **Performance Optimization** | Planning Mode + Checkpoints + Background Tasks | + +--- + +## ⚑ Getting Started + +### 15 Minutes - First Steps +```bash +# Copy your first slash command +cp 01-slash-commands/optimize.md .claude/commands/ + +# Try it! +# In Claude Code: /optimize +``` + +### 1 Hour - Essential Setup +```bash +# 1. Slash commands (15 min) +cp 01-slash-commands/*.md .claude/commands/ + +# 2. Project memory (15 min) +cp 02-memory/project-CLAUDE.md ./CLAUDE.md + +# 3. Install a skill (15 min) +cp -r 03-skills/code-review ~/.claude/skills/ + +# 4. Try them together (15 min) +# See how they work in harmony! +``` + +### Weekend - Full Setup +- **Day 1**: Slash Commands, Memory, Skills, Hooks +- **Day 2**: Subagents, MCP integration, Plugins +- **Result**: Complete Claude Code power user setup + +πŸ“– **[Detailed milestones and exercises β†’](LEARNING-ROADMAP.md)** + +--- + ## 01. Slash Commands **Location**: [01-slash-commands/](01-slash-commands/) @@ -47,9 +138,60 @@ cp 01-slash-commands/*.md /path/to/project/.claude/commands/ --- -## 02. Subagents +## 02. Memory -**Location**: [02-subagents/](02-subagents/) +**Location**: [02-memory/](02-memory/) + +**What**: Persistent context across sessions + +**Examples**: +- `project-CLAUDE.md` - Team-wide project standards +- `directory-api-CLAUDE.md` - Directory-specific rules +- `personal-CLAUDE.md` - Personal preferences + +**Installation**: +```bash +# Project memory +cp 02-memory/project-CLAUDE.md /path/to/project/CLAUDE.md + +# Directory memory +cp 02-memory/directory-api-CLAUDE.md /path/to/project/src/api/CLAUDE.md + +# Personal memory +cp 02-memory/personal-CLAUDE.md ~/.claude/CLAUDE.md +``` + +**Usage**: Automatically loaded by Claude + +--- + +## 03. Skills + +**Location**: [03-skills/](03-skills/) + +**What**: Reusable, auto-invoked capabilities with instructions and scripts + +**Examples**: +- `code-review/` - Comprehensive code review with scripts +- `brand-voice/` - Brand voice consistency checker +- `doc-generator/` - API documentation generator + +**Installation**: +```bash +# Personal skills +cp -r 03-skills/code-review ~/.claude/skills/ + +# Project skills +cp -r 03-skills/code-review /path/to/project/.claude/skills/ +``` + +**Usage**: Automatically invoked when relevant + +--- + +## 04. Subagents + +**Location**: [04-subagents/](04-subagents/) **What**: Specialized AI assistants with isolated contexts and custom prompts @@ -62,43 +204,16 @@ cp 01-slash-commands/*.md /path/to/project/.claude/commands/ **Installation**: ```bash -cp 02-subagents/*.md /path/to/project/.claude/agents/ +cp 04-subagents/*.md /path/to/project/.claude/agents/ ``` **Usage**: Automatically delegated by main agent --- -## 03. Memory +## 05. MCP Protocol -**Location**: [03-memory/](03-memory/) - -**What**: Persistent context across sessions - -**Examples**: -- `project-CLAUDE.md` - Team-wide project standards -- `directory-api-CLAUDE.md` - Directory-specific rules -- `personal-CLAUDE.md` - Personal preferences - -**Installation**: -```bash -# Project memory -cp 03-memory/project-CLAUDE.md /path/to/project/CLAUDE.md - -# Directory memory -cp 03-memory/directory-api-CLAUDE.md /path/to/project/src/api/CLAUDE.md - -# Personal memory -cp 03-memory/personal-CLAUDE.md ~/.claude/CLAUDE.md -``` - -**Usage**: Automatically loaded by Claude - ---- - -## 04. MCP Protocol - -**Location**: [04-mcp/](04-mcp/) +**Location**: [05-mcp/](05-mcp/) **What**: Model Context Protocol for accessing external tools and APIs @@ -115,7 +230,7 @@ export GITHUB_TOKEN="your_token" export DATABASE_URL="postgresql://..." # Copy configuration -cp 04-mcp/github-mcp.json ~/.claude/mcp.json +cp 05-mcp/github-mcp.json ~/.claude/mcp.json ``` **Usage**: @@ -126,55 +241,9 @@ cp 04-mcp/github-mcp.json ~/.claude/mcp.json --- -## 05. Skills +## 06. Hooks -**Location**: [05-skills/](05-skills/) - -**What**: Reusable, auto-invoked capabilities with instructions and scripts - -**Examples**: -- `code-review/` - Comprehensive code review with scripts -- `brand-voice/` - Brand voice consistency checker -- `doc-generator/` - API documentation generator - -**Installation**: -```bash -# Personal skills -cp -r 05-skills/code-review ~/.claude/skills/ - -# Project skills -cp -r 05-skills/code-review /path/to/project/.claude/skills/ -``` - -**Usage**: Automatically invoked when relevant - ---- - -## 06. Plugins - -**Location**: [06-plugins/](06-plugins/) - -**What**: Bundled collections of commands, agents, MCP, and hooks - -**Examples**: -- `pr-review/` - Complete PR review workflow -- `devops-automation/` - Deployment and monitoring -- `documentation/` - Documentation generation - -**Installation**: -```bash -/plugin install pr-review -/plugin install devops-automation -/plugin install documentation -``` - -**Usage**: Use bundled slash commands and features - ---- - -## 07. Hooks - -**Location**: [07-hooks/](07-hooks/) +**Location**: [06-hooks/](06-hooks/) **What**: Event-driven shell commands that execute automatically in response to Claude Code events @@ -189,7 +258,7 @@ cp -r 05-skills/code-review /path/to/project/.claude/skills/ **Installation**: ```bash mkdir -p ~/.claude/hooks -cp 07-hooks/*.sh ~/.claude/hooks/ +cp 06-hooks/*.sh ~/.claude/hooks/ chmod +x ~/.claude/hooks/*.sh # Configure in settings @@ -211,6 +280,28 @@ echo '{ --- +## 07. Plugins + +**Location**: [07-plugins/](07-plugins/) + +**What**: Bundled collections of commands, agents, MCP, and hooks + +**Examples**: +- `pr-review/` - Complete PR review workflow +- `devops-automation/` - Deployment and monitoring +- `documentation/` - Documentation generation + +**Installation**: +```bash +/plugin install pr-review +/plugin install devops-automation +/plugin install documentation +``` + +**Usage**: Use bundled slash commands and features + +--- + ## 08. Checkpoints and Rewind **Location**: [08-checkpoints/](08-checkpoints/) @@ -355,52 +446,6 @@ See [config-examples.json](09-advanced-features/config-examples.json) for comple --- -## Feature Comparison - -| Feature | Invocation | Persistence | Best For | -|---------|-----------|------------|----------| -| **Slash Commands** | Manual (`/cmd`) | Session only | Quick shortcuts | -| **Subagents** | Auto-delegated | Isolated context | Task distribution | -| **Memory** | Auto-loaded | Cross-session | Long-term learning | -| **MCP Protocol** | Auto-queried | Real-time | Live data access | -| **Skills** | Auto-invoked | Filesystem | Automated workflows | -| **Plugins** | One command | All features | Complete solutions | -| **Hooks** | Event-triggered | Configured | Automation & validation | -| **Checkpoints** | Manual/Auto | Session-based | Safe experimentation | -| **Planning Mode** | Manual/Auto | Plan phase | Complex implementations | -| **Background Tasks** | Manual | Task duration | Long-running operations | - ---- - -## Getting Started - -### Week 1: Basics -1. Copy slash commands to `.claude/commands/` -2. Try `/optimize` and `/pr` commands -3. Create project memory in `CLAUDE.md` - -### Week 2: Real-time Access -1. Set up GitHub MCP -2. Query PRs and issues -3. Try multi-MCP configuration - -### Week 3: Distribution -1. Create first subagent -2. Test with complex task -3. Delegate work to specialists - -### Week 4: Automation -1. Install a skill -2. Let Claude auto-invoke it -3. Create custom skill - -### Week 5: Complete Solution -1. Install a plugin -2. Use bundled features -3. Consider creating your own - ---- - ## Directory Structure ``` @@ -410,25 +455,12 @@ See [config-examples.json](09-advanced-features/config-examples.json) for comple β”‚ β”œβ”€β”€ pr.md β”‚ β”œβ”€β”€ generate-api-docs.md β”‚ └── README.md -β”œβ”€β”€ 02-subagents/ -β”‚ β”œβ”€β”€ code-reviewer.md -β”‚ β”œβ”€β”€ test-engineer.md -β”‚ β”œβ”€β”€ documentation-writer.md -β”‚ β”œβ”€β”€ secure-reviewer.md -β”‚ β”œβ”€β”€ implementation-agent.md -β”‚ └── README.md -β”œβ”€β”€ 03-memory/ +β”œβ”€β”€ 02-memory/ β”‚ β”œβ”€β”€ project-CLAUDE.md β”‚ β”œβ”€β”€ directory-api-CLAUDE.md β”‚ β”œβ”€β”€ personal-CLAUDE.md β”‚ └── README.md -β”œβ”€β”€ 04-mcp/ -β”‚ β”œβ”€β”€ github-mcp.json -β”‚ β”œβ”€β”€ database-mcp.json -β”‚ β”œβ”€β”€ filesystem-mcp.json -β”‚ β”œβ”€β”€ multi-mcp.json -β”‚ └── README.md -β”œβ”€β”€ 05-skills/ +β”œβ”€β”€ 03-skills/ β”‚ β”œβ”€β”€ code-review/ β”‚ β”‚ β”œβ”€β”€ SKILL.md β”‚ β”‚ β”œβ”€β”€ scripts/ @@ -440,12 +472,20 @@ See [config-examples.json](09-advanced-features/config-examples.json) for comple β”‚ β”‚ β”œβ”€β”€ SKILL.md β”‚ β”‚ └── generate-docs.py β”‚ └── README.md -β”œβ”€β”€ 06-plugins/ -β”‚ β”œβ”€β”€ pr-review/ -β”‚ β”œβ”€β”€ devops-automation/ -β”‚ β”œβ”€β”€ documentation/ +β”œβ”€β”€ 04-subagents/ +β”‚ β”œβ”€β”€ code-reviewer.md +β”‚ β”œβ”€β”€ test-engineer.md +β”‚ β”œβ”€β”€ documentation-writer.md +β”‚ β”œβ”€β”€ secure-reviewer.md +β”‚ β”œβ”€β”€ implementation-agent.md β”‚ └── README.md -β”œβ”€β”€ 07-hooks/ +β”œβ”€β”€ 05-mcp/ +β”‚ β”œβ”€β”€ github-mcp.json +β”‚ β”œβ”€β”€ database-mcp.json +β”‚ β”œβ”€β”€ filesystem-mcp.json +β”‚ β”œβ”€β”€ multi-mcp.json +β”‚ └── README.md +β”œβ”€β”€ 06-hooks/ β”‚ β”œβ”€β”€ format-code.sh β”‚ β”œβ”€β”€ pre-commit.sh β”‚ β”œβ”€β”€ security-scan.sh @@ -453,6 +493,11 @@ See [config-examples.json](09-advanced-features/config-examples.json) for comple β”‚ β”œβ”€β”€ validate-prompt.sh β”‚ β”œβ”€β”€ notify-team.sh β”‚ └── README.md +β”œβ”€β”€ 07-plugins/ +β”‚ β”œβ”€β”€ pr-review/ +β”‚ β”œβ”€β”€ devops-automation/ +β”‚ β”œβ”€β”€ documentation/ +β”‚ └── README.md β”œβ”€β”€ 08-checkpoints/ β”‚ β”œβ”€β”€ checkpoint-examples.md β”‚ └── README.md @@ -465,6 +510,42 @@ See [config-examples.json](09-advanced-features/config-examples.json) for comple --- +## Installation Quick Reference + +```bash +# Slash Commands +cp 01-slash-commands/*.md .claude/commands/ + +# Memory +cp 02-memory/project-CLAUDE.md ./CLAUDE.md + +# Skills +cp -r 03-skills/code-review ~/.claude/skills/ + +# Subagents +cp 04-subagents/*.md .claude/agents/ + +# MCP +export GITHUB_TOKEN="token" +cp 05-mcp/github-mcp.json .claude/mcp.json + +# Hooks +mkdir -p ~/.claude/hooks +cp 06-hooks/*.sh ~/.claude/hooks/ +chmod +x ~/.claude/hooks/*.sh + +# Plugins +/plugin install pr-review + +# Checkpoints (auto-enabled, configure in settings) +# See 08-checkpoints/README.md + +# Advanced Features (configure in settings) +# See 09-advanced-features/config-examples.json +``` + +--- + ## Example Workflows ### 1. Complete Code Review Workflow @@ -516,61 +597,6 @@ Claude: --- -## Installation Quick Reference - -```bash -# Slash Commands -cp 01-slash-commands/*.md .claude/commands/ - -# Subagents -cp 02-subagents/*.md .claude/agents/ - -# Memory -cp 03-memory/project-CLAUDE.md ./CLAUDE.md - -# MCP -export GITHUB_TOKEN="token" -cp 04-mcp/github-mcp.json .claude/mcp.json - -# Skills -cp -r 05-skills/code-review ~/.claude/skills/ - -# Plugins -/plugin install pr-review - -# Hooks -mkdir -p ~/.claude/hooks -cp 07-hooks/*.sh ~/.claude/hooks/ -chmod +x ~/.claude/hooks/*.sh - -# Checkpoints (auto-enabled, configure in settings) -# See 08-checkpoints/README.md - -# Advanced Features (configure in settings) -# See 09-advanced-features/config-examples.json -``` - ---- - -## Use Case Matrix - -| Use Case | Recommended Features | -|----------|---------------------| -| **Team Onboarding** | Memory + Slash Commands + Plugins | -| **Code Quality** | Subagents + Skills + Memory + Hooks | -| **Documentation** | Skills + Subagents + Plugins | -| **DevOps** | Plugins + MCP + Hooks + Background Tasks | -| **Security Review** | Subagents + Skills + Hooks (read-only mode) | -| **API Integration** | MCP + Memory | -| **Quick Tasks** | Slash Commands | -| **Complex Projects** | All Features + Planning Mode | -| **Refactoring** | Checkpoints + Planning Mode + Hooks | -| **Learning/Experimentation** | Checkpoints + Extended Thinking + Permission Mode | -| **CI/CD Automation** | Headless Mode + Hooks + Background Tasks | -| **Performance Optimization** | Planning Mode + Checkpoints + Background Tasks | - ---- - ## Best Practices ### Do's βœ