github-code/claude-howto
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update all concept README files with comprehensive documentation

Browse Source 
Extract and consolidate information from claude_concepts_guide.md into
individual concept folders:

- 01-slash-commands: Add architecture diagrams, features table, lifecycle
  diagram, best practices, and comprehensive examples
- 02-subagents: Add architecture, configuration, tool access hierarchy,
  context management, and practical delegation examples
- 03-memory: Add memory hierarchy, locations table, lifecycle diagram,
  4 practical examples, and features comparison
- 04-mcp: Add MCP architecture, ecosystem, setup process, 4 examples
  (GitHub, Database, Multi-MCP, Filesystem), and security best practices
- 05-skills: Add skill architecture, loading process, 3 complete examples
  with Python scripts (Code Review, Brand Voice, Documentation Generator)
- 06-plugins: Add plugin architecture, marketplace, lifecycle, 3 examples,
  features comparison, and publishing guide
- 07-hooks: Add hook types table, common examples, variables, 5 practical
  examples with code, and best practices
- 08-checkpoints: Add key concepts, all commands, use cases table,
  configuration, 4 practical examples, and troubleshooting
- 09-advanced-features: Add Planning Mode, Extended Thinking, Background
  Tasks, Permission Modes, Headless Mode, Session Management, interactive
  features, and complete configuration examples

All READMEs now include:
- Overview sections with clear explanations
- Mermaid diagrams for visual understanding
- Comprehensive tables and feature comparisons
- Practical code examples and templates
- Installation instructions
- Best practices and troubleshooting
- Cross-references to related concepts

Total changes: +3706 lines of comprehensive documentation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
Luong NGUYEN
2025-11-08 01:51:06 +01:00
parent d17564a9f2
commit 41527aed26
9 changed files with 3776 additions and 657 deletions
Download Patch File Download Diff File Expand all files Collapse all files

434
01-slash-commands/README.md
View File

