2714159acb
- Add GitHub Actions section to main README Production-Ready Examples - Update examples/README.md with github-actions/ and workflows/ folders - Add complete templates index for CI/CD workflows - Bump version to 2.8 across all documentation files Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
4.9 KiB
4.9 KiB
Claude Code Examples
Ready-to-use templates for Claude Code configuration.
Structure
| Folder | Description |
|---|---|
agents/ |
Custom AI personas for specialized tasks |
skills/ |
Reusable knowledge modules |
commands/ |
Custom slash commands |
hooks/ |
Event-driven automation scripts |
config/ |
Configuration file templates |
memory/ |
CLAUDE.md memory file templates |
scripts/ |
Utility scripts for setup and diagnostics |
github-actions/ |
CI/CD workflows for GitHub Actions |
workflows/ |
Advanced development workflow guides |
Quick Start
- Copy the template you need
- Customize for your project
- Place in the correct location (see paths below)
File Locations
| Type | Project Location | Global Location |
|---|---|---|
| Agents | .claude/agents/ |
~/.claude/agents/ |
| Skills | .claude/skills/ |
~/.claude/skills/ |
| Commands | .claude/commands/ |
~/.claude/commands/ |
| Hooks | .claude/hooks/ |
~/.claude/hooks/ |
| Config | .claude/ |
~/.claude/ |
| Memory | ./CLAUDE.md or .claude/CLAUDE.md |
~/.claude/CLAUDE.md |
Windows: Replace
~/.claude/with%USERPROFILE%\.claude\
Templates Index
Agents
| File | Purpose | Model |
|---|---|---|
| code-reviewer.md | Thorough code review | Sonnet |
| test-writer.md | TDD/BDD test generation | Sonnet |
| security-auditor.md | Security vulnerability detection | Sonnet |
| refactoring-specialist.md | Clean code refactoring | Sonnet |
Skills
| File | Purpose |
|---|---|
| tdd-workflow.md | Test-Driven Development process |
| security-checklist.md | OWASP Top 10 security checks |
Commands
| File | Trigger | Purpose |
|---|---|---|
| commit.md | /commit |
Conventional commit messages |
| pr.md | /pr |
Create well-structured PRs with scope analysis |
| review-pr.md | /review-pr |
PR review workflow |
| release-notes.md | /release-notes |
Generate release notes in 3 formats |
| sonarqube.md | /sonarqube |
Analyze SonarCloud quality issues for PRs |
| generate-tests.md | /generate-tests |
Test generation |
| git-worktree.md | /git-worktree |
Isolated git worktree setup |
Hooks
| File | Event | Purpose |
|---|---|---|
| dangerous-actions-blocker.sh | PreToolUse | Block dangerous commands/edits |
| security-check.* | PreToolUse | Block secrets in commands |
| auto-format.* | PostToolUse | Auto-format after edits |
| notification.sh | Notification | Contextual macOS sound alerts |
See hooks/README.md for complete documentation and examples
Config
| File | Purpose |
|---|---|
| settings.json | Hooks configuration |
| mcp.json | MCP servers setup |
| .gitignore-claude | Git ignore patterns |
Memory
| File | Purpose |
|---|---|
| CLAUDE.md.project-template | Team project memory |
| CLAUDE.md.personal-template | Personal global memory |
Scripts
| File | Purpose | Output |
|---|---|---|
| audit-scan.sh | Fast setup audit scanner | JSON / Human |
| check-claude.sh | Health check diagnostics | Human |
| clean-reinstall-claude.sh | Clean reinstall procedure | Human |
Usage:
./audit-scan.shfor human output,./audit-scan.sh --jsonfor JSON output
GitHub Actions
| File | Trigger | Purpose |
|---|---|---|
| claude-pr-auto-review.yml | PR open/update | Auto code review with inline comments |
| claude-security-review.yml | PR open/update | Security-focused scan (OWASP) |
| claude-issue-triage.yml | Issue opened | Auto-triage with labels and severity |
See github-actions/README.md for setup instructions and customization
Workflows
| File | Purpose |
|---|---|
| database-branch-setup.md | Isolated feature dev with database branches (Neon/PlanetScale) |
See the main guide for detailed explanations.