CalvinBackup/claude-howto
1
0
Fork 0
mirror of https://github.com/luongnv89/claude-howto.git synced 2026-08-08 00:08:36 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
4f3fa85d7ed0f0f77f0d8bba3f0b40ff10b2063b
claude-howto/INDEX.md
T
Luong NGUYENandGitHub 4f3fa85d7e docs: follow-ups from the v2.1.220 accuracy review (#161) 
* fix(ci): move the EPUB build out of pre-commit into CI

The build-epub hooks called scripts/build_epub.py, which raises when the
mmdc binary is missing, while check_mermaid.py skips with a warning in the
same situation. On arm64 — where @mermaid-js/mermaid-cli has no working
build — that made 'pre-commit run --all-files' impossible to satisfy for a
docs-only change without --no-verify.

Remove the build-epub, vietnamese-build-epub and japanese-build-epub hooks
and widen the CI build-epub job to a language matrix so PR-time coverage is
not reduced: it previously built en only, and now builds en, vi, zh and ja.
zh was covered by neither the hooks nor this job, so a broken zh diagram
could only surface at release time.

Closes #156

* docs: replace the stale Kroki narrative with local mmdc rendering

Commit e76bbe4 swapped the Kroki HTTP dependency for local mmdc rendering
but left the docs describing the old design. The claim appeared in seven
live files, not the two originally reported: CLAUDE.md, scripts/README.md
and their ja/uk/vi copies.

Also corrects what the same staleness dragged along:
- scripts/README.md documented --timeout and --max-concurrent, which no
  longer exist, and omitted --mmdc-path, --lang and --puppeteer-config
- 'Async concurrent fetching' described a render_all() that is now a plain
  sequential loop with a dedupe cache
- the network-error/rate-limiting troubleshooting entries are replaced with
  the failures that actually occur now (missing mmdc, Chromium sandbox)

CHANGELOG entries recording the Kroki-to-mmdc switch are left alone; they
describe the past accurately.

Closes #157

* fix(scripts): make the ruff config match files that exist

Ruff resolves include/per-file-ignores patterns relative to the directory
holding pyproject.toml. Since the config lives in scripts/, the pattern
"scripts/**/*.py" meant scripts/scripts/**/*.py, which matches nothing —
'ruff check scripts/' printed 'warning: No Python files found under the
given path(s)' and then 'All checks passed!'. per-file-ignores had the same
mistake. Both are now relative to scripts/, so ruff sees all 14 files.

This silently disabled the pre-commit ruff hooks too, not just the
documented command, and two test files had drifted out of format as a
result. Reformatting them exposed a second problem: the pre-commit hook
pinned ruff v0.8.2 while the CI lint job installs unpinned latest and this
venv has 0.15.10. The versions disagree on formatting, so each reverted the
other's output, and CI would have started failing on a file the local hook
kept rewriting. Bump the hook pin and the requirements-dev floor to 0.15.10
so all three agree.

Verified: 'pre-commit run --all-files' is stable across consecutive runs,
'ruff format --check scripts/' and 'ruff check scripts/' both pass, 92
tests pass.

Closes #160

* docs: point localized module links at their own trees

Files at the root of a language directory used ../NN-module/, which from
uk/CATALOG.md resolves to the English 05-mcp/ at the repo root rather than
uk/05-mcp/. Readers following a count stated about the localized tree
landed in the English one. The link checker never caught it because the
English target does exist.

Files one level deeper (uk/04-subagents/README.md and friends) were already
correct — ../06-hooks/ from there resolves to uk/06-hooks/ — so this is
scoped to the 7 depth-1 files that actually escape: CATALOG.md in uk, vi,
ja and zh, LEARNING-ROADMAP.md in uk and vi, and ja/claude_concepts_guide.md.
119 links in total.

The ../NN- occurrences left in STYLE_GUIDE.md and TRANSLATION_NOTES.md are
inside fenced examples showing what a module page should contain, where the
../ form is the correct convention. All 119 rewritten targets were verified
to exist.

Closes #158

* docs(hooks): stop conflating hook types with hook event categories

'**Hook Types** (5 types, 31 events)' sat above four bullets, so the count
read as wrong. It was not — the two numbers describe different axes that
had been merged into one label.

06-hooks/README.md:126 documents five hook *types*: command, http, prompt,
mcp_tool and agent. Those describe how a hook runs. The four bullets are
event *categories* — Tool, Session, Task, Lifecycle — holding 31 events
(6+7+6+12), and describe when it runs.

Split the label so each number belongs to the axis it counts, in all nine
affected files: README.md and INDEX.md plus the ja, uk, vi and zh copies.
QUICK_REFERENCE.md and LEARNING-ROADMAP.md already stated '5 types' with
the handler names attached and needed no change.

Closes #159

* chore(scripts): drop the unused httpx dependency

httpx was the HTTP client for Kroki rendering. Nothing has imported it
since e76bbe4 moved diagram rendering to a local mmdc subprocess —
check_links.py, the only other network caller, uses stdlib urllib.request.
The PEP 723 blocks in build_epub.py and build_website.py had already
dropped it; only the manifests and docs still declared it.

Removes it from requirements.txt, pyproject.toml dependencies, the
dependency tables and uv --with lines in scripts/README.md and its ja/uk
copies, and the .cspell.json word list. Also drops the B113 bandit
suppression, which existed solely for an httpx timeout false positive —
bandit reports no issues without it.

Also corrects two Requirements lines missed in the previous pass: the ja
and uk script READMEs still listed an internet connection rather than mmdc.

Note: tenacity is now dead for the same reason and is left in place.

* chore(scripts): drop the unused tenacity dependency

Nothing imports tenacity — the retry logic it was added for went away
with the Kroki HTTP fetching in e76bbe4. It was still declared in
requirements.txt, pyproject.toml, both `uv run --with` lines and all
three dependency tables.

* docs(i18n): sync the localized pre-commit check lists

The ja/uk/vi CLAUDE.md files still listed build-epub as pre-commit
check #5, stale since 6da8184 moved the EPUB build to CI. They also
omitted markdown-rendering, and the ja/uk stated counts disagreed with
their own lists. Now matches the English CLAUDE.md.

* fix(scripts): silence PLR0917 now stable in ruff 0.16

CI installs the latest ruff (uv pip install ruff, unpinned), and 0.16.1
promoted too-many-positional-arguments from preview to stable, hard-failing
the Code Quality check on build_epub.py's long-signature draw/helper
functions. These sit in the same family as PLR0913, which is already
ignored. Add PLR0917 so the local 0.15.10 pin and unpinned CI lint agree
again.
2026-08-06 07:58:46 +07:00

908 lines
31 KiB
Markdown
Raw Blame History

<picture>
<source media="(prefers-color-scheme: dark)" srcset="resources/logos/claude-howto-logo-dark.svg">
<img alt="Claude How To" src="resources/logos/claude-howto-logo.svg">
</picture>
# Claude Code Examples - Complete Index
This document provides a complete index of all example files organized by feature type.
## Summary Statistics
- **Total Files**: 100+ files
- **Categories**: 10 feature categories
- **Plugins**: 3 complete plugins
- **Skills**: 6 complete skills
- **Hooks**: 8 example hooks
- **Ready to Use**: All examples
---
## 01. Slash Commands (10 files)
User-invoked shortcuts for common workflows.
| File | Description | Use Case |
|------|-------------|----------|
| `optimize.md` | Code optimization analyzer | Find performance issues |
| `pr.md` | Pull request preparation | PR workflow automation |
| `generate-api-docs.md` | API documentation generator | Generate API docs |
| `commit.md` | Commit message helper | Standardized commits |
| `setup-ci-cd.md` | CI/CD pipeline setup | DevOps automation |
| `push-all.md` | Push all changes | Quick push workflow |
| `unit-test-expand.md` | Expand unit test coverage | Test automation |
| `doc-refactor.md` | Documentation refactoring | Doc improvements |
| `pr-slash-command.png` | Screenshot example | Visual reference |
| `README.md` | Documentation | Setup and usage guide |
**Installation Path**: `.claude/commands/`
**Usage**: `/optimize`, `/pr`, `/generate-api-docs`, `/commit`, `/setup-ci-cd`, `/push-all`, `/unit-test-expand`, `/doc-refactor`
---
## 02. Memory (6 files)
Persistent context and project standards.
| File | Description | Scope | Location |
|------|-------------|-------|----------|
| `project-CLAUDE.md` | Team project standards | Project-wide | `./CLAUDE.md` |
| `directory-api-CLAUDE.md` | API-specific rules | Directory | `./src/api/CLAUDE.md` |
| `personal-CLAUDE.md` | Personal preferences | User | `~/.claude/CLAUDE.md` |
| `memory-saved.png` | Screenshot: memory saved | - | Visual reference |
| `memory-ask-claude.png` | Screenshot: ask Claude | - | Visual reference |
| `README.md` | Documentation | - | Reference |
**Installation**: Copy to appropriate location
**Usage**: Automatically loaded by Claude
---
## 03. Skills (23 files)
Auto-invoked capabilities with scripts and templates.
### Code Review Skill (5 files)
```
code-review-specialist/
├── SKILL.md # Skill definition
├── scripts/
│ ├── analyze-metrics.py # Code metrics analyzer
│ └── compare-complexity.py # Complexity comparison
└── templates/
├── review-checklist.md # Review checklist
└── finding-template.md # Finding documentation
```
**Purpose**: Comprehensive code review with security, performance, and quality analysis
**Auto-invoked**: When reviewing code
---
### Brand Voice Skill (4 files)
```
brand-voice/
├── SKILL.md # Skill definition
├── templates/
│ ├── email-template.txt # Email format
│ └── social-post-template.txt # Social media format
└── tone-examples.md # Example messages
```
**Purpose**: Ensure consistent brand voice in communications
**Auto-invoked**: When creating marketing copy
---
### Documentation Generator Skill (2 files)
```
doc-generator/
├── SKILL.md # Skill definition
└── generate-docs.py # Python doc extractor
```
**Purpose**: Generate comprehensive API documentation from source code
**Auto-invoked**: When creating/updating API documentation
---
### Refactor Skill (5 files)
```
refactor/
├── SKILL.md # Skill definition
├── scripts/
│ ├── analyze-complexity.py # Complexity analyzer
│ └── detect-smells.py # Code smell detector
├── references/
│ ├── code-smells.md # Code smells catalog
│ └── refactoring-catalog.md # Refactoring patterns
└── templates/
└── refactoring-plan.md # Refactoring plan template
```
**Purpose**: Systematic code refactoring with complexity analysis
**Auto-invoked**: When refactoring code
---
### Claude MD Skill (1 file)
```
claude-md/
└── SKILL.md # Skill definition
```
**Purpose**: Manage and optimize CLAUDE.md files
---
### Blog Draft Skill (3 files)
```
blog-draft/
├── SKILL.md # Skill definition
└── templates/
├── draft-template.md # Blog draft template
└── outline-template.md # Blog outline template
```
**Purpose**: Draft blog posts with consistent structure
**Plus**: `README.md` - Skills overview and usage guide
**Installation Path**: `~/.claude/skills/` or `.claude/skills/`
---
## 04. Subagents (10 files)
Specialized AI assistants with custom capabilities.
| File | Description | Tools | Use Case |
|------|-------------|-------|----------|
| `code-reviewer.md` | Code quality analysis | Read, Grep, Glob, Bash | Comprehensive reviews |
| `test-engineer.md` | Test coverage analysis | Read, Write, Bash, Grep | Test automation |
| `documentation-writer.md` | Documentation creation | Read, Write, Grep | Doc generation |
| `secure-reviewer.md` | Security review (read-only) | Read, Grep | Security audits |
| `implementation-agent.md` | Full implementation | Read, Write, Edit, Bash, Grep, Glob | Feature development |
| `debugger.md` | Debugging specialist | Read, Edit, Bash, Grep, Glob | Bug investigation |
| `data-scientist.md` | Data analysis specialist | Bash, Read, Write | Data workflows |
| `clean-code-reviewer.md` | Clean code standards | Read, Grep, Glob, Bash | Code quality |
| `performance-optimizer.md` | Performance bottleneck analysis | Read, Edit, Bash, Grep, Glob | Optimization work |
| `README.md` | Documentation | - | Setup and usage guide |
**Installation Path**: `.claude/agents/`
**Usage**: Automatically delegated by main agent
---
## 05. MCP Protocol (5 files)
External tool and API integrations.
| File | Description | Integrates With | Use Case |
|------|-------------|-----------------|----------|
| `github-mcp.json` | GitHub integration | GitHub API | PR/issue management |
| `database-mcp.json` | Database queries | PostgreSQL/MySQL | Live data queries |
| `filesystem-mcp.json` | File operations | Local filesystem | File management |
| `multi-mcp.json` | Multiple servers | GitHub + DB + Slack | Complete integration |
| `README.md` | Documentation | - | Setup and usage guide |
**Installation Path**: `.mcp.json` (project scope) or `~/.claude.json` (user scope)
**Usage**: `/mcp__github__list_prs`, etc.
---
## 06. Hooks (12 files)
Event-driven automation scripts that execute automatically.
| File | Description | Event | Use Case |
|------|-------------|-------|----------|
| `format-code.sh` | Auto-format code | PostToolUse (matcher: Write) | Code formatting |
| `pre-commit.sh` | Run tests before commit | PreToolUse (matcher: Bash) | Test automation |
| `pre-tool-check.sh` | Validate and audit commands before they run | PreToolUse (matcher: Bash) | Guardrails, audit log |
| `security-scan.sh` | Security scanning | PostToolUse (matcher: Write) | Security checks |
| `dependency-check.sh` | Scan dependency manifests for vulnerabilities | PostToolUse (matcher: Write) | Supply-chain checks |
| `log-bash.sh` | Log bash commands | PostToolUse (matcher: Bash) | Command logging |
| `notify-team.sh` | Send notifications | PostToolUse (matcher: Bash) | Team notifications |
| `validate-prompt.sh` | Validate prompts | UserPromptSubmit | Input validation |
| `session-end.sh` | Capture progress when a session ends | SessionEnd | Progress tracking |
| `context-tracker.py` | Track context window usage | UserPromptSubmit, Stop | Context monitoring |
| `context-tracker-tiktoken.py` | Token-based context tracking | UserPromptSubmit, Stop | Precise token counting |
| `README.md` | Documentation | - | Setup and usage guide |
**Installation Path**: Configure in `~/.claude/settings.json`
**Usage**: Configured in settings, executed automatically
**Hook Types** (5): `command`, `http`, `prompt`, `mcp_tool`, `agent` — how a hook runs.
**Hook Events** (31, in 4 categories) — when it runs:
- Tool Hooks: PreToolUse, PostToolUse, PostToolUseFailure, PostToolBatch, PermissionRequest, PermissionDenied
- Session Hooks: SessionStart, Setup, SessionEnd, Stop, StopFailure, SubagentStart, SubagentStop
- Task Hooks: UserPromptSubmit, UserPromptExpansion, MessageDisplay, TaskCompleted, TaskCreated, TeammateIdle
- Lifecycle Hooks: ConfigChange, CwdChanged, DirectoryAdded, FileChanged, PreCompact, PostCompact, WorktreeCreate, WorktreeRemove, Notification, InstructionsLoaded, Elicitation, ElicitationResult
---
## 07. Plugins (3 complete plugins, 39 files)
Bundled collections of features.
### PR Review Plugin (10 files)
```
pr-review/
├── .claude-plugin/
│ └── plugin.json # Plugin manifest
├── commands/
│ ├── review-pr.md # Comprehensive review
│ ├── check-security.md # Security check
│ └── check-tests.md # Test coverage check
├── agents/
│ ├── security-reviewer.md # Security specialist
│ ├── test-checker.md # Test specialist
│ └── performance-analyzer.md # Performance specialist
├── mcp/
│ └── github-config.json # GitHub integration
├── hooks/
│ └── pre-review.js # Pre-review validation
└── README.md # Plugin documentation
```
**Features**: Security analysis, test coverage, performance impact
**Commands**: `/review-pr`, `/check-security`, `/check-tests`
**Installation**: `/plugin install pr-review`
---
### DevOps Automation Plugin (15 files)
```
devops-automation/
├── .claude-plugin/
│ └── plugin.json # Plugin manifest
├── commands/
│ ├── deploy.md # Deployment
│ ├── rollback.md # Rollback
│ ├── status.md # System status
│ └── incident.md # Incident response
├── agents/
│ ├── deployment-specialist.md # Deployment expert
│ ├── incident-commander.md # Incident coordinator
│ └── alert-analyzer.md # Alert analyzer
├── mcp/
│ └── kubernetes-config.json # Kubernetes integration
├── hooks/
│ ├── pre-deploy.js # Pre-deployment checks
│ └── post-deploy.js # Post-deployment tasks
├── scripts/
│ ├── deploy.sh # Deployment automation
│ ├── rollback.sh # Rollback automation
│ └── health-check.sh # Health checks
└── README.md # Plugin documentation
```
**Features**: Kubernetes deployment, rollback, monitoring, incident response
**Commands**: `/deploy`, `/rollback`, `/status`, `/incident`
**Installation**: `/plugin install devops-automation`
---
### Documentation Plugin (14 files)
```
documentation/
├── .claude-plugin/
│ └── plugin.json # Plugin manifest
├── commands/
│ ├── generate-api-docs.md # API docs generation
│ ├── generate-readme.md # README creation
│ ├── sync-docs.md # Doc synchronization
│ └── validate-docs.md # Doc validation
├── agents/
│ ├── api-documenter.md # API doc specialist
│ ├── code-commentator.md # Code comment specialist
│ └── example-generator.md # Example creator
├── mcp/
│ └── github-docs-config.json # GitHub integration
├── templates/
│ ├── api-endpoint.md # API endpoint template
│ ├── function-docs.md # Function doc template
│ └── adr-template.md # ADR template
└── README.md # Plugin documentation
```
**Features**: API docs, README generation, doc sync, validation
**Commands**: `/generate-api-docs`, `/generate-readme`, `/sync-docs`, `/validate-docs`
**Installation**: `/plugin install documentation`
**Plus**: `README.md` - Plugins overview and usage guide
---
## 08. Checkpoints and Rewind (2 files)
Save conversation state and explore alternative approaches.
| File | Description | Content |
|------|-------------|---------|
| `README.md` | Documentation | Comprehensive checkpoint guide |
| `checkpoint-examples.md` | Real-world examples | Database migration, performance optimization, UI iteration, debugging |
| | | |
**Key Concepts**:
- **Checkpoint**: Snapshot of conversation state
- **Rewind**: Return to previous checkpoint
- **Branch Point**: Explore multiple approaches
**Usage**:
```
# Checkpoints are created automatically with every user prompt
# To rewind, press Esc twice or use:
/rewind
# Then choose: Restore code and conversation, Restore conversation,
# Restore code, Summarize from here, or Never mind
```
**Use Cases**:
- Try different implementations
- Recover from mistakes
- Safe experimentation
- Compare solutions
- A/B testing
---
## 09. Advanced Features (4 files)
Advanced capabilities for complex workflows.
| File | Description | Features |
|------|-------------|----------|
| `README.md` | Complete guide | All advanced features documentation |
| `config-examples.json` | Configuration examples | 10+ use-case-specific configurations |
| `planning-mode-examples.md` | Planning examples | REST API, database migration, refactoring |
| `setup-auto-mode-permissions.py` | Seed `permissions.allow` for auto mode | Idempotent, `--dry-run` and opt-in flags |
| Dynamic Workflows | Deterministic multi-agent orchestration via `/workflows` (v2.1.154) | Comprehensive audits, migrations, scale-out |
| Scheduled Tasks | Recurring tasks with `/loop` and cron tools | Automated recurring workflows |
| Chrome Integration | Browser automation via headless Chromium | Web testing and scraping |
| Remote Control (expanded) | Connection methods, security, comparison table | Remote session management |
| Keyboard Customization | Custom keybindings, chord support, contexts | Personalized shortcuts |
| Desktop App (expanded) | Connectors, launch.json, enterprise features | Desktop integration |
| | | |
**Advanced Features Covered**:
### Planning Mode
- Create detailed implementation plans
- Time estimates and risk assessment
- Systematic task breakdown
### Extended Thinking
- Deep reasoning for complex problems
- Architectural decision analysis
- Trade-off evaluation
### Background Tasks
- Long-running operations without blocking
- Parallel development workflows
- Task management and monitoring
### Dynamic Workflows (v2.1.154)
- Deterministic orchestration of tens-to-hundreds of background subagents
- Fan-out / pipeline / parallel stages for comprehensive coverage
- View runs with `/workflows`; `ultracode` `/effort` turns it on for a session
- Default size guideline is medium (aim for fewer than 15 agents) as of v2.1.219 — change it with **Dynamic workflow size** in `/config`
### Permission Modes
- **manual**: Ask for approval on risky actions (renamed from `default` in v2.1.200; `default` still accepted)
- **acceptEdits**: Auto-accept file edits, ask for others
- **plan**: Read-only analysis, no modifications
- **auto**: Everything, with background safety checks — a classifier reviews commands and protected-directory writes (configured via the `autoMode` settings object)
- **dontAsk**: Only pre-approved tools — auto-denies every call that would otherwise prompt. Claude runs only `permissions.allow` matches, read-only Bash commands, and calls approved by a `PreToolUse` hook
- **bypassPermissions**: Accept all (requires `--dangerously-skip-permissions`)
### Headless Mode (`claude -p`)
- CI/CD integration
- Automated task execution
- Batch processing
### Session Management
- Multiple work sessions
- Session switching and saving
- Session persistence
### Interactive Features
- Keyboard shortcuts
- Command history
- Tab completion
- Multi-line input
### Configuration
- Comprehensive settings management
- Environment-specific configs
- Per-project customization
### Scheduled Tasks
- Recurring tasks with `/loop` command
- Cron tools: CronCreate, CronList, CronDelete
- Automated recurring workflows
### Chrome Integration
- Browser automation via headless Chromium
- Web testing and scraping capabilities
- Page interaction and data extraction
### Remote Control (expanded)
- Connection methods and protocols
- Security considerations and best practices
- Comparison table of remote access options
### Keyboard Customization
- Custom keybindings configuration
- Chord support for multi-key shortcuts
- Context-aware keybinding activation
### Desktop App (expanded)
- Connectors for IDE integration
- launch.json configuration
- Enterprise features and deployment
---
## 10. CLI Usage (1 file)
Command-line interface usage patterns and reference.
| File | Description | Content |
|------|-------------|---------|
| `README.md` | CLI documentation | Flags, options, and usage patterns |
**Key CLI Features**:
- `claude` - Start interactive session
- `claude -p "prompt"` - Headless/non-interactive mode
- `claude web` - Launch web session
- `claude --model` - Select model (Opus 5, Sonnet 5, Sonnet 4.6, Opus 4.8, Haiku 4.5)
- `claude --permission-mode` - Set permission mode
- `claude --remote` - Enable remote control via WebSocket
---
## Documentation Files (13 files)
| File | Location | Description |
|------|----------|-------------|
| `README.md` | `/` | Main examples overview |
| `INDEX.md` | `/` | This complete index |
| `QUICK_REFERENCE.md` | `/` | Quick reference card |
| `README.md` | `/01-slash-commands/` | Slash commands guide |
| `README.md` | `/02-memory/` | Memory guide |
| `README.md` | `/03-skills/` | Skills guide |
| `README.md` | `/04-subagents/` | Subagents guide |
| `README.md` | `/05-mcp/` | MCP guide |
| `README.md` | `/06-hooks/` | Hooks guide |
| `README.md` | `/07-plugins/` | Plugins guide |
| `README.md` | `/08-checkpoints/` | Checkpoints guide |
| `README.md` | `/09-advanced-features/` | Advanced features guide |
| `README.md` | `/10-cli/` | CLI guide |
---
## Complete File Tree
```
claude-howto/
├── README.md # Main overview
├── INDEX.md # This file
├── QUICK_REFERENCE.md # Quick reference card
├── claude_concepts_guide.md # Original guide
│
├── 01-slash-commands/ # Slash Commands
│ ├── optimize.md
│ ├── pr.md
│ ├── generate-api-docs.md
│ ├── commit.md
│ ├── setup-ci-cd.md
│ ├── push-all.md
│ ├── unit-test-expand.md
│ ├── doc-refactor.md
│ ├── pr-slash-command.png
│ └── README.md
│
├── 02-memory/ # Memory
│ ├── project-CLAUDE.md
│ ├── directory-api-CLAUDE.md
│ ├── personal-CLAUDE.md
│ ├── memory-saved.png
│ ├── memory-ask-claude.png
│ └── README.md
│
├── 03-skills/ # Skills
│ ├── code-review-specialist/
│ │ ├── SKILL.md
│ │ ├── scripts/
│ │ │ ├── analyze-metrics.py
│ │ │ └── compare-complexity.py
│ │ └── templates/
│ │ ├── review-checklist.md
│ │ └── finding-template.md
│ ├── brand-voice/
│ │ ├── SKILL.md
│ │ ├── templates/
│ │ │ ├── email-template.txt
│ │ │ └── social-post-template.txt
│ │ └── tone-examples.md
│ ├── doc-generator/
│ │ ├── SKILL.md
│ │ └── generate-docs.py
│ ├── refactor/
│ │ ├── SKILL.md
│ │ ├── scripts/
│ │ │ ├── analyze-complexity.py
│ │ │ └── detect-smells.py
│ │ ├── references/
│ │ │ ├── code-smells.md
│ │ │ └── refactoring-catalog.md
│ │ └── templates/
│ │ └── refactoring-plan.md
│ ├── claude-md/
│ │ └── SKILL.md
│ ├── blog-draft/
│ │ ├── SKILL.md
│ │ └── templates/
│ │ ├── draft-template.md
│ │ └── outline-template.md
│ └── README.md
│
├── 04-subagents/ # Subagents
│ ├── code-reviewer.md
│ ├── test-engineer.md
│ ├── documentation-writer.md
│ ├── secure-reviewer.md
│ ├── implementation-agent.md
│ ├── debugger.md
│ ├── data-scientist.md
│ ├── clean-code-reviewer.md
│ └── README.md
│
├── 05-mcp/ # MCP Protocol
│ ├── github-mcp.json
│ ├── database-mcp.json
│ ├── filesystem-mcp.json
│ ├── multi-mcp.json
│ └── README.md
│
├── 06-hooks/ # Hooks
│ ├── format-code.sh
│ ├── pre-commit.sh
│ ├── security-scan.sh
│ ├── log-bash.sh
│ ├── validate-prompt.sh
│ ├── notify-team.sh
│ ├── context-tracker.py
│ ├── context-tracker-tiktoken.py
│ └── README.md
│
├── 07-plugins/ # Plugins
│ ├── pr-review/
│ │ ├── .claude-plugin/
│ │ │ └── plugin.json
│ │ ├── commands/
│ │ │ ├── review-pr.md
│ │ │ ├── check-security.md
│ │ │ └── check-tests.md
│ │ ├── agents/
│ │ │ ├── security-reviewer.md
│ │ │ ├── test-checker.md
│ │ │ └── performance-analyzer.md
│ │ ├── mcp/
│ │ │ └── github-config.json
│ │ ├── hooks/
│ │ │ └── pre-review.js
│ │ └── README.md
│ ├── devops-automation/
│ │ ├── .claude-plugin/
│ │ │ └── plugin.json
│ │ ├── commands/
│ │ │ ├── deploy.md
│ │ │ ├── rollback.md
│ │ │ ├── status.md
│ │ │ └── incident.md
│ │ ├── agents/
│ │ │ ├── deployment-specialist.md
│ │ │ ├── incident-commander.md
│ │ │ └── alert-analyzer.md
│ │ ├── mcp/
│ │ │ └── kubernetes-config.json
│ │ ├── hooks/
│ │ │ ├── pre-deploy.js
│ │ │ └── post-deploy.js
│ │ ├── scripts/
│ │ │ ├── deploy.sh
│ │ │ ├── rollback.sh
│ │ │ └── health-check.sh
│ │ └── README.md
│ ├── documentation/
│ │ ├── .claude-plugin/
│ │ │ └── plugin.json
│ │ ├── commands/
│ │ │ ├── generate-api-docs.md
│ │ │ ├── generate-readme.md
│ │ │ ├── sync-docs.md
│ │ │ └── validate-docs.md
│ │ ├── agents/
│ │ │ ├── api-documenter.md
│ │ │ ├── code-commentator.md
│ │ │ └── example-generator.md
│ │ ├── mcp/
│ │ │ └── github-docs-config.json
│ │ ├── templates/
│ │ │ ├── api-endpoint.md
│ │ │ ├── function-docs.md
│ │ │ └── adr-template.md
│ │ └── README.md
│ └── README.md
│
├── 08-checkpoints/ # Checkpoints
│ ├── checkpoint-examples.md
│ └── README.md
│
├── 09-advanced-features/ # Advanced Features
│ ├── config-examples.json
│ ├── planning-mode-examples.md
│ └── README.md
│
└── 10-cli/ # CLI Usage
└── README.md
```
---
## Quick Start by Use Case
### Code Quality & Reviews
```bash
# Install slash command
cp 01-slash-commands/optimize.md .claude/commands/
# Install subagent
cp 04-subagents/code-reviewer.md .claude/agents/
# Install skill
cp -r 03-skills/code-review-specialist ~/.claude/skills/
# Or install complete plugin
/plugin install pr-review
```
### DevOps & Deployment
```bash
# Install plugin (includes everything)
/plugin install devops-automation
```
### Documentation
```bash
# Install slash command
cp 01-slash-commands/generate-api-docs.md .claude/commands/
# Install subagent
cp 04-subagents/documentation-writer.md .claude/agents/
# Install skill
cp -r 03-skills/doc-generator ~/.claude/skills/
# Or install complete plugin
/plugin install documentation
```
### Team Standards
```bash
# Set up project memory
cp 02-memory/project-CLAUDE.md ./CLAUDE.md
# Edit to match your team's standards
```
### External Integrations
```bash
# Set environment variables
export GITHUB_TOKEN="your_token"
export DATABASE_URL="postgresql://..."
# Install MCP config (project scope)
cp 05-mcp/multi-mcp.json .mcp.json
```
### Automation & Validation
```bash
# Install hooks
mkdir -p ~/.claude/hooks
cp 06-hooks/*.sh ~/.claude/hooks/
chmod +x ~/.claude/hooks/*.sh
# Configure hooks in settings (~/.claude/settings.json)
# See 06-hooks/README.md
```
### Safe Experimentation
```bash
# Checkpoints are created automatically with every user prompt
# To rewind: press Esc+Esc or use /rewind
# Then choose what to restore from the rewind menu
# See 08-checkpoints/README.md for examples
```
### Advanced Workflows
```bash
# Configure advanced features
# See 09-advanced-features/config-examples.json
# Use planning mode
/plan Implement feature X
# Use permission modes
claude --permission-mode plan # For code review (read-only)
claude --permission-mode acceptEdits # Auto-accept edits
claude --permission-mode auto # Auto-approve safe actions
# Run in headless mode for CI/CD
claude -p "Run tests and report results"
# Run background tasks
Run tests in background
# See 09-advanced-features/README.md for complete guide
```
---
## Feature Coverage Matrix
| Category | Commands | Agents | MCP | Hooks | Scripts | Templates | Docs | Images | Total |
|----------|----------|--------|-----|-------|---------|-----------|------|--------|-------|
| **01 Slash Commands** | 8 | - | - | - | - | - | 1 | 1 | **10** |
| **02 Memory** | - | - | - | - | - | 3 | 1 | 2 | **6** |
| **03 Skills** | - | - | - | - | 5 | 7 | 11 | - | **23** |
| **04 Subagents** | - | 9 | - | - | - | - | 1 | - | **10** |
| **05 MCP** | - | - | 4 | - | - | - | 1 | - | **5** |
| **06 Hooks** | - | - | - | 11 | - | - | 1 | - | **12** |
| **07 Plugins** | 11 | 9 | 3 | 3 | 3 | 3 | 7 | - | **39** |
| **08 Checkpoints** | - | - | - | - | - | - | 1 | 1 | **2** |
| **09 Advanced** | - | - | - | - | 1 | 1 | 2 | - | **4** |
| **10 CLI** | - | - | - | - | - | - | 1 | - | **1** |
---
## Learning Path
### Beginner (Week 1)
1. ✅ Read `README.md`
2. ✅ Install 1-2 slash commands
3. ✅ Create project memory file
4. ✅ Try basic commands
### Intermediate (Week 2-3)
1. ✅ Set up GitHub MCP
2. ✅ Install a subagent
3. ✅ Try delegating tasks
4. ✅ Install a skill
### Advanced (Week 4+)
1. ✅ Install complete plugin
2. ✅ Create custom slash commands
3. ✅ Create custom subagent
4. ✅ Create custom skill
5. ✅ Build your own plugin
### Expert (Week 5+)
1. ✅ Set up hooks for automation
2. ✅ Use checkpoints for experimentation
3. ✅ Configure planning mode
4. ✅ Use permission modes effectively
5. ✅ Set up headless mode for CI/CD
6. ✅ Master session management
---
## Search by Keyword
### Performance
- `01-slash-commands/optimize.md` - Performance analysis
- `04-subagents/code-reviewer.md` - Performance review
- `03-skills/code-review-specialist/` - Performance metrics
- `07-plugins/pr-review/agents/performance-analyzer.md` - Performance specialist
### Security
- `04-subagents/secure-reviewer.md` - Security review
- `03-skills/code-review-specialist/` - Security analysis
- `07-plugins/pr-review/` - Security checks
### Testing
- `04-subagents/test-engineer.md` - Test engineer
- `07-plugins/pr-review/commands/check-tests.md` - Test coverage
### Documentation
- `01-slash-commands/generate-api-docs.md` - API docs command
- `04-subagents/documentation-writer.md` - Doc writer agent
- `03-skills/doc-generator/` - Doc generator skill
- `07-plugins/documentation/` - Complete doc plugin
### Deployment
- `07-plugins/devops-automation/` - Complete DevOps solution
### Automation
- `06-hooks/` - Event-driven automation
- `06-hooks/pre-commit.sh` - Pre-commit automation
- `06-hooks/format-code.sh` - Auto-formatting
- `09-advanced-features/` - Headless mode for CI/CD
### Validation
- `06-hooks/security-scan.sh` - Security validation
- `06-hooks/validate-prompt.sh` - Prompt validation
### Experimentation
- `08-checkpoints/` - Safe experimentation with rewind
- `08-checkpoints/checkpoint-examples.md` - Real-world examples
### Planning
- `09-advanced-features/planning-mode-examples.md` - Planning mode examples
- `09-advanced-features/README.md` - Extended thinking
### Configuration
- `09-advanced-features/config-examples.json` - Configuration examples
---
## Notes
- All examples are ready to use
- Modify to fit your specific needs
- Examples follow Claude Code best practices
- Each category has its own README with detailed instructions
- Scripts include proper error handling
- Templates are customizable
---
## Contributing
Want to add more examples? Follow the structure:
1. Create appropriate subdirectory
2. Include README.md with usage
3. Follow naming conventions
4. Test thoroughly
5. Update this index
---
**Last Updated**: August 4, 2026
**Claude Code Version**: 2.1.220
**Sources**:
- https://code.claude.com/docs/en/overview
- https://code.claude.com/docs/en/hooks
- https://code.claude.com/docs/en/commands
- https://code.claude.com/docs/en/permission-modes
- https://github.com/anthropics/claude-code/releases/tag/v2.1.153
- https://github.com/anthropics/claude-code/releases/tag/v2.1.154
- https://github.com/anthropics/claude-code/blob/main/CHANGELOG.md
- https://code.claude.com/docs/en/model-config
**Compatible Models**: Claude Fable 5, Claude Opus 5, Claude Sonnet 5, Claude Sonnet 4.6, Claude Opus 4.8, Claude Haiku 4.5
**Total Examples**: 100+ files
**Categories**: 10 features
**Hooks**: 11 automation scripts
**Configuration Examples**: 10+ scenarios
**Ready to Use**: All examples
Reference in New Issue View Git Blame Copy Permalink