A community-driven registry for the Claude Code ecosystem. Not affiliated with Anthropic.
Are you the author? Sign in to claim
Claude Code Guide - Setup, Commands, workflows, agents, skills & tips-n-tricks go from beginner to power user!
| Section | Status | Other Resources |
|---|---|---|
| Getting Started | ✅ | Claude-Code Docs |
| Configuration & Environment Variables | ✅ | Claude-Code via Discord |
| Commands & Usage | ✅ | Security Agents SKILL.md |
| Interface & Input | ✅ | Let Agent Create SKILL.md |
| Advanced Features | ✅ | 954+ Agent Skills |
| Automation & Integration | ✅ | No cost ai resources |
| Help & Troubleshooting | ✅ | 250+ Mermaid templates |
| Third-Party Integrations | ✅ | Discord Communication MCP |
Fast paths: Install · Commands · Config · MCP · Agents · Troubleshoot
Enable sound alerts when claude completes the task:
claude config set --global preferredNotifChannel terminal_bell
[!TIP] Send claude or npx claude in terminal to start the interface
Go to Help & Troubleshooting to fix issues...
# Native Installer (preferred — no Node.js required) ⭐️
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# Windows
/* Via CMD (native) */ curl -fsSL https://claude.ai/install.cmd -o install.cmd && install.cmd && del install.cmd
/* Via Powershell */ irm https://claude.ai/install.ps1 | iex
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# macOS / Linux / WSL
/* Via Terminal */ curl -fsSL https://claude.ai/install.sh | bash
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# Arch
/* Via Terminal */ yay -S claude-code*/
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# Alternative (npm) — useful when your environment already standardizes on Node.js
# Requires Node.js 18+
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# Windows
/* Via CMD (npm) */ npm install -g @anthropic-ai/claude-code
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# macOS
/* Via Terminal */ brew install node && npm install -g @anthropic-ai/claude-code
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# Linux
/* Via Terminal */ sudo apt update && sudo apt install -y nodejs npm
/* Via Terminal */ npm install -g @anthropic-ai/claude-code
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# WSL/GIT
/* Via Terminal */ npm install -g @anthropic-ai/claude-code
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# Docker
/* Windows (CMD) */ docker run -it --rm -v "%cd%:/workspace" -e ANTHROPIC_API_KEY="sk-your-key" node:20-slim bash -lc "npm i -g @anthropic-ai/claude-code && cd /workspace && claude"
/* macOS/Linux (bash/zsh)*/ docker run -it --rm -v "$PWD:/workspace" -e ANTHROPIC_API_KEY="sk-your-key" node:20-slim bash -lc 'npm i -g @anthropic-ai/claude-code && cd /workspace && claude'
/* No bash Fallback */ docker run -it --rm -v "$PWD:/workspace" -e ANTHROPIC_API_KEY="sk-your-key" node:20-slim sh -lc 'npm i -g @anthropic-ai/claude-code && cd /workspace && claude'
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# Check if claude is installed correctly
/* Linux */ which claude
/* Windows */ where claude
/* Universal */ claude --version
--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
# Common Management
/*claude config */ Configure settings
/*claude mcp list */ Setup MCP servers, you can also replace "list" with add/remove
/*claude agents */ Open the agent/session dashboard
/*claude update */ Run a manual update check
[!Tip] Open Project Via Terminal Into VS Code / Cursor
$ - cd /path/to/project
$ - code .
Make sure you have the (Claude Code extension) installed in your VS Code / Cursor
- OS: macOS 10.15+, Ubuntu 20.04+/Debian 10+, or Windows 10/11 or WSL
- Hardware: 4GB RAM minimum 8GB+ recommended
- Software: Git 2.23+ is optional for PR/worktree workflows. Node.js 18+ is only required for npm-based installation; the native installer bundles its own runtime.
- Internet: Connection for API calls
[!Tip] Find API key from Anthropic Console
Do NOT commit real keys use git-ignored files, OS key stores, or secret managers
# Universal
/* Authenticate via Anthropic account */ claude auth login
/* Authenticate via Console/API billing */ claude auth login --console
/* Switch accounts inside Claude */ /login
----------------------------------------------------------------------------------------------------------------------------------
# Windows
/* Set-api-key */ set ANTHROPIC_API_KEY=sk-your-key-here-here
/* cmd-masked-check */ echo OK: %ANTHROPIC_API_KEY:~0,8%***
/* Set-persistent-key */ setx ANTHROPIC_API_KEY "sk-your-key-here-here"
/* cmd-unset-key */ set ANTHROPIC_API_KEY=
----------------------------------------------------------------------------------------------------------------------------------
# Linux
/* Set-api-key */ export ANTHROPIC_API_KEY="sk-your-key-here-here"
/* masked-check */ echo "OK: ${ANTHROPIC_API_KEY:0:8}***"
/* remove-session */ unset ANTHROPIC_API_KEY
----------------------------------------------------------------------------------------------------------------------------------
# Powershell
/* ps-session */ $env:ANTHROPIC_API_KEY = "sk-your-key-here-here"
/* ps-masked-check */ "OK: $($env:ANTHROPIC_API_KEY.Substring(0,8))***"
/* ps-persist */ [Environment]::SetEnvironmentVariable("ANTHROPIC_API_KEY","sk-your-key-here-here","User")
/* ps-rotate */ $env:ANTHROPIC_API_KEY = "sk-new-key"
/* ps-remove */ Remove-Item Env:\ANTHROPIC_API_KEY
----------------------------------------------------------------------------------------------------------------------------------
# Other...
# persist-bash/* */ echo 'export ANTHROPIC_API_KEY="sk-your-key-here-here"' >> ~/.bashrc && source ~/.bashrc
# persist-zsh /* */ echo 'export ANTHROPIC_API_KEY="sk-your-key-here-here"' >> ~/.zshrc && source ~/.zshrc
# persist-fish/* */ fish -lc 'set -Ux ANTHROPIC_API_KEY sk-your-key-here-here'
----------------------------------------------------------------------------------------------------------------------------------
You can also set any of these in settings.json under the "env" key for automatic application.
[!Important] Windows Users replace export with set or setx for perm
# Environment toggles (put in ~/.bashrc or ~/.zshrc)
export ANTHROPIC_API_KEY="sk-your-key-here-here" # API key sent as X-Api-Key header (interactive usage: /login)
export ANTHROPIC_AUTH_TOKEN="my-auth-token" # Custom Authorization header; Claude adds "Bearer " prefix automatically
export ANTHROPIC_CUSTOM_HEADERS="X-Trace-Id: 12345" # Extra request headers (format: "Name: Value")
export ANTHROPIC_MODEL="sonnet" # Custom model name or alias to use
export ANTHROPIC_DEFAULT_SONNET_MODEL="sonnet" # Default Sonnet alias or pinned Sonnet model ID
export ANTHROPIC_DEFAULT_OPUS_MODEL="opus" # Default Opus alias or pinned Opus model ID
export ANTHROPIC_SMALL_FAST_MODEL="haiku-model" # Haiku-class model for background tasks (placeholder)
export ANTHROPIC_SMALL_FAST_MODEL_AWS_REGION="REGION" # Override AWS region for the small/fast model on Bedrock (placeholder)
export AWS_BEARER_TOKEN_BEDROCK="bedrock_..." # Amazon Bedrock API key/token for authentication
export BASH_DEFAULT_TIMEOUT_MS=60000 # Default timeout (ms) for long-running bash commands
export BASH_MAX_TIMEOUT_MS=300000 # Maximum timeout (ms) allowed for long-running bash commands
export BASH_MAX_OUTPUT_LENGTH=20000 # Max characters in bash outputs before middle-truncation
export CLAUDE_BASH_MAINTAIN_PROJECT_WORKING_DIR=1 # (0 or 1) return to original project dir after each Bash command
export CLAUDE_BASH_NO_LOGIN=1 # Force BashTool to skip login shell startup files
export CLAUDE_CODE_API_KEY_HELPER_TTL_MS=600000 # Interval (ms) to refresh creds when using apiKeyHelper
export CLAUDE_CODE_IDE_SKIP_AUTO_INSTALL=1 # (0 or 1) skip auto-installation of IDE extensions
export CLAUDE_CODE_MAX_OUTPUT_TOKENS=4096 # Max number of output tokens for most requests
export CLAUDE_CODE_USE_BEDROCK=1 # (0 or 1) use Amazon Bedrock
export CLAUDE_CODE_USE_VERTEX=0 # (0 or 1) use Google Vertex AI
export CLAUDE_CODE_SKIP_BEDROCK_AUTH=0 # (0 or 1) skip AWS auth for Bedrock (e.g., via LLM gateway)
export CLAUDE_CODE_SKIP_VERTEX_AUTH=0 # (0 or 1) skip Google auth for Vertex (e.g., via LLM gateway)
export CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=0 # (0 or 1) disable nonessential traffic (equivalent to DISABLE_* below)
export CLAUDE_CODE_DISABLE_TERMINAL_TITLE=0 # (0 or 1) disable automatic terminal title updates
export CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS=1 # (0 or 1) enable agent teams research preview
export CLAUDE_CODE_ADDITIONAL_DIRECTORIES_CLAUDE_MD=1 # (0 or 1) load CLAUDE.md from --add-dir paths
export CLAUDE_CODE_ENABLE_TASKS=false # Set to "false" to disable the task system
export DISABLE_AUTOUPDATER=0 # (0 or 1) disable automatic updates (overrides autoUpdates setting)
export DISABLE_BUG_COMMAND=0 # (0 or 1) disable the /bug command
export DISABLE_COST_WARNINGS=0 # (0 or 1) disable cost warning messages
export DISABLE_ERROR_REPORTING=0 # (0 or 1) opt out of Sentry error reporting
export DISABLE_NON_ESSENTIAL_MODEL_CALLS=0 # (0 or 1) disable model calls for non-critical paths
export DISABLE_TELEMETRY=0 # (0 or 1) opt out of Statsig telemetry
export HTTP_PROXY="http://proxy:8080" # HTTP proxy server URL
export HTTPS_PROXY="https://proxy:8443" # HTTPS proxy server URL
export MAX_THINKING_TOKENS=0 # (0 or 1 to turn off/on) force a thinking budget for the model
export MCP_TIMEOUT=120000 # MCP server startup timeout (ms)
export MCP_TOOL_TIMEOUT=60000 # MCP tool execution timeout (ms)
export MAX_MCP_OUTPUT_TOKENS=25000 # Max tokens allowed in MCP tool responses (default 25000)
export USE_BUILTIN_RIPGREP=0 # (0 or 1) set 0 to use system-installed rg instead of bundled one
# Vertex AI region overrides follow VERTEX_REGION_CLAUDE_<MODEL_FAMILY>.
export VERTEX_REGION_CLAUDE_3_5_HAIKU="REGION" # 3.x family example
export VERTEX_REGION_CLAUDE_4_6_SONNET="REGION" # Sonnet family example
export VERTEX_REGION_CLAUDE_4_8_OPUS="REGION" # Opus family example
# -- Session and runtime controls ---------------------------------------------
export CLAUDE_CODE_SIMPLE=1 # Minimal mode: disables MCP tools, attachments, hooks, CLAUDE.md, and skills
export CLAUDE_CODE_DISABLE_1M_CONTEXT=1 # Disable 1 M-token context window (use default shorter context)
export CLAUDE_CODE_DISABLE_BACKGROUND_TASKS=1 # Disable background tasks entirely
export CLAUDE_CODE_DISABLE_EXPERIMENTAL_BETAS=1 # Opt out of experimental beta features
export CLAUDE_CODE_AUTO_CONNECT_IDE=false # Disable automatic IDE connection on startup
export CLAUDE_CODE_TMPDIR="/custom/tmp" # Override the temp directory Claude Code uses
export CLAUDE_CODE_SHELL="/bin/zsh" # Override shell detection (force a specific shell)
export CLAUDE_CODE_SHELL_PREFIX="command-wrapper" # Prefix/wrap every shell command Claude runs
export CLAUDE_CODE_FILE_READ_MAX_OUTPUT_TOKENS=50000 # Override max output tokens for the Read tool
export CLAUDE_CODE_PROXY_RESOLVES_HOSTS=true # Let the HTTP/HTTPS proxy handle DNS resolution
export CLAUDE_CODE_EXIT_AFTER_STOP_DELAY=30000 # Auto-exit SDK mode after idle for N ms
export CLAUDE_CODE_PLUGIN_GIT_TIMEOUT_MS=30000 # Timeout (ms) for plugin git operations
export CLAUDE_CODE_ACCOUNT_UUID="uuid" # Override account UUID (SDK / automation flows)
export CLAUDE_CODE_USER_EMAIL="user@example.com" # Override user email (SDK / automation flows)
export CLAUDE_CODE_ORGANIZATION_UUID="uuid" # Override organization UUID (SDK / automation flows)
export ENABLE_CLAUDEAI_MCP_SERVERS=false # Opt out from claude.ai-synced MCP servers
export FORCE_AUTOUPDATE_PLUGINS=1 # Allow plugin auto-update even when main updater is disabled
export IS_DEMO=1 # Demo mode — hides email/org from the UI
export NO_PROXY="localhost,127.0.0.1" # Bypass proxy for specified hosts (comma-separated)
# -- Provider, terminal, and telemetry controls --------------------------------
export CLAUDE_CODE_ENABLE_AUTO_MODE=1 # Enable auto mode on Bedrock, Vertex, and Foundry for Opus 4.7/4.8
export CLAUDE_CODE_USE_POWERSHELL_TOOL=1 # Enable PowerShell tool where available; Windows provider sessions may default to it
export CLAUDE_CODE_POWERSHELL_RESPECT_EXECUTION_POLICY=1 # Opt out of PowerShell -ExecutionPolicy Bypass behavior
export CLAUDE_CODE_NO_FLICKER=1 # Prefer flicker-free alternate-screen rendering where supported
export CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY=1 # Let compatible gateways populate the model picker from /v1/models
export CLAUDE_CODE_FORCE_SYNC_OUTPUT=1 # Force synchronized terminal output when auto-detection misses support
export CLAUDE_CODE_PACKAGE_MANAGER_AUTO_UPDATE=1 # Let package-manager installs run background upgrades where supported
export ENABLE_PROMPT_CACHING_1H=true # Opt in to 1-hour prompt cache TTL when your provider supports it
export OTEL_LOG_TOOL_DETAILS=1 # Include tool parameters in tool_decision telemetry events
export OTEL_METRICS_INCLUDE_ENTRYPOINT=true # Include session entrypoint on OpenTelemetry metrics
claude config set -g theme dark # Theme: dark | light | light-daltonized | dark-daltonized
claude config set -g preferredNotifChannel iterm2_with_bell # Notification channel: iterm2 | iterm2_with_bell | terminal_bell | notifications_disabled
claude config set -g autoUpdates true # Auto-download & install updates (applied on restart)
claude config set -g verbose true # Show full bash/command outputs
claude config set -g attribution false # Omit "co-authored-by Claude" in git commits/PRs
claude config set -g forceLoginMethod claudeai # Restrict login flow: claudeai | console
claude config set -g model "sonnet" # Default model override; use a full model ID only when pinning
claude config set -g statusLine '{"type":"command","command":"~/.claude/statusline.sh"}' # Custom status line
claude config set -g enableAllProjectMcpServers true # Auto-approve all MCP servers from .mcp.json
claude config set -g enabledMcpjsonServers '["memory","github"]' # Approve specific MCP servers
claude config set -g disabledMcpjsonServers '["filesystem"]' # Reject specific MCP servers
(Memory type) Claude Code offers four memory locations in a hierarchical structure, each serving a different purpose:
| Memory Type | Location | Purpose | Use Case Examples | Shared With |
|---|---|---|---|---|
| Enterprise policy | macOS: /Library/Application Support/ClaudeCode/CLAUDE.mdLinux: /etc/claude-code/CLAUDE.mdWindows: C:\ProgramData\ClaudeCode\CLAUDE.md | Organization-wide instructions managed by IT/DevOps | Company coding standards, security policies, compliance requirements | All users in organization |
| Project memory | ./CLAUDE.md | Team-shared instructions for the project | Project architecture, coding standards, common workflows | Team members via source control |
| User memory | ~/.claude/CLAUDE.md | Personal preferences for all projects | Code styling preferences, personal tooling shortcuts | Just you (all projects) |
| Project memory (local) | ./CLAUDE.local.md | Personal project-specific preferences (git-ignored) | Your sandbox URLs, preferred test data, personal overrides | Just you (current project) |
| Project rules | .claude/rules/*.md | Modular project rules (loaded alongside CLAUDE.md) | Linting rules, API conventions, per-directory standards | Team members via source control |
All memory files are automatically loaded into Claude Code's context when launched. Files higher in the hierarchy take precedence and are loaded first, providing a foundation that more specific memories build upon.
.claude/rules/ DirectoryThe .claude/rules/ directory lets you break project instructions into separate Markdown files instead of one large CLAUDE.md. Every *.md file inside is automatically loaded into context alongside CLAUDE.md. This is useful for:
api-conventions.md, testing-rules.md)rules/ directories can apply scoped rulesClaude can save useful working context during your sessions, such as project conventions, tooling preferences, and architectural decisions it observes while helping you. Use /memory to inspect, edit, or remove saved memories.
Auto-memory is most useful for context you would otherwise repeat across sessions:
Keep durable team rules in CLAUDE.md or .claude/rules/. Treat auto-memory as helpful working context, not as the only source of truth.
| Command | Purpose |
|---|---|
/add-dir | Add additional working directories |
/agents | Manage custom AI subagents for specialized tasks |
/branch | Branch or fork the current conversation into a separate session |
/bug | Report bugs (sends conversation to Anthropic) |
/clear | Clear conversation history |
/compact [instructions] | Compact conversation with optional focus instructions |
/config | Open the Settings interface (Config tab) |
/context | Visualize current context usage as a colored grid |
/copy | Copy conversation content to clipboard |
/code-review [effort] | Run correctness-focused code review; use --fix to apply findings or --comment for PR comments |
/color | Set or randomize the current session accent color |
/debug | Troubleshoot current session and diagnose issues |
/doctor | Checks the health of your Claude Code installation |
/effort | Pick reasoning effort for the current model/session |
/exit | Exit the REPL |
/export [filename] | Export the current conversation to a file or clipboard |
/fast | Toggle fast mode for accelerated Opus responses where available |
/goal | Set a completion condition so Claude keeps working across turns until it is met |
/help | Get usage help |
/init | Initialize project with CLAUDE.md guide |
/insights | Generate an interactive HTML report analyzing your coding habits |
/keybindings | Configure custom keyboard shortcuts |
/login | Switch Anthropic accounts |
/loop | Schedule a recurring prompt or slash command |
/logout | Sign out from your Anthropic account |
/mcp | Manage MCP server connections and OAuth authentication |
/memory | Edit CLAUDE.md memory files |
/model | Select or change the AI model |
/permissions | View or update tool permissions |
/plan | Enter plan mode directly from the prompt |
/plugins | Manage plugins (install, enable, disable, marketplace) |
/pr_comments | View pull request comments |
/release-notes | Open the built-in release notes view |
/rename <name> | Rename the current session for easier identification |
/resume [session] | Resume a conversation by ID or name, or open session picker |
/rules | View and manage .claude/rules/ directory (modular project rules) |
/rewind | Rewind the conversation and/or code to a previous point |
/sandbox | View sandbox dependency status with installation instructions |
/scroll-speed | Tune mouse wheel scroll speed with a live preview |
/settings | Open Settings interface (alias for /config) |
/simplify | Run cleanup-only review for reuse, simplification, efficiency, and altitude |
/status | Open Settings interface (Status tab) showing version, model, account |
/statusline | Set up Claude Code's status line UI |
/tasks | List and manage background tasks |
/teleport | Resume a remote session from claude.ai (subscribers only) |
/terminal-setup | Install Shift+Enter key binding for newlines (iTerm2, VS Code, Kitty, Alacritty, Zed, Warp, and WezTerm) |
/remote-env | Configure remote environment settings |
/theme | Change the color theme |
/todos | List current TODO items |
/ultrareview [target] | Run comprehensive cloud code review with parallel multi-agent analysis |
/usage | Show plan usage limits and rate limit status (subscription plans) |
/usage-credits | Enable or inspect usage credits for higher-throughput modes |
/workflows | View dynamic workflow runs and background orchestration status |
/batch | Run batch operations on multiple files (bundled skill) |
| Flag / Command | Description | Example |
|---|---|---|
-d, --debug | Enable debug mode (shows detailed debug output). | claude -d -p "query" |
--include-partial-messages | partial message streaming support via CLI flag | claude -p "query" --include-partial-messages |
--verbose | Override verbose mode setting from config (shows expanded logging / turn-by-turn output). | claude --verbose |
-p, --print | Print response and exit (useful for piping output). | claude -p "query" |
--output-format <format> | Output format (only works with --print): text (default), json (single result), or stream-json (realtime streaming). | claude -p "query" --output-format json |
--input-format <format> | Input format (only works with --print): text (default) or stream-json (realtime streaming input). | claude -p --output-format stream-json --input-format stream-json |
--replay-user-messages | Re-emit user messages from stdin back to stdout for acknowledgment — only works with --input-format=stream-json and --output-format=stream-json. | claude --input-format stream-json --output-format stream-json --replay-user-messages |
--allowedTools, --allowed-tools <tools...> | Comma/space-separated list of tool names to allow (e.g. "Bash(git:*) Edit"). | --allowed-tools "Bash(git:*)" Edit" |
--disallowedTools, --disallowed-tools <tools...> | Comma/space-separated list of tool names to deny (e.g. "Bash(git:*) Edit"). | --disallowed-tools "Edit" |
--mcp-config <configs...> | Load MCP servers from JSON files or strings (space-separated). | claude --mcp-config ./mcp-servers.json |
--strict-mcp-config | Only use MCP servers from --mcp-config, ignoring other MCP configurations. | claude --mcp-config ./a.json --strict-mcp-config |
--append-system-prompt <prompt> | Append a system prompt to the default system prompt (useful in print mode). | claude -p --append-system-prompt "Do X then Y" |
--permission-mode <mode> | Permission mode for the session (choices include acceptEdits, auto, bypassPermissions, default, plan). | claude --permission-mode plan |
--permission-prompt-tool <tool> | Specify an MCP tool to handle permission prompts in non-interactive mode. | claude -p --permission-prompt-tool mcp_auth_tool "query" |
--fallback-model <model> | Enable automatic fallback to a specified model when the default is overloaded (note: only works with --print per help). | claude -p --fallback-model claude-haiku-20240307 "query" |
--model <model> | Model for the current session. Accepts aliases like sonnet/opus or a full model ID when pinning. | claude --model sonnet |
--settings <file-or-json> | Load additional settings from a JSON file or a JSON string. | claude --settings ./settings.json |
--add-dir <directories...> | Additional directories to allow tool access to. | claude --add-dir ../apps ../lib |
--ide | Automatically connect to an IDE on startup if exactly one valid IDE is available. | claude --ide |
-c, --continue | Continue the most recent conversation in the current directory. | claude --continue |
-r, --resume [sessionId] | Resume a conversation; provide a session ID or interactively select one. | claude -r "abc123" |
--session-id <uuid> | Use a specific session ID for the conversation (must be a valid UUID). | claude --session-id 123e4567-e89b-12d3-a456-426614174000 |
--agents <json> | Define custom subagents dynamically via JSON (see subagent docs for format). | claude --agents '{"reviewer":{"description":"Reviews code","prompt":"..."}}' |
--agent <name> | Specify a specific agent for the current session. | claude --agent my-custom-agent |
--bg | Start or continue work as a background session that can be viewed from claude agents. | claude --bg "fix failing tests" |
--bg --exec <command> | Run a shell command as an attachable background session. | claude --bg --exec "npm test" |
--name <label> | Name a background or remote session for easier identification. | claude --bg --name nightly-check "run checks" |
--chrome | Enable Chrome browser integration for web automation and testing. | claude --chrome |
--no-chrome | Disable Chrome browser integration for this session. | claude --no-chrome |
--remote | Create a new web session on claude.ai with the provided task description. | claude --remote "Fix the login bug" |
--teleport | Resume a web session in your local terminal. | claude --teleport |
--fork-session | When resuming, create a new session ID instead of reusing the original. | claude --resume abc123 --fork-session |
--json-schema <schema> | Get validated JSON output matching a JSON Schema after agent completes (print mode only). | claude -p --json-schema '{"type":"object",...}' "query" |
--max-budget-usd <amount> | Maximum dollar amount to spend on API calls before stopping (print mode only). | claude -p --max-budget-usd 5.00 "query" |
--max-turns <n> | Limit the number of agentic turns (print mode only). Exits with error when limit reached. | claude -p --max-turns 3 "query" |
--betas <headers> | Beta headers to include in API requests (API key users only). | claude --betas interleaved-thinking |
--tools <tools> | Restrict which built-in tools Claude can use. Use "" to disable all, "default" for all, or specific tool names. | claude --tools "Bash,Edit,Read" |
--system-prompt <prompt> | Replace the entire system prompt with custom text (works in interactive and print modes). | claude --system-prompt "You are a Python expert" |
--system-prompt-file <file> | Load system prompt from a file, replacing the default prompt (print mode only). | claude -p --system-prompt-file ./custom-prompt.txt "query" |
--append-system-prompt-file <file> | Load additional system prompt text from a file and append to default (print mode only). | claude -p --append-system-prompt-file ./extra-rules.txt "query" |
--plugin-dir <dir> | Load plugins from directories for this session only (repeatable). | claude --plugin-dir ./my-plugins |
--setting-sources <sources> | Comma-separated list of setting sources to load (user, project, local). | claude --setting-sources user,project |
--no-session-persistence | Disable session persistence so sessions are not saved to disk (print mode only). | claude -p --no-session-persistence "query" |
--disable-slash-commands | Disable all skills and slash commands for this session. | claude --disable-slash-commands |
--dangerously-skip-permissions | Bypass all permission checks (only for trusted sandboxes). | claude --dangerously-skip-permissions |
--worktree, -w | Start in an isolated git worktree; worktree.baseRef controls whether it branches from fresh remote state or local HEAD. | claude -w "implement feature" |
--from-pr <url> | Start a session from a pull request URL. | claude --from-pr https://github.com/org/repo/pull/123 |
--init | Trigger the Setup hook event. | claude --init |
--init-only | Run Setup hooks and exit. | claude --init-only |
--maintenance | Run Setup hooks in maintenance mode. | claude --maintenance |
-v, --version | Show the installed claude CLI version. | claude --version |
-h, --help | Display help / usage. | claude --help |
The
--output-format jsonflag is particularly useful for scripting and automation, allowing you to parse Claude's responses programmatically.
## Claude Cheat Sheet
# Start and resume
claude # Start interactive REPL
claude "explain this project" # Start REPL seeded with a prompt
claude -p "summarize README.md" # Non-interactive print mode (SDK-backed)
cat logs.txt | claude -p "explain" # Pipe input to Claude and exit
claude -c # Continue most recent conversation
claude -r "<session-id>" "finish this" # Resume by ID or name
claude --model sonnet # Pick the Sonnet alias for this run
claude --model opus # Pick the Opus alias for harder tasks
# Install, update, and auth
claude update # Manually update Claude Code
claude doctor # Diagnose install/version & setup
claude install # Start the native binary installer
claude migrate-installer # Switch from global npm to the native installer
claude auth login # Log in to your Anthropic account
claude auth status # Check authentication status
claude auth logout # Log out
# Background and remote sessions
claude agents # Open the live session dashboard: running, blocked, completed
claude agents --json # Scriptable JSON list of live/background sessions
claude --bg "run the integration suite and summarize failures" # Start a background session
claude --bg --exec "npm test" # Run a shell command as an attachable background session
claude remote-control # Start remote-control mode for external tooling
claude --remote "Fix the bug" # Create web session on claude.ai
claude --teleport # Resume web session locally
# Config essentials
claude config # Interactive config wizard
claude config set model "sonnet" # Override default model for this project
claude config set attribution false # Disable "co-authored-by Claude" byline in git/PRs
claude config set enableAllProjectMcpServers true # Auto-approve all MCP servers from .mcp.json
claude config set defaultMode "acceptEdits" # Set default permission mode
claude config set worktree.baseRef "head" # Use local HEAD instead of origin/default for new worktrees
claude config set -g autoUpdates false # Turn off automatic updates globally
claude config set -g theme dark # Theme: dark | light | light-daltonized | dark-daltonized
# MCP essentials
claude mcp # Launch MCP wizard / configure MCP servers
claude mcp list # List configured MCP servers
claude mcp get <name> # Show details for a server
claude mcp add <name> <command> [args...] # Add local stdio server
claude mcp add --transport http <name> <url> # Add remote HTTP server
claude mcp reset-project-choices # Reset approvals for project .mcp.json servers
claude mcp serve # Run Claude Code itself as an MCP stdio server
# High-value flags
claude --add-dir ../apps ../lib # Add additional working directories
claude --allowedTools "Bash(git log:\*)" "Read" # Allow listed tools without permission prompts
claude --disallowedTools "Edit" # Disallow listed tools without permission prompts
claude -p "query" --output-format json --input-format stream-json # Control IO formats for scripting
claude --verbose # Verbose logging (turn-by-turn)
claude --dangerously-skip-permissions # Skip permission prompts (use with caution)
claude --permission-mode plan # Start in plan mode (read-only analysis)
claude --max-turns 3 -p "query" # Limit agentic turns (print mode only)
claude --json-schema '{"type":"object"}' -p "query" # Get validated JSON output
claude --chrome # Enable Chrome browser integration
claude --agent code-reviewer # Run this session with a named agent
claude ultrareview 123 --json # Non-interactive comprehensive review for PR/target 123
# Slash shortcuts
claude --fork-session -r abc123 # Fork instead of reusing original
claude -w "implement feature" # Start in an isolated git worktree
/rename auth-refactor # Name current session
/resume # Open session picker
/export output.md # Export conversation to file
/branch experiment-name # Branch the current conversation
/goal "all tests pass and README is updated" # Keep working until the completion condition is met
/loop 30m "check deploy health and summarize anomalies" # Schedule recurring work
/workflows # View dynamic workflows and background orchestration
# Notes: project scope is default for 'claude config'; use -g/--global for user-global settings.
# Settings precedence: Enterprise > CLI args > local project > shared project > user (~/.claude).
| Shortcut | Description | Context |
|---|---|---|
Ctrl+C | Cancel current input or generation | Standard interrupt |
Ctrl+D | Exit Claude Code session | EOF signal |
Ctrl+G | Open in default text editor | Edit your prompt or custom response |
Ctrl+L | Clear terminal screen | Keeps conversation history |
Ctrl+O | Toggle verbose output | Shows detailed tool usage and execution |
Ctrl+R | Reverse search command history | Search through previous commands |
Ctrl+V or Cmd+V (iTerm2) | Paste image from clipboard | Pastes an image or path to an image file |
Ctrl+B | Background running tasks | Backgrounds bash commands and agents |
Ctrl+F (press twice) | Kill all background agents | Two-press confirmation to stop agents |
Up/Down arrows | Navigate command history | Recall previous inputs |
Left/Right arrows | Cycle through dialog tabs | Navigate between tabs in dialogs |
Esc + Esc | Rewind the code/conversation | Restore to a previous point |
Shift+Tab or Alt+M | Toggle permission modes | Switch between Auto-Accept, Plan, Normal |
Option+P (macOS) / Alt+P | Switch model | Switch models without clearing prompt |
Option+T (macOS) / Alt+T | Toggle extended thinking | Enable/disable extended thinking mode |
| Shortcut | Description | Context |
|---|---|---|
Ctrl+K | Delete to end of line | Stores deleted text for pasting |
Ctrl+U | Delete entire line | Stores deleted text for pasting |
Ctrl+Y | Paste deleted text | Paste text deleted with Ctrl+K/U |
Alt+Y (after Ctrl+Y) | Cycle paste history | Cycle through previously deleted text |
Alt+B | Move cursor back one word | Requires Option as Meta on macOS |
Alt+F | Move cursor forward one word | Requires Option as Meta on macOS |
| Method | Shortcut | Context |
|---|---|---|
| Quick escape | \ + Enter | Works in all terminals |
| macOS default | Option+Enter | Default on macOS |
| Terminal setup | Shift+Enter | After /terminal-setup |
| Control sequence | Ctrl+J | Line feed character for multiline |
| Paste mode | Paste directly | For code blocks, logs |
| Shortcut | Description | Notes |
|---|---|---|
/ at start | Command or skill | See built-in commands and skills |
! at start | Bash mode | Run commands directly, add to context |
@ | File path mention | Trigger file path autocomplete |
[!Tip] PDF Page Ranges: Use the
pagesparameter with the Read tool for PDFs (e.g.,pages: "1-5"). Large PDFs (>10 pages) return a lightweight reference when @-mentioned instead of being inlined.
[!Note] Enable vim-style editing from
/config-> Editor mode.
| Command | Action | From mode |
|---|---|---|
Esc | Enter NORMAL mode | INSERT |
i | Insert before cursor | NORMAL |
I | Insert at beginning of line | NORMAL |
a | Insert after cursor | NORMAL |
A | Insert at end of line | NORMAL |
o | Open line below | NORMAL |
O | Open line above | NORMAL |
| Command | Action |
|---|---|
h/j/k/l | Move left/down/up/right |
w | Next word |
e | End of word |
b | Previous word |
0 | Beginning of line |
$ | End of line |
^ | First non-blank character |
gg | Beginning of input |
G | End of input |
| Command | Action |
|---|---|
x | Delete character |
dd | Delete line |
D | Delete to end of line |
dw/de/db | Delete word/to end/back |
cc | Change line |
C | Change to end of line |
cw/ce/cb | Change word/to end/back |
. | Repeat last change |
[!Tip] Configure your preferred line break behavior in terminal settings. Run
/terminal-setupto install Shift+Enter binding for iTerm2, VS Code, Kitty, Alacritty, Zed, Warp, and WezTerm.
Claude Code maintains command history for the current session:
* History is stored per working directory
* Cleared with `/clear` command
* Use Up/Down arrows to navigate (see keyboard shortcuts above)
* **Ctrl+R**: Reverse search through history (if supported by terminal)
* **Note**: History expansion (`!`) is disabled by default
[!Note] Gives Claude extra pre-answer planning time by adding ONE of these keywords to your prompt. Order (lowest → highest) token consumption
think -------------> Lowest
think hard
think harder
ultrathink --------> Highest
Higher levels usually increase latency and token usage pick the smallest that works.
# Small boost
claude -p "Think. Outline a plan to refactor the auth module."
# Medium boost
claude -p "Think harder. Draft a migration plan from REST to gRPC."
# Max boost
claude -p "Ultrathink. Propose a step-by-step strategy to fix flaky payment tests and add guardrails."
Use /effort to tune how much reasoning the selected model applies before answering. Higher effort levels are best for planning-heavy work, deep reviews, and long-context tasks.
/effort # Open the effort picker
/effort low # Faster, lighter reasoning
/effort medium # Balanced default for many tasks
/effort high # Deeper planning and review
/effort xhigh # Highest effort for Opus 4.8-scale hard tasks
Prefer the lowest effort that still solves the task: higher effort can improve planning, code review, and long-context reasoning, but it usually increases latency and token usage.
[!Note] Fast Mode provides accelerated Opus responses for rapid iteration when speed matters more than maximum depth.
How to enable Fast Mode:
# Enable usage credits if your plan requires it, then toggle fast mode
/usage-credits
/fast
# Or toggle during conversation
# The status bar will show when Fast Mode is active
Key features:
/usage-credits before /fastWhen to use Fast Mode:
Fast Mode trades some depth for speed. Use normal mode for complex analysis and planning tasks.
Auto mode lets Claude evaluate and approve lower-risk actions automatically while still blocking or asking on higher-risk operations. It is useful for trusted development loops where repeated permission prompts slow down work.
# Enable auto mode for Bedrock, Vertex, and Foundry Opus 4.7/4.8 sessions
export CLAUDE_CODE_ENABLE_AUTO_MODE=1
{
"autoMode": {
"allow": ["$defaults"],
"soft_deny": ["$defaults"],
"hard_deny": []
}
}
Key points:
"$defaults" in autoMode.allow, autoMode.soft_deny, or autoMode.environment to add rules without replacing built-ins.settings.autoMode.hard_deny blocks actions unconditionally regardless of user intent./permissions recent activity, where supported, so you can retry or adjust policy.[!Note] Plan Mode instructs Claude to analyze the codebase with read-only operations, perfect for exploring codebases, planning complex changes, or reviewing code safely.
When to use Plan Mode:
How to enable Plan Mode:
# Start a new session in Plan Mode
claude --permission-mode plan
# Or toggle during session with Shift+Tab
# (cycles through: Normal → Auto-Accept → Plan Mode)
# Enter plan mode from the prompt
/plan
# Run headless queries in Plan Mode
claude --permission-mode plan -p "Analyze the authentication system and suggest improvements"
Configure Plan Mode as default:
// .claude/settings.json
{
"permissions": {
"defaultMode": "plan"
}
}
[!Note] Claude Code supports background commands and full background sessions, allowing you to continue working while long-running processes or agents execute.
How to use background tasks:
| Method | Description |
|---|---|
| Prompt Claude | Ask Claude to "run this in the background" |
Ctrl+B | Move a running Bash tool invocation to background (tmux users press twice) |
! <command> | In claude agents, start an attachable background shell session |
claude --bg | Launch a task as a background Claude session |
Key features:
/resume and the claude agents dashboard, marked with bg/tasks to list and manage background tasksclaude agents --json for scripts, status bars, session pickers, and tmux integrationsCommon backgrounded commands:
Bash mode with ! prefix:
# Run bash commands directly without Claude interpretation
! npm test
! git status
! ls -la
# Run a command as an attachable background session
claude --bg --exec "npm test"
# Name a background session
claude --bg --name nightly-check "run the full verification suite"
Disable background tasks:
export CLAUDE_CODE_DISABLE_BACKGROUND_TASKS=1
Dynamic workflows coordinate many background agents for larger work than a single foreground turn can comfortably handle. Ask Claude to create a workflow, then use /workflows to inspect runs and status.
/workflows
/goal "the migration is implemented, tested, and documented"
/loop 15m "check the deployment dashboard and summarize any incidents"
| Feature | Purpose |
|---|---|
/workflows | View workflow runs that orchestrate many agents in the background |
/goal | Give Claude a completion condition and let it continue across turns until it is reached |
/loop | Run a prompt or slash command on a recurring interval |
Use workflows for broad, decomposable efforts. Use /goal for a single outcome that may require several turns. Use /loop for monitoring and scheduled checks.
[!Note] For subscribers: Use
--remoteto start tasks on claude.ai and--teleportto resume them locally.
Start a remote session:
# Create a new web session on claude.ai with task description
claude --remote "Fix the login bug"
Resume a remote session:
# Resume a web session in your local terminal
claude --teleport
# Or use the slash command
/teleport
Claude Code can control Google Chrome for browser-based tasks like testing, web scraping, and UI verification.
Setup:
claude --chrome # Launch with Chrome integration
Capabilities:
[!NOTE] Requires Google Chrome installed. Claude uses the Chrome DevTools Protocol for browser control.
Sandbox mode restricts the BashTool to run commands in an isolated environment, preventing modifications to your actual filesystem.
/sandbox # Toggle sandbox mode on/off
When sandboxed:
Available on Linux and macOS. Use claude --sandbox to start in sandbox mode.
Claude Code integrates with language servers to provide IDE-level code intelligence:
The LSP tool activates automatically when a compatible language server is available for the current project. This enables Claude to navigate codebases more precisely than text search alone.
Tool results exceeding 50,000 characters are automatically persisted to disk to manage context efficiently.
Sub‑Agents are purpose‑built helpers with their own prompts, tools, and isolated context windows. Treat this like a "mixture‑of‑experts" you compose per repo.
Claude Code includes built-in subagents that Claude automatically uses when appropriate:
| Subagent | Model | Tools | Purpose |
|---|---|---|---|
| Explore | Haiku (fast) | Read-only | File discovery, code search, codebase exploration |
| Plan | Configurable | Read-only | Planning complex changes without making edits |
| General-purpose | Default | Inherited | General task delegation |
Claude delegates to Explore when it needs to search or understand a codebase without making changes, keeping exploration results out of your main conversation context.
When to use subagents:
- You need high signal responses (plans, reviews, diffs) without side quests.
- You want version‑controlled prompts and tool policies alongside the codebase.
- You work in PR‑driven teams and want scoped edits by role.
- The task produces verbose output you don't need in your main context.
Design rules for your lineup
- Define one clear responsibility per agent.
- Keep the minimum tool set needed for that role.
- Prefer read‑only agents for analysis/review tasks.
- Give edit powers to as few agents as possible.
Caption: Agents selection UI in the terminal.
Keep agents in the project so they're versioned with the repo and evolve via PRs.
Update CLI and open the agents panel/dashboard
claude update
/agents
claude agents
claude agents --json
claude agents shows running, blocked, completed, and background sessions in one place. It can launch new sessions, attach to background work, and script session lists with --json.
| Location | Scope | Priority |
|---|---|---|
--agents CLI flag | Current session only | 1 (highest) |
.claude/agents/ | Current project | 2 |
~/.claude/agents/ | All your projects | 3 |
Plugin's agents/ directory | Where plugin is enabled | 4 (lowest) |
Dispatched sessions honor the agent field in settings.json. Pass --agent <name> to override the configured default for a specific run.
# Define custom subagents dynamically via JSON
claude --agents '{
"code-reviewer": {
"description": "Expert code reviewer. Use proactively after code changes.",
"prompt": "You are a senior code reviewer. Focus on code quality, security, and best practices.",
"tools": ["Read", "Grep", "Glob", "Bash"],
"model": "sonnet"
},
"debugger": {
"description": "Debugging specialist for errors and test failures.",
"prompt": "You are an expert debugger. Analyze errors, identify root causes, and provide fixes."
},
"background-impl": {
"description": "Implements features in an isolated worktree in the background.",
"prompt": "Implement the requested feature. Commit when done.",
"isolation": "worktree",
"background": true
}
}'
- planner (read‑only): turns features/issues into small, testable tasks; outputs a task list or plan.md.
- codegen (edit‑capable): implements tasks; limited to
src/+tests/.- tester (read‑only or patch‑only): writes one failing test or a minimal repro.
- reviewer (read‑only): leaves structured review comments; never edits.
- docs (edit‑capable): updates
README.md/docs/only.
*Policy tip: Prefer patch output for edit‑capable agents so changes land through your normal Git workflow.*
Caption: Choose only the tools an agent truly needs (e.g., advisory vs editing access).
Keep prompts short, testable, and repo‑specific. Check them into
agents/:
Caption: Example prompt for a test‑coverage‑analyzer agent.
tester.prompt.md (sample)
Role: Write a single, focused failing test for the specific scenario I describe.
Scope: Only create/modify tests under tests/. Do not change src/.
Output: A brief rationale + a unified diff or patch.
If the scenario is unclear, ask exactly one clarifying question.
Your tester agent should produce a small diff or patch plus a short rationale:
Caption: Example response from the test‑coverage‑analyzer agent.
Subagent files use YAML frontmatter for configuration:
---
name: code-reviewer
description: Reviews code for quality and best practices
tools: Read, Glob, Grep
disallowedTools: Write, Edit
model: sonnet
permissionMode: default
skills:
- api-conventions
---
You are a code reviewer. Analyze the code and provide feedback.
| Field | Required | Description |
|---|---|---|
name | Yes | Unique identifier (lowercase, hyphens) |
description | Yes | When Claude should delegate to this subagent |
tools | No | Tools the subagent can use (inherits all if omitted) |
disallowedTools | No | Tools to deny, removed from inherited or specified list |
model | No | Model: sonnet, opus, haiku, or inherit (default: sonnet) |
permissionMode | No | default, acceptEdits, auto, bypassPermissions, or plan |
skills | No | Skills to preload into the subagent's context |
hooks | No | Lifecycle hooks scoped to this subagent |
memory | No | Persistent memory scope: user, project, or local |
isolation | No | Set to worktree to run the agent in an isolated git worktree |
background | No | Set to true to run the agent as a background task |
Background and isolated agents can switch between Claude-managed worktrees with EnterWorktree when the session needs to move between related isolated checkouts.
Operational benefits
- Less context switching: you stay in one mental mode; agents do the rest.
- Cleaner PRs: narrow prompts + limited tools → smaller, reviewable diffs.
- Fewer regressions: tester/reviewer agents catch gaps before merge.
- Repeatability: prompts + policies live in the repo and travel with branches.
Security & governance
- Limit write access by path (e.g.,
src/,tests/,docs/).- Favor read‑only analysis for high‑risk areas.
- Log/commit assistant outputs as patches for auditability.
Do
- Treat agents as teammates with job descriptions.
- Start read‑only; grant write access last.
- Keep prompts in version control and iterate via PR.
Don't
- Ask one agent to plan, code, and test in a single turn.
- Give blanket write permissions.
- Accept multi‑file diffs when you asked for one test.
[!Note] Agent Teams is an experimental feature enabling multiple Claude instances to work in parallel on a shared codebase autonomously.
Enable Agent Teams:
export CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS=1
Key Concepts:
Case Study: C Compiler Built by Agent Teams
Anthropic's research team demonstrated agent teams by tasking 16 parallel Claude instances to build a C compiler from scratch. Key results:
| Metric | Value |
|---|---|
| Claude Sessions | ~2,000 |
| API Cost | ~$20,000 |
| Lines of Code | 100,000 |
| Capability | Compiled Linux 6.9 on x86, ARM, RISC-V |
| Test Pass Rate | 99% on GCC torture test suite |
Lessons for Agent Teams:
Read the full case study: Building a C Compiler with Parallel Claudes
[!Note] Skills extend what Claude can do. Create a
SKILL.mdfile with instructions, and Claude adds it to its toolkit. Claude uses skills when relevant, or you can invoke one directly with/skill-name.
| Location | Scope | Description |
|---|---|---|
~/.claude/skills/<skill-name>/SKILL.md | Personal | All your projects |
.claude/skills/<skill-name>/SKILL.md | Project | This project only (commit to version control) |
<plugin>/skills/<skill-name>/SKILL.md | Plugin | Where plugin is enabled |
Project skills override personal skills with the same name. Files in
.claude/commands/still work and support the same frontmatter. Plugins in.claude/skillsdirectories are automatically loaded; use/reload-skillsto re-scan skill directories without restarting the session.
# Create skill directory
mkdir -p ~/.claude/skills/explain-code
# Scaffold a plugin-backed skill in the current project
claude plugin init explain-code
Create ~/.claude/skills/explain-code/SKILL.md:
---
name: explain-code
description: Explains code with visual diagrams and analogies. Use when explaining how code works.
---
When explaining code, always include:
1. **Start with an analogy**: Compare the code to something from everyday life
2. **Draw a diagram**: Use ASCII art to show the flow, structure, or relationships
3. **Walk through the code**: Explain step-by-step what happens
4. **Highlight a gotcha**: What's a common mistake or misconception?
Use the skill:
# Let Claude invoke automatically
How does this code work?
# Or invoke directly
/explain-code src/auth/login.ts
| Field | Required | Description |
|---|---|---|
name | No | Display name for the skill (uses directory name if omitted) |
description | Recommended | What the skill does and when to use it |
argument-hint | No | Hint shown during autocomplete (e.g., [filename]) |
disable-model-invocation | No | Set true to prevent Claude from auto-invoking |
user-invocable | No | Set false to hide from / menu |
allowed-tools | No | Tools Claude can use without asking permission |
disallowed-tools | No | Tools removed from the model while the skill is active |
model | No | Model to use when this skill is active |
context | No | Set to fork to run in a forked subagent context |
agent | No | Which subagent to use when context: fork is set |
hooks | No | Hooks scoped to this skill's lifecycle |
Use $ARGUMENTS placeholder to receive arguments:
---
name: fix-issue
description: Fix a GitHub issue
disable-model-invocation: true
---
Fix GitHub issue $ARGUMENTS following our coding standards.
1. Read the issue description
2. Implement the fix
3. Write tests
4. Create a commit
Usage: /fix-issue 123
Use !`command` syntax to run shell commands before the skill content is sent to Claude:
---
name: pr-summary
description: Summarize changes in a pull request
context: fork
agent: Explore
---
## Pull request context
- PR diff: !`gh pr diff`
- PR comments: !`gh pr view --comments`
- Changed files: !`gh pr diff --name-only`
## Your task
Summarize this pull request...
Add context: fork to run a skill in isolation:
---
name: deep-research
description: Research a topic thoroughly
context: fork
agent: Explore
---
Research $ARGUMENTS thoroughly:
1. Find relevant files using Glob and Grep
2. Read and analyze the code
3. Summarize findings with specific file references
The
agentfield can beExplore,Plan,general-purpose, or any custom subagent from.claude/agents/.
[!Note] Plugins extend Claude Code with custom commands, skills, agents, hooks, and MCP servers. Plugins can be loaded from local directories, Git repos, or the npm registry.
Key commands:
claude plugin init my-plugin
/plugins install @org/claude-code-plugin
/plugins list
/plugins enable <plugin-name>
/plugins disable <plugin-name>
/plugins validate ./my-plugin
/plugins marketplace
# CLI aliases exist for scripting, for example:
claude plugin install https://github.com/org/claude-plugin-example
Plugin structure:
my-plugin/
├── plugin.json # Plugin manifest (name, version, description)
├── agents/ # Custom agents (*.md frontmatter files)
├── skills/ # Custom skills (SKILL.md files)
├── hooks/ # Hook scripts
├── commands/ # Custom slash commands
└── mcp-servers/ # MCP server configurations
Plugin scopes:
| Location | Scope | Notes |
|---|---|---|
--plugin-dir ./path | Session only | CLI flag, not persisted |
.claude/plugins/ | Project | Committed with the repo |
~/.claude/plugins/ | User-global | Available in all projects |
Plugin manifest (plugin.json):
{
"name": "my-plugin",
"version": "1.0.0",
"description": "A Claude Code plugin",
"defaultEnabled": false,
"agents": ["agents/"],
"skills": ["skills/"],
"hooks": "hooks/hooks.json",
"mcpServers": "mcp-servers/servers.json",
"dependencies": ["required-plugin"]
}
Plugins auto-update by default. Set
FORCE_AUTOUPDATE_PLUGINS=1to force updates even when the main updater is disabled, or override withCLAUDE_CODE_PLUGIN_GIT_TIMEOUT_MSfor slow repos. Git/GitHub marketplace sources can useskipLfsto skip Git LFS downloads during clone and update.
Dependency behavior:
claude plugin enable enables transitive dependencies automatically.claude plugin disable refuses when another enabled plugin depends on the target and reports the disable chain.defaultEnabled: false lets a plugin ship installed but disabled until the user explicitly enables it.[!Note] The
--worktree(-w) flag starts Claude in an isolated git worktree, allowing it to make changes in a separate branch without affecting your working directory.
Usage:
# Start Claude in an isolated worktree
claude -w "implement the new feature"
# Choose whether new worktrees branch from origin/default or local HEAD
claude config set worktree.baseRef "fresh" # default, uses origin/<default>
claude config set worktree.baseRef "head" # use current local HEAD
# Claude will:
# 1. Create a temporary git worktree from the configured base ref
# 2. Run in that isolated worktree
# 3. Commit changes and optionally create a PR
# 4. Clean up the worktree when done
For repositories where worktrees are impractical, worktree.bgIsolation: "none" lets background sessions edit the working copy directly without EnterWorktree.
Agent-level worktree isolation:
---
name: background-coder
description: Implements features in isolation
isolation: worktree
background: true
---
Implement the requested feature in this isolated worktree.
Worktree isolation is especially powerful combined with
background: truefor agents, enabling parallel development workflows where multiple agents work on separate features simultaneously.
[!Note] Use the native binary installer when you want faster startup, auto-updates, and no dependency on Node.js being available on your PATH.
# Start the native installer (interactive)
claude install
# Switch from npm global install to native installer
claude migrate-installer
The npm installation method (
npm install -g @anthropic-ai/claude-code) continues to work. Choose the installer that best fits your environment and automation model.
[!Note] Manage authentication directly from the CLI without entering the REPL.
# Log in to your Anthropic account
claude auth login
# Check current authentication status
claude auth status
# Log out
claude auth logout
[!Note] List configured agents and live Claude sessions from the command line.
# List all agents (project, user, plugin, CLI-defined)
claude agents
# Script live sessions for status bars, session pickers, or tmux integrations
claude agents --json
# Dispatch with a specific agent, overriding settings.json for this run
claude --agent code-reviewer "review the current branch"
[!Note] The
claude remote-controlsubcommand allows external tools and build systems to drive Claude Code programmatically.
# Start Claude in remote-control mode
claude remote-control
This is useful for IDE extensions, CI/CD pipelines, or custom orchestration tools that want to interact with Claude Code via its SDK interface.
[!Note] Enterprise administrators can push managed settings via macOS plist or Windows Registry, providing organization-wide configuration control.
macOS (plist):
Settings can be deployed via MDM profiles to /Library/Managed Preferences/com.anthropic.claude-code.plist.
Windows (Registry):
Settings can be deployed via Group Policy to HKLM\SOFTWARE\Policies\Anthropic\ClaudeCode.
Managed settings take precedence over user/project settings and cannot be overridden by individual users.
[!Note] Use model family aliases (
sonnet,opus,haiku) for most workflows. Pin a full model ID only when reproducibility matters more than automatic upgrades.
Key highlights:
xhigh effort and fast mode support.CLAUDE_CODE_ENABLE_AUTO_MODE=1.sonnet alias for balanced coding, planning, and refactoring.ANTHROPIC_SMALL_FAST_MODEL overrides for background naming and side-query paths when needed.CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY=1 to populate compatible gateway model pickers from /v1/models.Use in Claude Code:
# Set by family alias
claude --model sonnet
claude --model opus
# Configure in settings with aliases
claude config set model "sonnet"
# Pin only when you need exact reproducibility
claude --model <full-model-id>
Model selection tips:
/model and /fast for day-to-day model switching instead of provider-specific overrides.Claude Code supports built-in themes, custom named themes, and session accent colors.
/theme # Pick a theme or create a custom one
/color # Pick a session accent color
/color random # Randomize session accent color
Custom themes can be edited as JSON under ~/.claude/themes/, and plugins can ship themes for teams. The Auto (match terminal) theme follows terminal light/dark mode where supported.
Claude Code has separate review paths for correctness, cleanup, and broader branch-level review.
| Command | Behavior |
|---|---|
/code-review [effort] | Correctness-focused review at the chosen effort level |
/code-review --fix | Applies review findings to the working tree, including reuse/simplification/efficiency suggestions |
/code-review --comment | Posts inline GitHub PR comments where supported |
/simplify | Cleanup-only review for reuse, simplification, efficiency, and altitude |
/ultrareview [target] | Cloud review using parallel multi-agent analysis and critique |
claude ultrareview [target] | Non-interactive CI/script entrypoint; supports JSON output |
Use /code-review for local correctness review, /simplify for cleanup, and /ultrareview when you want a broader cloud review of a branch or PR.
[!Note] The
/insightscommand generates an interactive HTML report analyzing your coding habits from the past 30 days.
Run Insights:
# In Claude Code terminal
/insights
# Open the generated report
start ~/.claude/usage-data/report.html # Windows
open ~/.claude/usage-data/report.html # Mac
xdg-open ~/.claude/usage-data/report.html # Linux
How It Works:
~/.claude/projects/, filters agent sub-sessions and short sessionsReport Sections:
| Section | Description |
|---|---|
| What's Working | Your strengths and successful patterns |
| What's Hindering | Where Claude struggled or where you caused friction |
| Friction Analysis | Breakdown of problem areas with specific examples |
| Stats Dashboard | Tool usage, language breakdown, coding time distribution |
| Quick Wins | Copy-paste suggestions for CLAUDE.md improvements |
| Features to Try | Personalized recommendations (skills, hooks, headless mode) |
Everything runs locally using the Anthropic API. Session data stays on your machine.
MCP extends Claude's capabilities by connecting to external services, databases, APIs, and tools (filesystem, Puppeteer, GitHub, Context7 etc...)
MCP behavior to know:
claude -p workflows, so automation can use configured tools without opening the full REPL./mcp to reconnect after changing .mcp.json.mcp__server__tool pattern for permissions and hooks.Claude Code ←→ MCP Protocol ←→ MCP Servers ←→ External Services
Claude Code can use MCP servers configured in your claude.ai account, bringing cloud-hosted tools to your CLI workflow.
# Enabled by default — to opt out:
export ENABLE_CLAUDEAI_MCP_SERVERS=false
This allows you to access the same MCP tool integrations available in claude.ai directly from the command line, without local MCP server configuration.
claude mcp # Interactive MCP configuration
claude mcp list # List configured servers
claude mcp add <name> <cmd> # Add new server
claude mcp remove <name> # Remove server
~/.claude.json # Global File
`.mcp.json` # Project-scoped servers are stored in a File at your project's root directory
If you're in a hurry, here's the fastest way to add:
# Add file system access (most commonly used)
claude mcp add filesystem -s user -- npx -y @modelcontextprotocol/server-filesystem ~/Documents ~/Desktop
# Verify if successful
claude mcp list
Responce if it worked like it should:
1. Command Line Addition
hljs language-bash OAuth for MCP Servers: hljs language-bash
|
2. Direct Configuration File Editing
1. Find configuration file location:
2. Edit configuration file: hljs language-json 3. Restart Claude Code to take effect |
3. Project-level Configuration (Recommended for team collaboration)
hljs language-bash This will create a hljs language-json |
Understanding scope is crucial to avoid "server not found" errors:
~/.claude.json-s user flag.mcp.json file-s project flagHere's the most worthwhile MCP server list to install:
claude mcp add filesystem -s user -- npx -y @modelcontextprotocol/server-filesystem ~/Documents ~/Projects ~/Desktop
Use: Let Claude directly read and write files, modify code
claude mcp add github -s user -e GITHUB_TOKEN=your-token -- npx -y @modelcontextprotocol/server-github
Use: Manage issues, PRs, code reviews
claude mcp add puppeteer -s user -- npx -y @modelcontextprotocol/server-puppeteer
Use: Automated web operations, crawling, testing
claude mcp add postgres -s user -e DATABASE_URL=your-db-url -- npx -y @modelcontextprotocol/server-postgres
Use: Directly query and manipulate databases
claude mcp add fetch -s user -- npx -y @kazuph/mcp-fetch
Use: Call various REST APIs
claude mcp add search -s user -e BRAVE_API_KEY=your-key -- npx -y @modelcontextprotocol/server-brave-search
Use: Search the web for outside information
claude mcp add slack -s user -e SLACK_TOKEN=your-token -- npx -y @modelcontextprotocol/server-slack
Use: Send messages, manage channels
claude mcp add time -s user -- npx -y @modelcontextprotocol/server-time
Use: Time zone conversion, date calculation
claude mcp add memory -s user -- npx -y @modelcontextprotocol/server-memory
Use: Save information across conversations
claude mcp add thinking -s user -- npx -y @modelcontextprotocol/server-sequential-thinking
Use: Step-by-step thinking for complex problems
API Error 400: "tools.11.custom.name: String should match pattern '^[a-zA-Z0-9_-]{1,64}$'"
Solution:
MCP server 'my-server' not found
Solution:
claude mcp list to confirm server has been added"protocolVersion": "Required"
Solution: If the server response is missing a protocol version, try these checks:
claude update and retryError: Cannot find module 'C:UsersusernameDocuments'
Solution: Windows paths need to use forward slashes or double backslashes:
# Wrong
claude mcp add fs -- npx -y @modelcontextprotocol/server-filesystem C:\Users\username\Documents
# Correct
claude mcp add fs -- npx -y @modelcontextprotocol/server-filesystem C:/Users/username/Documents
# or
claude mcp add fs -- npx -y @modelcontextprotocol/server-filesystem C:\\Users\\username\\Documents
Permission denied
Solution:
sudo (not recommended) or modify file permissionsWhen encountering problems, these debugging methods can help you quickly locate issues:
claude --debug
In Claude Code, enter:
/mcp
macOS/Linux:
tail -f ~/Library/Logs/Claude/mcp*.log
Windows:
type "%APPDATA%\Claude\logs\mcp*.log"
# Directly run server command to see if there's output
npx -y @modelcontextprotocol/server-filesystem ~/Documents
Avoid using non-English characters in paths:
# Avoid
claude mcp add fs -- npx -y @modelcontextprotocol/server-filesystem ~/文档
# Recommended
claude mcp add fs -- npx -y @modelcontextprotocol/server-filesystem ~/Documents
If you're using a proxy:
# Set npm proxy
npm config set proxy http://your-proxy:port
npm config set https-proxy http://your-proxy:port
# Then add MCP server
claude mcp add ...
Use mirror sources to accelerate downloads:
# Temporary use
claude mcp add fs -- npx -y --registry=https://registry.npmjs.org @modelcontextprotocol/server-filesystem ~/Documents
# Or permanent setting
npm config set registry https://registry.npmjs.org
claude mcp remove <name> to delete unused servers~/.claude.json fileIf existing MCP servers can't meet your needs, you can create your own:
// my-mcp-server.js
import { Server } from "@modelcontextprotocol/sdk";
const server = new Server({
name: "my-custom-server",
version: "1.0.0",
});
server.setRequestHandler("tools/list", async () => {
return {
tools: [
{
name: "my_custom_tool",
description: "Custom tool",
inputSchema: {
type: "object",
properties: {
input: { type: "string" },
},
},
},
],
};
});
server.start();
Create a script to configure all common MCP servers at once:
#!/bin/bash
# setup-mcp.sh
echo "Configuring common MCP servers..."
# File system
claude mcp add filesystem -s user -- npx -y @modelcontextprotocol/server-filesystem ~/Documents ~/Projects
# GitHub
read -p "Enter GitHub Token: " github_token
claude mcp add github -s user -e GITHUB_TOKEN=$github_token -- npx -y @modelcontextprotocol/server-github
# Other servers...
echo "MCP servers configured successfully!"
# npm install -g git-mcp-server
# claude mcp add git "git-mcp-server"
# claude mcp add github "github-mcp-server --token $GITHUB_TOKEN"
npm install -g postgres-mcp-server
npm install -g mysql-mcp-server
npm install -g sqlite-mcp-server
# Setup examples may look like this:
# export POSTGRES_URL="postgresql://user:password@localhost:5432/mydb"
# claude mcp add postgres "postgres-mcp-server --url $POSTGRES_URL"
# Allow specific MCP tools
claude --allowedTools "mcp__git__commit,mcp__git__push"
# Allow all tools from specific server
claude --allowedTools "mcp__postgres__*"
# Combined with built-in tools
claude --allowedTools "Edit,View,mcp__git__*"
This page provides reference documentation for implementing hooks in Claude Code.
[!TIP] For a quickstart guide with examples, see Get started with Claude Code hooks.
Claude Code hooks are configured in your settings files:
~/.claude/settings.json - User settings.claude/settings.json - Project settings.claude/settings.local.json - Local project settings (not committed)Hooks are organized by matchers, where each matcher can have multiple hooks:
{
"hooks": {
"EventName": [
{
"matcher": "ToolPattern",
"hooks": [
{
"type": "command",
"command": "your-command-here",
"args": ["--flag", "value"]
}
]
}
]
}
}
In addition to shell commands, hooks can POST JSON to a URL and receive a JSON response:
{
"hooks": {
"PreToolUse": [
{
"matcher": "Bash",
"hooks": [
{
"type": "http",
"url": "https://hooks.example.com/validate",
"timeout": 10
}
]
}
]
}
}
HTTP hooks send the same JSON payload that command hooks receive via stdin, as a POST body. The response JSON follows the same output schema. This is useful for centralized policy enforcement or remote hook execution without local scripts.
PreToolUse and PostToolUse)
Write matches only the Write toolEdit|Write or Notebook.** to match all tools. You can also use empty string ("") or leave
matcher blank.type: "command" (shell command) or "http" (POST JSON to a URL)command: The bash command to execute (can use $CLAUDE_PROJECT_DIR
environment variable)args: Optional exec-form arguments for command hooks, avoiding shell quoting issuestimeout: (Optional) How long a command should run, in seconds, before
canceling that specific command.For events like UserPromptSubmit, Notification, Stop, and SubagentStop
that don't use matchers, you can omit the matcher field:
{
"hooks": {
"UserPromptSubmit": [
{
"hooks": [
{
"type": "command",
"command": "/path/to/prompt-validator.py"
}
]
}
]
}
}
You can use the environment variable CLAUDE_PROJECT_DIR (only available when
Claude Code spawns the hook command) to reference scripts stored in your project,
ensuring they work regardless of Claude's current directory:
{
"hooks": {
"PostToolUse": [
{
"matcher": "Write|Edit",
"hooks": [
{
"type": "command",
"command": "$CLAUDE_PROJECT_DIR/.claude/hooks/check-style.sh"
}
]
}
]
}
}
Runs after Claude creates tool parameters and before processing the tool call.
Common matchers:
Task - Subagent tasks (see subagents documentation)Bash - Shell commandsGlob - File pattern matchingGrep - Content searchRead - File readingEdit, MultiEdit - File editingWrite - File writingWebFetch, WebSearch - Web operationsRuns immediately after a tool completes successfully.
Recognizes the same matcher values as PreToolUse. Set continueOnBlock: true in hook config when you want a PostToolUse block reason to be fed back to Claude and allow the turn to continue.
Runs when Claude Code sends notifications. Notifications are sent when:
Runs when the user submits a prompt, before Claude processes it. This allows you to add additional context based on the prompt/conversation, validate prompts, or block certain types of prompts.
Runs when the main Claude Code agent has finished responding. Does not run if the stoppage occurred due to a user interrupt.
Runs when a Claude Code subagent (Task tool call) has finished responding.
Triggered when an agent teammate becomes idle (multi-agent workflows).
Triggered when a background task completes (multi-agent workflows).
Fires when Claude Code configuration files change (e.g., settings, CLAUDE.md, .mcp.json). Useful for reloading external state or triggering side effects on config edits.
Fires when Claude creates a new git worktree (via --worktree / -w flag or isolation: worktree in agent definitions). Useful for setting up worktree-specific resources.
Fires when a git worktree is cleaned up after use. Useful for tearing down worktree-specific resources.
Triggered via --init, --init-only, or --maintenance CLI flags. Useful for one-time project setup tasks, plugin installation, or maintenance scripts.
Fires when Claude shows a permission prompt to the user. Useful for logging or automating permission decisions.
Fires after an auto mode classifier denial. Hooks can return { "retry": true } when the model should retry with the denial feedback.
Runs as assistant message text is displayed, allowing hooks to transform or hide displayed assistant content.
Runs after a compaction operation completes.
Runs before Claude Code is about to run a compact operation.
Matchers:
manual - Invoked from /compactauto - Invoked from auto-compact (due to full context window)Runs when Claude Code starts a session or resumes one. Useful for loading development context like existing issues or recent changes to your codebase.
Matchers:
startup - Invoked from startupresume - Invoked from --resume, --continue, or /resumeclear - Invoked from /clearSessionStart hooks can also request reloadSkills: true and set hookSpecificOutput.sessionTitle, making newly installed skills available immediately and naming startup/resume sessions.
Hooks receive JSON data via stdin containing session information and event-specific data:
{
// Common fields
session_id: string
transcript_path: string // Path to conversation JSON
cwd: string // The current working directory when the hook is invoked
// Event-specific fields
hook_event_name: string
...
}
The exact schema for tool_input depends on the tool.
{
"session_id": "abc123",
"transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",
"cwd": "/Users/...",
"hook_event_name": "PreToolUse",
"tool_name": "Write",
"tool_input": {
"file_path": "/path/to/file.txt",
"content": "file content"
}
}
The exact schema for tool_input and tool_response depends on the tool.
{
"session_id": "abc123",
"transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",
"cwd": "/Users/...",
"hook_event_name": "PostToolUse",
"tool_name": "Write",
"tool_input": {
"file_path": "/path/to/file.txt",
"content": "file content"
},
"tool_response": {
"filePath": "/path/to/file.txt",
"success": true
}
}
{
"session_id": "abc123",
"transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",
"cwd": "/Users/...",
"hook_event_name": "Notification",
"message": "Task completed successfully"
}
{
"session_id": "abc123",
"transcript_path": "/Users/.../.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",
"cwd": "/Users/...",
"hook_event_name": "UserPromptSubmit",
"prompt": "Write a function to calculate the factorial of a number"
}
stop_hook_active is true when Claude Code is already continuing as a result of
a stop hook. Check this value or process the transcript to prevent Claude Code
from running indefinitely.
{
"session_id": "abc123",
"transcript_path": "~/.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",
"hook_event_name": "Stop",
"stop_hook_active": true,
"last_assistant_message": "I've completed all the requested changes."
}
The
last_assistant_messagefield contains the final text Claude produced before stopping. Useful for validating completeness or logging outcomes.
For manual, custom_instructions comes from what the user passes into
/compact. For auto, custom_instructions is empty.
{
"session_id": "abc123",
"transcript_path": "~/.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",
"hook_event_name": "PreCompact",
"trigger": "manual",
"custom_instructions": ""
}
{
"session_id": "abc123",
"transcript_path": "~/.claude/projects/.../00893aaf-19fa-41d2-8238-13269b9b3ca0.jsonl",
"hook_event_name": "SessionStart",
"source": "startup"
}
There are two ways for hooks to return output back to Claude Code. The output communicates whether to block and any feedback that should be shown to Claude and the user.
Hooks communicate status through exit codes, stdout, and stderr:
stdout is shown to the user in transcript mode
(CTRL-R), except for UserPromptSubmit and SessionStart, where stdout is
added to the context.stderr is fed back to Claude to process
automatically. See per-hook-event behavior below.stderr is shown to the user and
execution continues.[!WARNING] Reminder: Claude Code does not see stdout if the exit code is 0, except for the
UserPromptSubmithook where stdout is injected as context.
| Hook Event | Behavior |
|---|---|
PreToolUse | Blocks the tool call, shows stderr to Claude |
PostToolUse | Shows stderr to Claude (tool already ran) |
Notification | N/A, shows stderr to user only |
UserPromptSubmit | Blocks prompt processing, erases prompt, shows stderr to user only |
Stop | Blocks stoppage, shows stderr to Claude |
SubagentStop | Blocks stoppage, shows stderr to Claude subagent |
PreCompact | N/A, shows stderr to user only |
SessionStart | N/A, shows stderr to user only |
Hooks can return structured JSON in stdout for more sophisticated control:
All hook types can include these optional fields:
{
"continue": true, // Whether Claude should continue after hook execution (default: true)
"stopReason": "string" // Message shown when continue is false
"suppressOutput": true, // Hide stdout from transcript mode (default: false)
}
If continue is false, Claude stops processing after the hooks run.
PreToolUse, this is different from "permissionDecision": "deny", which
only blocks a specific tool call and provides automatic feedback to Claude.PostToolUse, this is different from "decision": "block", which
provides automated feedback to Claude.UserPromptSubmit, this prevents the prompt from being processed.Stop and SubagentStop, this takes precedence over any
"decision": "block" output."continue" = false takes precedence over any
"decision": "block" output.stopReason accompanies continue with a reason shown to the user, not shown
to Claude.
PreToolUse Decision ControlPreToolUse hooks can control whether a tool call proceeds.
"allow" bypasses the permission system. permissionDecisionReason is shown
to the user but not to Claude. (Deprecated "approve" value + reason has
the same behavior.)"deny" prevents the tool call from executing. permissionDecisionReason is
shown to Claude. ("block" value + reason has the same behavior.)"ask" asks the user to confirm the tool call in the UI.
permissionDecisionReason is shown to the user but not to Claude.{
"hookSpecificOutput": {
"hookEventName": "PreToolUse",
"permissionDecision": "allow" | "deny" | "ask",
"permissionDecisionReason": "My reason here (shown to user)"
},
"decision": "approve" | "block" | undefined, // Legacy PreToolUse field; prefer permissionDecision
"reason": "Explanation for decision" // Legacy PreToolUse field; prefer permissionDecisionReason
}
PostToolUse Decision ControlPostToolUse hooks can control whether a tool call proceeds.
"block" automatically prompts Claude with reason.continueOnBlock: true in the hook configuration feeds the block reason back while allowing Claude to continue the same turn.undefined does nothing. reason is ignored.{
"decision": "block" | undefined,
"reason": "Explanation for decision"
}
UserPromptSubmit Decision ControlUserPromptSubmit hooks can control whether a user prompt is processed.
"block" prevents the prompt from being processed. The submitted prompt is
erased from context. "reason" is shown to the user but not added to context.undefined allows the prompt to proceed normally. "reason" is ignored."hookSpecificOutput.additionalContext" adds the string to the context if not
blocked.{
"decision": "block" | undefined,
"reason": "Explanation for decision",
"hookSpecificOutput": {
"hookEventName": "UserPromptSubmit",
"additionalContext": "My additional context here"
}
}
Stop/SubagentStop Decision ControlStop and SubagentStop hooks can control whether Claude must continue.
"block" prevents Claude from stopping. You must populate reason for Claude
to know how to proceed.undefined allows Claude to stop. reason is ignored.{
"decision": "block" | undefined,
"reason": "Must be provided when Claude is blocked from stopping"
}
SessionStart Decision ControlSessionStart hooks allow you to load in context at the start of a session.
"hookSpecificOutput.additionalContext" adds the string to the context."hookSpecificOutput.sessionTitle" sets the session title on startup/resume."reloadSkills": true re-scans skill directories after the hook finishes.{
"reloadSkills": true,
"hookSpecificOutput": {
"hookEventName": "SessionStart",
"additionalContext": "My additional context here",
"sessionTitle": "Focused refactor"
}
}
Hooks can return terminalSequence to emit desktop notifications, window titles, or bells without needing direct terminal access.
#!/usr/bin/env python3
import json
import re
import sys
# Define validation rules as a list of (regex pattern, message) tuples
VALIDATION_RULES = [
(
r"\bgrep\b(?!.*\|)",
"Use 'rg' (ripgrep) instead of 'grep' for better performance and features",
),
(
r"\bfind\s+\S+\s+-name\b",
"Use 'rg --files | rg pattern' or 'rg --files -g pattern' instead of 'find -name' for better performance",
),
]
def validate_command(command: str) -> list[str]:
issues = []
for pattern, message in VALIDATION_RULES:
if re.search(pattern, command):
issues.append(message)
return issues
try:
input_data = json.load(sys.stdin)
except json.JSONDecodeError as e:
print(f"Error: Invalid JSON input: {e}", file=sys.stderr)
sys.exit(1)
tool_name = input_data.get("tool_name", "")
tool_input = input_data.get("tool_input", {})
command = tool_input.get("command", "")
if tool_name != "Bash" or not command:
sys.exit(1)
# Validate the command
issues = validate_command(command)
if issues:
for message in issues:
print(f"• {message}", file=sys.stderr)
# Exit code 2 blocks tool call and shows stderr to Claude
sys.exit(2)
[!NOTE] For
UserPromptSubmithooks, you can inject context using either method:
- Exit code 0 with stdout: Claude sees the context (special case for
UserPromptSubmit)- JSON output: Provides more control over the behavior
#!/usr/bin/env python3
import json
import sys
import re
import datetime
# Load input from stdin
try:
input_data = json.load(sys.stdin)
except json.JSONDecodeError as e:
print(f"Error: Invalid JSON input: {e}", file=sys.stderr)
sys.exit(1)
prompt = input_data.get("prompt", "")
# Check for sensitive patterns
sensitive_patterns = [
(r"(?i)\b(password|secret|key|token)\s*[:=]", "Prompt contains potential secrets"),
]
for pattern, message in sensitive_patterns:
if re.search(pattern, prompt):
# Use JSON output to block with a specific reason
output = {
"decision": "block",
"reason": f"Security policy violation: {message}. Please rephrase your request without sensitive information."
}
print(json.dumps(output))
sys.exit(0)
# Add current time to context
context = f"Current time: {datetime.datetime.now()}"
print(context)
"""
The following is also equivalent:
print(json.dumps({
"hookSpecificOutput": {
"hookEventName": "UserPromptSubmit",
"additionalContext": context,
},
}))
"""
# Allow the prompt to proceed with the additional context
sys.exit(0)
#!/usr/bin/env python3
import json
import sys
# Load input from stdin
try:
input_data = json.load(sys.stdin)
except json.JSONDecodeError as e:
print(f"Error: Invalid JSON input: {e}", file=sys.stderr)
sys.exit(1)
tool_name = input_data.get("tool_name", "")
tool_input = input_data.get("tool_input", {})
# Example: Auto-approve file reads for documentation files
if tool_name == "Read":
file_path = tool_input.get("file_path", "")
if file_path.endswith((".md", ".mdx", ".txt", ".json")):
# Use JSON output to auto-approve the tool call
output = {
"decision": "approve",
"reason": "Documentation file auto-approved",
"suppressOutput": True # Don't show in transcript mode
}
print(json.dumps(output))
sys.exit(0)
# For other cases, let the normal permission flow proceed
sys.exit(0)
Claude Code hooks work seamlessly with Model Context Protocol (MCP) tools. When MCP servers provide tools, they appear with a special naming pattern that you can match in your hooks.
MCP tools follow the pattern mcp__<server>__<tool>, for example:
mcp__memory__create_entities - Memory server's create entities toolmcp__filesystem__read_file - Filesystem server's read file toolmcp__github__search_repositories - GitHub server's search toolYou can target specific MCP tools or entire MCP servers:
{
"hooks": {
"PreToolUse": [
{
"matcher": "mcp__memory__.*",
"hooks": [
{
"type": "command",
"command": "echo 'Memory operation initiated' >> ~/mcp-operations.log"
}
]
},
{
"matcher": "mcp__.*__write.*",
"hooks": [
{
"type": "command",
"command": "/home/user/scripts/validate-mcp-write.py"
}
]
}
]
}
}
[!TIP] For practical examples including code formatting, notifications, and file protection, see More Examples in the get started guide.
USE AT YOUR OWN RISK: Claude Code hooks execute arbitrary shell commands on your system automatically. By using hooks, you acknowledge that:
Always review and understand any hook commands before adding them to your configuration.
Here are some key practices for writing more secure hooks:
"$VAR" not $VAR.. in file paths$CLAUDE_PROJECT_DIR for the project path).env, .git/, keys, etc.Direct edits to hooks in settings files don't take effect immediately. Claude Code:
/hooks menu for changes to applyThis prevents malicious hook modifications from affecting your current session.
CLAUDE_PROJECT_DIR environment variable is available and contains the
absolute path to the project root directory--debug)If your hooks aren't working:
/hooks to see if your hook is registeredclaude --debug to see hook execution detailsCommon issues:
\" inside JSON stringsFor complex hook issues:
claude --debug to see detailed hook
executionUse claude --debug to see hook execution details:
[DEBUG] Executing hooks for PostToolUse:Write
[DEBUG] Getting matching hook commands for PostToolUse with query: Write
[DEBUG] Found 1 hook matchers in settings
[DEBUG] Matched 1 hooks for query "Write"
[DEBUG] Found 1 hook commands to execute
[DEBUG] Executing hook command: <Your command> with timeout 60000ms
[DEBUG] Hook command completed with status 0: <Your stdout>
Progress messages appear in transcript mode (Ctrl-R) showing:
# Allow specific tools (read/edit files)
claude --allowedTools "Edit,Read"
# Allow tool categories incl. Bash (but still scoped below)
claude --allowedTools "Edit,Read,Bash"
# Scoped permissions (all git commands)
claude --allowedTools "Bash(git:*)"
# Multiple scopes (git + npm)
claude --allowedTools "Bash(git:*),Bash(npm:*)"
[!Warning] NEVER use in Production systems, shared machines, or any systems with important data Only use with isolated environments like a Docker container, using this mode can cause data loss and comprimise your system!
claude --dangerously-skip-permissions
GitHub Actions you can copy/paste :p
ANTHROPIC_API_KEY Settings → Secrets and variables → Actions → New repository secret.github/workflows/.[!TIP] Pin Actions to a release tag (e.g.
@v1) when you adopt them long‑term. The snippets below use branch tags for readability.
Creates a structured review (with inline comments) as soon as a PR opens or updates.
File: .github/workflows/claude-pr-auto-review.yml
name: Auto review PRs
on:
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
permissions:
contents: read
pull-requests: write
jobs:
auto-review:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 1
- name: Claude PR review
uses: anthropics/claude-code-action@main
with:
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
# Claude will fetch the diff and leave inline comments
direct_prompt: |
Review this pull request’s diff for correctness, readability, testing, performance, and DX.
Prefer specific, actionable suggestions. Use inline comments where relevant.
# GitHub tools permitted during the run:
allowed_tools: >-
mcp__github__get_pull_request_diff,
mcp__github__create_pending_pull_request_review,
mcp__github__add_comment_to_pending_review,
mcp__github__submit_pending_pull_request_review
Runs a focused security scan and comments findings directly on the PR.
File: .github/workflows/claude-security-review.yml
name: Security Review
on:
pull_request:
permissions:
contents: read
pull-requests: write
jobs:
security:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
ref: ${{ github.event.pull_request.head.sha || github.sha }}
fetch-depth: 2
- name: Claude Code Security Review
uses: anthropics/claude-code-security-review@main
with:
claude-api-key: ${{ secrets.ANTHROPIC_API_KEY }}
comment-pr: true
# Optional:
# exclude-directories: "docs,examples"
# claudecode-timeout: "20"
# claude-model: "sonnet"
When an issue opens, Claude proposes labels/severity and posts a tidy triage comment. You can enable auto‑apply labels by flipping a single flag
File: .github/workflows/claude-issue-triage.yml
name: Claude Issue Triage
on:
issues:
types: [opened, edited, reopened]
permissions:
contents: read
issues: write
jobs:
triage:
runs-on: ubuntu-latest
env:
CLAUDE_MODEL: sonnet
steps:
- name: Collect context & similar issues
id: gather
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
TITLE="${{ github.event.issue.title }}"
BODY="${{ github.event.issue.body }}"
# naive similar search by title words
Q=$(echo "$TITLE" | tr -dc '[:alnum:] ' | awk '{print $1" "$2" "$3" "$4}')
gh api -X GET search/issues -f q="repo:${{ github.repository }} is:issue $Q" -f per_page=5 > similars.json
echo "$TITLE" > title.txt
echo "$BODY" > body.txt
- name: Ask Claude for triage JSON
env:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
run: |
cat > payload.json << 'JSON'
{
"model": "${{ env.CLAUDE_MODEL }}",
"max_tokens": 1500,
"system": "You are a pragmatic triage engineer. Be specific, cautious with duplicates.",
"messages": [{
"role": "user",
"content": [{
"type":"text",
"text":"Given the issue and similar candidates, produce STRICT JSON with keys: labels (array of strings), severity (one of: low, medium, high, critical), duplicate_url (string or empty), comment_markdown (string brief). Do not include any extra keys."
},
{"type":"text","text":"Issue title:\n"},
{"type":"text","text": (include from file) },
{"type":"text","text":"\n\nIssue body:\n"},
{"type":"text","text": (include from file) },
{"type":"text","text":"\n\nSimilar issues (JSON):\n"},
{"type":"text","text": (include from file) }]
}]
}
JSON
# Inject files safely
jq --arg title "$(cat title.txt)" '.messages[0].content[2].text = $title' payload.json \
| jq --arg body "$(cat body.txt)" '.messages[0].content[4].text = $body' \
| jq --arg sims "$(cat similars.json)" '.messages[0].content[6].text = $sims' > payload.final.json
curl -s https://api.anthropic.com/v1/messages \
-H "x-api-key: $ANTHROPIC_API_KEY" \
-H "anthropic-version: 2023-06-01" \
-H "content-type: application/json" \
-d @payload.final.json > out.json
jq -r '.content[0].text' out.json > triage.json || echo '{}' > triage.json
# Validate JSON to avoid posting garbage
jq -e . triage.json >/dev/null 2>&1 || echo '{"labels":[],"severity":"low","duplicate_url":"","comment_markdown":"(triage failed to parse)"}' > triage.json
- name: Apply labels (optional)
if: ${{ false }} # flip to `true` to auto-apply labels
uses: actions/github-script@v7
with:
script: |
const triage = JSON.parse(require('fs').readFileSync('triage.json','utf8'))
if (triage.labels?.length) {
await github.rest.issues.addLabels({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
labels: triage.labels
})
}
- name: Post triage comment
uses: actions/github-script@v7
with:
script: |
const fs = require('fs')
const triage = JSON.parse(fs.readFileSync('triage.json','utf8'))
const md = `### 🤖 Triage
- **Suggested labels:** ${triage.labels?.join(', ') || '—'}
- **Severity:** ${triage.severity || '—'}
${triage.duplicate_url ? `- **Possible duplicate:** ${triage.duplicate_url}\n` : ''}
---
${triage.comment_markdown || ''}`
await github.rest.issues.createComment({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: context.issue.number,
body: md
})
[!NOTE] The triage workflow posts a suggestion comment by default. Flip the
Apply labelsstep totrueif you want labels applied automatically.Configuration & Customization
- Model selection: set
CLAUDE_MODEL(e.g.,sonnet,opus, or a full pinned model ID) where shown.- Secrets:
ANTHROPIC_API_KEYis required. The built‑inGITHUB_TOKENis sufficient for posting comments and applying labels.- Permissions: each workflow declares the least privileges it needs (
pull-requests: writeand/orissues: write). Adjust only if your org requires stricter policies.- Scope: use
paths:filters on triggers to limit when workflows run (e.g., only for/srcor exclude/docs).Troubleshooting
Check the Actions logs first—most issues are missing secrets/permissions or a mis‑indented YAML block.
- No comments appear on PRs: Verify the Claude GitHub App is installed and the workflow has
pull-requests: writepermission.- 403 when applying labels: Ensure the job or step has
issues: write. The defaultGITHUB_TOKENmust have access to this repo.- Anthropic API errors: Confirm
ANTHROPIC_API_KEYis set at repository (or org) level and not expired.- “YAML not well‑formed”: Validate spacing—two spaces per nesting level; no tabs.
[!TIP] Q:
claudenot found, butnpx claudeworks?A: Your
PATHis missing the npm global bin. See thePATHissue section forWindowsorLinuxQ: Which Node.js version do I need?
A: Node.js 18+ (ideally 20+). Check with
node --version.Q: Where do I see logs
A: Run
claude doctorandclaude --verbosethe diagnostic window will point to log locations.Q: Do I need to reboot after editing PATH?
A: No reboot required, but you must open a new terminal window.
Debug Quick CommandsCheck the output of
|
Path Temp FixYour PATH likely doesn’t include the global npm bin directory.
|
Windows Path Perm FixReplace
hljs language-path
hljs language-path
hljs language-C
|
Installation / Node.js IssuesMust be Node 18+ (20+ recommended) hljs language-bash Clean uninstall hljs language-bash Fresh install hljs language-bash |
Authentication Issues> *Verify your Anthropic API key is available to the CLI.*PowerShell (Windows): hljs language-powershell bash/zsh (macOS/Linux): hljs language-bash If the variable is empty set it for your shell/profile or use your OS keychain/secrets manager. |
Permission / Allowed Tools IssuesInspect permissions hljs language-bash Reset permissions hljs language-bash Minimal safe set (example) hljs language-bash |
MCP (Model Context Protocol) Issues
hljs language-bash
hljs language-bash |
Full Clean Reinstall (Windows / PowerShell)
hljs language-powershell
hljs language-powershell
hljs language-powershell
hljs language-powershell
hljs language-powershell |
One‑Shot Health Check (copy/paste)Windows (PowerShell): hljs language-powershell macOS/Linux (bash/zsh): hljs language-bash |
Appendix: Useful Paths
|
Curated guidance for safe, fast, and correct use of the Claude Code CLI and interactive REPL.
# Good: Specific and detailed
claude "Review UserAuth.js for security vulnerabilities, focusing on JWT handling"
# Bad: Vague
claude "check my code"
Tip: claude "query" starts the interactive REPL pre-seeded with your prompt; claude -p "query" runs print mode (non‑interactive) and exits.
Start with minimal permissions
# Allow only what you need for this run
claude --allowedTools "Read" "Grep" "LS" "Bash(npm run test:*)"
Or commit a project policy at .claude/settings.json:
{
"permissions": {
"allow": ["Read", "Grep", "LS", "Bash(npm run test:*)"],
"deny": [
"WebFetch",
"Bash(curl:*)",
"Read(./.env)",
"Read(./secrets/**)"
]
}
}
Handle secrets correctly
export ANTHROPIC_API_KEY="your_key" # for SDK/print mode
/login instead of hard‑coding tokens.ignorePatterns):{
"permissions": {
"deny": ["Read(./.env)", "Read(./.env.*)", "Read(./secrets/**)"]
}
}
Audit permissions regularly
# Project settings
claude config list
claude config get permissions.allow
claude config get permissions.deny
# Global settings
claude config list -g
Avoid bypass modes in production
--dangerously-skip-permissions outside isolated/dev sandboxes.--allowedTools with --disallowedTools and project settings.Use machine‑readable output in automations
claude -p "summarize this error log" --output-format json
# valid: text | json | stream-json
Bound non‑interactive work
claude -p "run type checks and summarize failures" --max-turns 3
# optionally also bound thinking:
export MAX_THINKING_TOKENS=20000
Keep sessions tidy
# Retain recent sessions only (default is 30 days)
claude config set -g cleanupPeriodDays 20
Limit context scope
# Grant access only to relevant paths to reduce scanning/noise
claude --add-dir ./services/api ./packages/ui
Pick the right model
--model sonnet or --model opus (family alias selected by Claude Code)./effort xhigh for the hardest planning, review, and long-context tasks.export CLAUDE_CODE_NO_FLICKER=1
export ENABLE_PROMPT_CACHING_1H=true
/usage
Use /usage to break down plan usage by categories such as skills, subagents, plugins, and MCP servers.
1) Health checks Use the built‑in doctor command to verify installation and environment.
# Every 15 minutes
*/15 * * * * /usr/local/bin/claude doctor >/dev/null 2>&1 || \
mail -s "Claude Code doctor failed" admin@company.com </dev/null
2) Log analysis batch job
# Daily analysis with non-interactive JSON output (print mode)
0 6 * * * tail -1000 /var/log/app.log | \
claude -p "Analyze errors, regressions, and suspect patterns; output JSON." \
--output-format json > /tmp/daily-analysis.json
3) Telemetry (optional) Claude Code emits OpenTelemetry metrics/events. Set exporters in settings/env (e.g., OTLP) and ship to your observability stack (Datadog, Honeycomb, Prometheus/Grafana, etc.).
1) Share versioned configuration
// .claude/settings.json (checked into the repo)
{
"permissions": {
"allow": [
"Read",
"Grep",
"LS",
"Bash(npm run lint)",
"Bash(npm run test:*)",
],
"deny": [
"WebFetch",
"Read(./.env)",
"Read(./.env.*)",
"Read(./secrets/**)",
],
},
// Use a family alias for automatic model selection, or pin a full model ID for reproducibility:
"model": "sonnet",
}
2) Documentation automation
# Update docs with explicit tasks
claude "Update README.md to reflect the latest API endpoints and examples."
claude "Generate TypeScript types from schema.prisma and write to /types."
3) Code review standards
# Review a local diff with constrained tools
git fetch origin main
git diff origin/main...HEAD > /tmp/diff.patch
claude --allowedTools "Read" "Grep" "Bash(git:*)" \
"Review /tmp/diff.patch using team standards:
- Security best practices
- Performance considerations
- Code style compliance
- Test coverage adequacy"
1) Project runbooks
claude "Create a deployment runbook for this app: steps, checks, rollback."
claude "Document onboarding for new developers: setup, commands, conventions."
2) Architecture docs
claude "Update architecture docs to reflect new microservices."
claude "Create sequence diagrams for the authentication flow."
Tip: Keep durable context in CLAUDE.md at the project root. In the REPL, use
/memoryto manage it and@pathto import file content into prompts.
❌ Don’t
--dangerously-skip-permissions on production systemsBash(*))✅ Do
permissions.allow and expand graduallyclaude config list / claude config get❌ Don’t
✅ Do
--add-dir for focused context--max-turns and MAX_THINKING_TOKENScleanupPeriodDays to prune old sessions❌ Don’t
CLAUDE.md)✅ Do
CLAUDE.mdUse provider setup examples when connecting Claude Code to Anthropic-compatible gateways or third-party model providers. The pattern is usually:
claude and verify the session starts with the expected provider.npm install -g @anthropic-ai/claude-code
export ANTHROPIC_BASE_URL=https://api.deepseek.com/anthropic
export ANTHROPIC_AUTH_TOKEN=${YOUR_API_KEY}
export ANTHROPIC_MODEL=deepseek-chat
export ANTHROPIC_SMALL_FAST_MODEL=deepseek-chat
claudeFind more information from the Official Deepseek Docs
Run Claude Code as an MCP server so any agent can delegate coding tasks to it
Browser automation using accessibility snapshots instead of screenshots
Secure MCP server for MySQL database interaction, queries, and schema management
English-first Korean equity intelligence MCP — DART filings, foreign-holder 5%-rule flows, activist filings, KRX news. F