@@ -1,45 +1,34 @@
# Slash Commands Examples
# Slash Commands
This folder contains example slash commands that can be used with Claude Code.
## Overview
## Installation
Slash commands are user-invoked shortcuts stored as Markdown files that Claude Code can execute. They enable teams to standardize frequently-used prompts and workflows.
Copy these files to your project's `.claude/commands/` directory:
## Architecture
```bash
cp *.md /path/to/your/project/.claude/commands/
```
## Available Commands
### 1. `/optimize` - Code Optimization
Analyzes code for performance issues, memory leaks, and optimization opportunities.
**Usage:**
```
/optimize
[Paste your code]
```
### 2. `/pr` - Pull Request Preparation
Guides you through PR preparation checklist including linting, testing, and commit message formatting.
**Usage:**
```
/pr
```
### 3. `/generate-api-docs` - API Documentation Generator
Generates comprehensive API documentation from source code.
**Usage:**
```
/generate-api-docs
```mermaid
graph TD
A["User Input: /command-name"] -->|Triggers| B["Search .claude/commands/"]
B -->|Finds| C["command-name.md"]
C -->|Loads| D["Markdown Content"]
D -->|Executes| E["Claude Processes Prompt"]
E -->|Returns| F["Result in Context"]
```
## File Structure
Place commands in your project:
```mermaid
graph LR
A["Project Root"] -->|contains| B[".claude/commands/"]
B -->|contains| C["optimize.md"]
B -->|contains| D["test.md"]
B -->|contains| E["docs/"]
E -->|contains| F["generate-api-docs.md"]
E -->|contains| G["generate-readme.md"]
```
### Recommended Structure
```
project/
├── .claude/
@@ -50,10 +39,377 @@ project/
│ └── generate-api-docs.md
```
## Command Organization Table
| Location | Scope | Availability | Use Case | Git Tracked |
|----------|-------|--------------|----------|-------------|
| `.claude/commands/` | Project-specific | Team members | Team workflows, shared standards | ✅ Yes |
| `~/.claude/commands/` | Personal | Individual user | Personal shortcuts across projects | ❌ No |
| Subdirectories | Namespaced | Based on parent | Organize by category | ✅ Yes |
## Features & Capabilities
| Feature | Example | Supported |
|---------|---------|-----------|
| Shell script execution | `bash scripts/deploy.sh` | ✅ Yes |
| File references | `@path/to/file.js` | ✅ Yes |
| Bash integration | `$(git log --oneline)` | ✅ Yes |
| Arguments | `/pr --verbose` | ✅ Yes |
| MCP commands | `/mcp__github__list_prs` | ✅ Yes |
## Available Commands in This Folder
### 1. `/optimize` - Code Optimization
Analyzes code for performance issues, memory leaks, and optimization opportunities.
**Usage:**
```
/optimize
[Paste your code]
```
**Reviews for:**
- Performance bottlenecks (O(n²) operations)
- Memory leaks
- Algorithm improvements
- Caching opportunities
- Concurrency issues
### 2. `/pr` - Pull Request Preparation
Guides you through PR preparation checklist including linting, testing, and commit message formatting.
**Usage:**
```
/pr
```
**Checklist includes:**
- Running linting
- Running tests
- Reviewing git diff
- Staging changes
- Creating conventional commit messages
- Generating PR summary
### 3. `/generate-api-docs` - API Documentation Generator
Generates comprehensive API documentation from source code.
**Usage:**
```
/generate-api-docs
```
**Features:**
- Scans all files in `/src/api/`
- Extracts function signatures and JSDoc comments
- Organizes by endpoint/module
- Creates markdown with examples
- Includes request/response schemas
- Adds error documentation
## Command Lifecycle Diagram
```mermaid
sequenceDiagram
participant User
participant Claude as Claude Code
participant FS as File System
participant CLI as Shell/Bash
User->>Claude: Types /optimize
Claude->>FS: Searches .claude/commands/
FS-->>Claude: Returns optimize.md
Claude->>Claude: Loads Markdown content
Claude->>User: Displays prompt context
User->>Claude: Provides code to analyze
Claude->>CLI: (May execute scripts)
CLI-->>Claude: Results
Claude->>User: Returns analysis
```
## Installation
### For Project-wide Use (Team)
Copy these files to your project's `.claude/commands/` directory:
```bash
# Create commands directory if it doesn't exist
mkdir -p .claude/commands
# Copy command files
cp 01-slash-commands/*.md .claude/commands/
# Copy subdirectory commands
cp -r 01-slash-commands/docs .claude/commands/
```
### For Personal Use
Copy to your personal Claude commands directory:
```bash
# Create personal commands directory
mkdir -p ~/.claude/commands
# Copy command files
cp 01-slash-commands/*.md ~/.claude/commands/
```
## Creating Your Own Commands
### Basic Command Template
Create a file `.claude/commands/my-command.md`:
```markdown
---
name: My Command Name
description: What this command does
tags: category, task-type
---
# Command Title
Instructions for Claude:
1. First step
2. Second step
3. Third step
Output format:
- How to format the response
- What to include
```
### Command with Frontmatter
```markdown
---
name: Code Optimization
description: Analyze code for performance issues and suggest optimizations
tags: performance, analysis
---
# Code Optimization
Review the provided code for the following issues in order of priority:
1. **Performance bottlenecks** - identify O(n²) operations, inefficient loops
2. **Memory leaks** - find unreleased resources, circular references
3. **Algorithm improvements** - suggest better algorithms or data structures
Format your response with:
- Issue severity (Critical/High/Medium/Low)
- Location in code
- Explanation
- Recommended fix with code example
```
## Best Practices
- Use clear, action-oriented names
- Document trigger words in description
- Keep commands focused on single task
- Version control project commands
- Organize in subdirectories for categories
| ✅ Do | ❌ Don't |
|------|---------|
| Use clear, action-oriented names | Create commands for one-time tasks |
| Document trigger words in description | Build complex logic in commands |
| Keep commands focused on single task | Create redundant commands |
| Version control project commands | Hardcode sensitive information |
| Organize in subdirectories | Create long lists of commands |
| Use simple, readable prompts | Use abbreviated or cryptic wording |
## Examples
### Example 1: Simple Task Automation
**File:** `.claude/commands/test.md`
```markdown
---
name: Run Tests
description: Execute test suite with coverage report
---
# Test Runner
1. Run the test suite: `npm test`
2. Generate coverage report
3. Summarize results
4. Highlight any failures
```
### Example 2: Multi-step Workflow
**File:** `.claude/commands/deploy.md`
```markdown
---
name: Deploy to Production
description: Complete deployment workflow with checks
---
# Production Deployment
Execute these steps in order:
1. **Pre-deployment checks**
- Run `npm run lint`
- Run `npm test`
- Check git status is clean
2. **Build**
- Run `npm run build`
- Verify build artifacts
3. **Deploy**
- Run `npm run deploy`
- Monitor deployment logs
4. **Post-deployment**
- Run smoke tests
- Verify deployment
- Notify team
```
### Example 3: Code Review Command
**File:** `.claude/commands/review.md`
```markdown
---
name: Code Review
description: Comprehensive code review checklist
---
# Code Review
Review the code for:
## Security
- [ ] No hardcoded credentials
- [ ] Input validation present
- [ ] SQL injection prevention
- [ ] XSS prevention
## Performance
- [ ] No N+1 queries
- [ ] Appropriate indexing
- [ ] Efficient algorithms
## Quality
- [ ] Clear naming
- [ ] Proper error handling
- [ ] Adequate comments
- [ ] No code duplication
```
## Advanced Usage
### Using Arguments
Commands can accept arguments:
```bash
/deploy production
/review --verbose
/test --coverage
```
Handle arguments in your command file:
```markdown
# Deployment Command
Check the provided argument for environment:
- If "production", use strict checks
- If "staging", allow warnings
- If "development", skip certain validations
```
### Integrating with MCP
Commands can use MCP tools:
```markdown
# GitHub PR Command
1. Use MCP to list open PRs: `/mcp__github__list_prs`
2. Analyze each PR for:
- Review status
- CI/CD status
- Merge conflicts
3. Provide summary
```
### Hierarchical Commands
Organize related commands in subdirectories:
```
.claude/commands/
├── deploy/
│ ├── production.md
│ ├── staging.md
│ └── rollback.md
├── test/
│ ├── unit.md
│ ├── integration.md
│ └── e2e.md
└── docs/
├── api.md
└── readme.md
```
Access with: `/deploy/production`, `/test/unit`, `/docs/api`
## Troubleshooting
### Command Not Found
**Problem:** Claude doesn't recognize `/my-command`
**Solutions:**
- Check file is in `.claude/commands/` directory
- Verify filename matches command name
- Restart Claude Code session
- Check file has `.md` extension
### Command Not Executing as Expected
**Problem:** Command loads but doesn't work correctly
**Solutions:**
- Review command prompt clarity
- Add more specific instructions
- Include examples in command file
- Test with simple inputs first
### Personal vs Project Commands
**When to use personal commands:**
- Personal preferences/workflows
- Not relevant to team
- Experimental commands
- Cross-project shortcuts
**When to use project commands:**
- Team standards
- Project-specific workflows
- Shared conventions
- Onboarding helpers
## 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
## Resources
- [Claude Code Commands Documentation](https://docs.claude.com/en/docs/claude-code/custom-commands)
- [Markdown Guide](https://www.markdownguide.org/)
- [Command Examples Repository](https://github.com/anthropics/claude-code-examples)
---
*Part of the [Claude How To](../) guide series*