luongnv89/claude-howto

Location: 01-slash-commands/

What: User-invoked shortcuts stored as Markdown files

Examples:

• optimize.md - Code optimization analysis
• pr.md - Pull request preparation
• generate-api-docs.md - API documentation generator

Installation:

cp 01-slash-commands/*.md /path/to/project/.claude/commands/

Usage:

/optimize
/pr
/generate-api-docs

Learn More: Discovering Claude Code Slash Commands

Location: 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:

# 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

Location: 03-skills/

What: Reusable, auto-invoked capabilities with instructions and scripts

Examples:

• code-review-specialist/ - Comprehensive code review with scripts
• brand-voice/ - Brand voice consistency checker
• doc-generator/ - API documentation generator

Installation:

# Personal skills
cp -r 03-skills/code-review-specialist ~/.claude/skills/

# Project skills
cp -r 03-skills/code-review-specialist /path/to/project/.claude/skills/

Usage: Automatically invoked when relevant

Location: 04-subagents/

What: Specialized AI assistants with isolated contexts and custom prompts

Examples:

• code-reviewer.md - Comprehensive code quality analysis
• test-engineer.md - Test strategy and coverage
• documentation-writer.md - Technical documentation
• secure-reviewer.md - Security-focused review (read-only)
• implementation-agent.md - Full feature implementation

Installation:

cp 04-subagents/*.md /path/to/project/.claude/agents/

Usage: Automatically delegated by main agent

Location: 05-mcp/

What: Model Context Protocol for accessing external tools and APIs

Examples:

• github-mcp.json - GitHub integration
• database-mcp.json - Database queries
• filesystem-mcp.json - File operations
• multi-mcp.json - Multiple MCP servers

Installation:

# Set environment variables
export DATABASE_URL="postgresql://..."

# Add MCP server via CLI
claude mcp add --transport http github https://api.githubcopilot.com/mcp/ --header "Authorization: Bearer YOUR_GITHUB_PAT"

# Or add to project .mcp.json manually (see 05-mcp/ for examples)

Usage: MCP tools are automatically available to Claude once configured

Location: 06-hooks/

What: Event-driven shell commands that execute automatically in response to Claude Code events

Examples:

• format-code.sh - Auto-format code after writing
• pre-commit.sh - Run tests before commits
• security-scan.sh - Scan for security issues
• log-bash.sh - Log all bash commands
• validate-prompt.sh - Validate user prompts
• notify-team.sh - Send notifications on events

Installation:

mkdir -p ~/.claude/hooks
cp 06-hooks/*.sh ~/.claude/hooks/
chmod +x ~/.claude/hooks/*.sh

Configure hooks in ~/.claude/settings.json:

{
  "hooks": {
    "PostToolUse": [
      {
        "matcher": "Write",
        "hooks": [
          { "type": "command", "command": "~/.claude/hooks/format-code.sh" },
          { "type": "command", "command": "~/.claude/hooks/security-scan.sh" }
        ]
      }
    ]
  }
}

Usage: Hooks execute automatically on events

Hook Types (5): command, http, prompt, mcp_tool, agent — how a hook runs.

Hook Events (33, 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 — TaskCompleted and TaskCreated only fire when the todo tools are enabled, which is available by default only on Claude 3.x models, Opus 4 through 4.7, Sonnet 4 through 4.6, and Haiku 4.5 (CLAUDE_CODE_ENABLE_TODO_TOOLS=1 restores them)
• Lifecycle Hooks: ConfigChange, CwdChanged, DirectoryAdded, FileChanged, PreCompact, PostCompact, PreModelSwitch, PostModelSwitch, WorktreeCreate, WorktreeRemove, Notification, InstructionsLoaded, Elicitation, ElicitationResult

Location: 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:

# From the repo root (this repo ships no marketplace, so /plugin install does not apply)
claude --plugin-dir ./07-plugins/pr-review
claude --plugin-dir ./07-plugins/devops-automation
claude --plugin-dir ./07-plugins/documentation

Usage: Use bundled slash commands and features

Location: 08-checkpoints/

What: Save conversation state and rewind to previous points to explore different approaches

Key Concepts:

• Checkpoint: Snapshot of conversation state
• Rewind: Return to previous checkpoint
• Branch Point: Explore multiple approaches from same checkpoint

Usage:

# Checkpoints are created automatically with every user prompt
# To rewind, press Esc twice or use:
/rewind

# Then choose from six options:
# 1. Restore code and conversation
# 2. Restore conversation
# 3. Restore code
# 4. Summarize from here
# 5. Summarize up to here
# 6. Never mind

Use Cases:

• Try different implementation approaches
• Recover from mistakes
• Safe experimentation
• Compare alternative solutions
• A/B testing different designs

Location: 09-advanced-features/

What: Advanced capabilities for complex workflows and automation

Includes:

• Planning Mode — Create detailed implementation plans before coding
• Extended Thinking — Deep reasoning for complex problems (toggle with Alt+T / Option+T)
• Background Tasks — Run long operations without blocking
• Permission Modes — manual (config value default), acceptEdits, plan, auto, dontAsk, bypassPermissions
• Headless Mode — Run Claude Code in CI/CD: claude -p "Run tests and generate report"
• Session Management — /resume, /rename, /fork, /branch, claude -c, claude -r
• Configuration — Customize behavior in ~/.claude/settings.json

See config-examples.json for complete configurations.

Location: 10-cli/

What: Complete command-line interface reference for Claude Code

Quick Examples:

# Interactive mode
claude "explain this project"

# Print mode (non-interactive)
claude -p "review this code"

# Process file content
cat error.log | claude -p "explain this error"

# JSON output for scripts
claude -p --output-format json "list functions"

# Resume session
claude -r "feature-auth" "continue implementation"

Use Cases: CI/CD pipeline integration, script automation, batch processing, multi-session workflows, custom agent configurations

• Start simple with slash commands
• Add features incrementally
• Use memory for team standards
• Test configurations locally first
• Document custom implementations
• Version control project configurations
• Share plugins with team

• Don't create redundant features
• Don't hardcode credentials
• Don't skip documentation
• Don't over-complicate simple tasks
• Don't ignore security best practices
• Don't commit sensitive data

1. Check file location and naming
2. Verify YAML frontmatter syntax
3. Check file permissions
4. Review Claude Code version compatibility

1. Verify environment variables
2. Check MCP server installation
3. Test credentials
4. Review network connectivity

1. Check tool permissions
2. Verify agent description clarity
3. Review task complexity
4. Test agent independently

This project includes comprehensive automated testing:

• Unit Tests: Python tests using pytest (Python 3.10, 3.11, 3.12)
• Code Quality: Linting and formatting with Ruff
• Security: Vulnerability scanning with Bandit
• Type Checking: Static type analysis with mypy
• Build Verification: EPUB generation testing
• Coverage Tracking: Codecov integration

# Install development dependencies
uv pip install -r scripts/requirements-dev.txt

# Run all unit tests
pytest scripts/tests/ -v

# Run tests with coverage report
pytest scripts/tests/ -v --cov=scripts --cov-report=html

# Run code quality checks
ruff check scripts/
ruff format --check scripts/

# Run security scan
bandit -c scripts/pyproject.toml -r scripts/ --exclude scripts/tests/

# Run type checking
mypy scripts/ --ignore-missing-imports

Tests run automatically on every push to main/develop and every PR to main. See TESTING.md for detailed information.

Want to read this guide offline? Generate an EPUB ebook:

uv run scripts/build_epub.py

This creates claude-howto-guide.epub with all content, including rendered Mermaid diagrams.

See scripts/README.md for more options.

Found an issue or want to contribute an example? We'd love your help!

Please read CONTRIBUTING.md for detailed guidelines on:

• Types of contributions (examples, docs, features, bugs, feedback)
• How to set up your development environment
• Directory structure and how to add content
• Writing guidelines and best practices
• Commit and PR process

Our Community Standards:

• CODE_OF_CONDUCT.md - How we treat each other
• SECURITY.md - Security policy and vulnerability reporting

If you discover a security vulnerability, please report it responsibly:

1. Use GitHub Private Vulnerability Reporting: https://github.com/luongnv89/claude-howto/security/advisories
2. Or read .github/SECURITY_REPORTING.md for detailed instructions
3. Do NOT open a public issue for security vulnerabilities

Quick start:

1. Fork and clone the repository
2. Create a descriptive branch (add/feature-name, fix/bug, docs/improvement)
3. Make your changes following the guidelines
4. Submit a pull request with a clear description

Need help? Open an issue or discussion, and we'll guide you through the process.

• Claude Code Documentation
• MCP Protocol Specification
• Skills Repository - Collection of ready-to-use skills
• Anthropic Cookbook
• Boris Cherny's Claude Code Workflow - The creator of Claude Code shares his systematized workflow: parallel agents, shared CLAUDE.md, Plan mode, slash commands, subagents, and verification hooks for autonomous long-running sessions.