> ## Documentation Index
> Fetch the complete documentation index at: https://code.claude.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Claude code docs map

# Claude Code Documentation Map

This is a comprehensive map of all Claude Code documentation pages with their headings, designed for easy navigation by LLMs.

> **Note:** This file is auto-generated by GitHub Actions. Do not edit manually.
> Last updated: 2026-04-13 21:34:12 UTC

## Document Structure

This map uses a hierarchical structure:

* **##** marks documentation groups (e.g., 'Getting started')
* **###** marks individual documentation pages
* **Nested bullets** show the heading structure within each page
* Each page title links to the full documentation

## Getting started

### [overview](https://code.claude.com/docs/en/overview.md)

* Get started
* Capabilities
  * Claude Code features
* Compare the Agent SDK to other Claude tools
* Changelog
* Reporting bugs
* Branding guidelines
* License and terms
* Next steps

### [quickstart](https://code.claude.com/docs/en/quickstart.md)

* Prerequisites
* Setup
* Create a buggy file
* Build an agent that finds and fixes bugs
  * Run your agent
  * Try other prompts
  * Customize your agent
* Key concepts
* Next steps

### [changelog](https://code.claude.com/docs/en/changelog.md)

* (No headings found)

## Core concepts

### [how-claude-code-works](https://code.claude.com/docs/en/how-claude-code-works.md)

* The agentic loop
  * Models
  * Tools
* What Claude can access
* Environments and interfaces
  * Execution environments
  * Interfaces
* Work with sessions
  * Work across branches
  * Resume or fork sessions
  * The context window
    * When context fills up
    * Manage context with skills and subagents
* Stay safe with checkpoints and permissions
  * Undo changes with checkpoints
  * Control what Claude can do
* Work effectively with Claude Code
  * Ask Claude Code for help
  * It's a conversation
    * Interrupt and steer
  * Be specific upfront
  * Give Claude something to verify against
  * Explore before implementing
  * Delegate, don't dictate
* What's next

### [features-overview](https://code.claude.com/docs/en/features-overview.md)

* Overview
* Match features to your goal
  * Build your setup over time
  * Compare similar features
  * Understand how features layer
  * Combine features
* Understand context costs
  * Context cost by feature
  * Understand how features load
* Learn more

### [claude-directory](https://code.claude.com/docs/en/claude-directory.md)

* What's not shown
* File reference
* Check what loaded
* Application data
  * Cleaned up automatically
  * Kept until you delete them
  * Plaintext storage
  * Clear local data
* Related resources

### [context-window](https://code.claude.com/docs/en/context-window.md)

* What the timeline shows
* What survives compaction
* Check your own session
* Related resources

## Use Claude Code

### [memory](https://code.claude.com/docs/en/memory.md)

* CLAUDE.md vs auto memory
* CLAUDE.md files
  * When to add to CLAUDE.md
  * Choose where to put CLAUDE.md files
  * Set up a project CLAUDE.md
  * Write effective instructions
  * Import additional files
  * AGENTS.md
  * How CLAUDE.md files load
    * Load from additional directories
  * Organize rules with `.claude/rules/`
    * Set up rules
    * Path-specific rules
    * Share rules across projects with symlinks
    * User-level rules
  * Manage CLAUDE.md for large teams
    * Deploy organization-wide CLAUDE.md
    * Exclude specific CLAUDE.md files
* Auto memory
  * Enable or disable auto memory
  * Storage location
  * How it works
  * Audit and edit your memory
* View and edit with `/memory`
* Troubleshoot memory issues
  * Claude isn't following my CLAUDE.md
  * I don't know what auto memory saved
  * My CLAUDE.md is too large
  * Instructions seem lost after `/compact`
* Related resources

### [permission-modes](https://code.claude.com/docs/en/permission-modes.md)

* Available modes
* Switch permission modes
* Auto-approve file edits with acceptEdits mode
* Analyze before you edit with plan mode
* Eliminate prompts with auto mode
  * What the classifier blocks by default
  * When auto mode falls back
* Allow only pre-approved tools with dontAsk mode
* Skip all checks with bypassPermissions mode
* Protected paths
* See also

### [common-workflows](https://code.claude.com/docs/en/common-workflows.md)

* Understand new codebases
  * Get a quick codebase overview
  * Find relevant code
* Fix bugs efficiently
* Refactor code
* Use specialized subagents
* Use Plan Mode for safe code analysis
  * When to use Plan Mode
  * How to use Plan Mode
  * Example: Planning a complex refactor
  * Configure Plan Mode as default
* Work with tests
* Create pull requests
* Handle documentation
* Work with images
* Reference files and directories
* Use extended thinking (thinking mode)
  * Configure thinking mode
  * How extended thinking works
* Resume previous conversations
  * Name your sessions
  * Use the session picker
* Run parallel Claude Code sessions with Git worktrees
  * Subagent worktrees
  * Worktree cleanup
  * Copy gitignored files to worktrees
  * Manage worktrees manually
  * Non-git version control
* Get notified when Claude needs your attention
* Use Claude as a unix-style utility
  * Add Claude to your verification process
  * Pipe in, pipe out
  * Control output format
* Run Claude on a schedule
* Ask Claude about its capabilities
  * Example questions
* Next steps

### [best-practices](https://code.claude.com/docs/en/best-practices.md)

* Give Claude a way to verify its work
* Explore first, then plan, then code
* Provide specific context in your prompts
  * Provide rich content
* Configure your environment
  * Write an effective CLAUDE.md
  * Configure permissions
  * Use CLI tools
  * Connect MCP servers
  * Set up hooks
  * Create skills
  * Create custom subagents
  * Install plugins
* Communicate effectively
  * Ask codebase questions
  * Let Claude interview you
* Manage your session
  * Course-correct early and often
  * Manage context aggressively
  * Use subagents for investigation
  * Rewind with checkpoints
  * Resume conversations
* Automate and scale
  * Run non-interactive mode
  * Run multiple Claude sessions
  * Fan out across files
  * Run autonomously with auto mode
* Avoid common failure patterns
* Develop your intuition
* Related resources

### Platforms and integrations > Claude Code on the web

#### [web-quickstart](https://code.claude.com/docs/en/web-quickstart.md)

* How sessions run
* Compare ways to run Claude Code
* Connect GitHub and create an environment
  * Connect from your terminal
* Start a task
* Review and iterate
* Troubleshoot setup
  * No repositories appear after connecting GitHub
  * The page only shows a GitHub login button
  * "Not available for the selected organization"
  * `/web-setup` returns "Unknown command"
  * "Could not create a cloud environment" or "No cloud environment available" when using `--remote` or ultraplan
  * Setup script failed
  * Session keeps running after closing the tab
* Next steps

#### [claude-code-on-the-web](https://code.claude.com/docs/en/claude-code-on-the-web.md)

* GitHub authentication options
* The cloud environment
  * What's available in cloud sessions
  * Installed tools
  * Work with GitHub issues and pull requests
  * Run tests, start services, and add packages
  * Resource limits
  * Configure your environment
* Setup scripts
  * Setup scripts vs. SessionStart hooks
  * Install dependencies with a SessionStart hook
* Network access
  * Access levels
  * Allow specific domains
  * GitHub proxy
  * Security proxy
  * Default allowed domains
* Move tasks between web and terminal
  * From terminal to web
    * Tips for cloud tasks
    * Send local repositories without GitHub
  * From web to terminal
    * Teleport requirements
    * `--teleport` is unavailable
* Work with sessions
  * Manage context
  * Review changes
  * Share sessions
    * Share from an Enterprise or Team account
    * Share from a Max or Pro account
  * Archive sessions
  * Delete sessions
* Auto-fix pull requests
  * How Claude responds to PR activity
* Security and isolation
* Limitations
* Related resources

#### [ultraplan](https://code.claude.com/docs/en/ultraplan.md)

* Launch ultraplan from the CLI
* Review and revise the plan in your browser
* Choose where to execute
  * Execute on the web
  * Send the plan back to your terminal
* Related resources

#### [web-scheduled-tasks](https://code.claude.com/docs/en/web-scheduled-tasks.md)

* Compare scheduling options
* Create a scheduled task
  * Frequency options
  * Repositories and branch permissions
  * Connectors
  * Environments
* Manage scheduled tasks
  * View and interact with runs
  * Edit and control tasks
* Related resources

### Platforms and integrations > Claude Code on desktop

#### [desktop-quickstart](https://code.claude.com/docs/en/desktop-quickstart.md)

* Install
* Start your first session
* Now what?
* Coming from the CLI?
* What's next

#### [desktop](https://code.claude.com/docs/en/desktop.md)

* Start a session
* Work with code
  * Use the prompt box
  * Add files and context to prompts
  * Choose a permission mode
  * Preview your app
  * Review changes with diff view
  * Review your code
  * Monitor pull request status
* Let Claude use your computer
  * When computer use applies
  * Enable computer use
  * App permissions
* Manage sessions
  * Work in parallel with sessions
  * Run long-running tasks remotely
  * Continue in another surface
  * Sessions from Dispatch
* Extend Claude Code
  * Connect external tools
  * Use skills
  * Install plugins
  * Configure preview servers
    * Auto-verify changes
    * Configuration fields
      * When to use `program` vs `runtimeExecutable`
    * Port conflicts
    * Examples
* Environment configuration
  * Local sessions
  * Remote sessions
  * SSH sessions
* Enterprise configuration
  * Admin console controls
  * Managed settings
  * Device management policies
  * Authentication and SSO
  * Data handling
  * Deployment
* Coming from the CLI?
  * CLI flag equivalents
  * Shared configuration
  * Feature comparison
  * What's not available in Desktop
* Troubleshooting
  * Check your version
  * 403 or authentication errors in the Code tab
  * Blank or stuck screen on launch
  * "Failed to load session"
  * Session not finding installed tools
  * Git and Git LFS errors
  * MCP servers not working on Windows
  * App won't quit
  * Windows-specific issues
  * Cowork tab unavailable on Intel Macs
  * "Branch doesn't exist yet" when opening in CLI
  * Still stuck?

#### [desktop-scheduled-tasks](https://code.claude.com/docs/en/desktop-scheduled-tasks.md)

* Compare scheduling options
* Create a scheduled task
* Frequency options
* How scheduled tasks run
* Missed runs
* Permissions for scheduled tasks
* Manage scheduled tasks
* Related resources

### Platforms and integrations > Code review & CI/CD

#### [code-review](https://code.claude.com/docs/en/code-review.md)

* How reviews work
  * Severity levels
  * Rate and reply to findings
  * Check run output
  * What Code Review checks
* Set up Code Review
* Manually trigger reviews
* Customize reviews
  * CLAUDE.md
  * REVIEW\.md
* View usage
* Pricing
* Troubleshooting
  * Retrigger a failed or timed-out review
  * Find issues that aren't showing as inline comments
* Related resources

#### [github-actions](https://code.claude.com/docs/en/github-actions.md)

* Why use Claude Code GitHub Actions?
* What can Claude do?
  * Claude Code Action
* Setup
* Quick setup
* Manual setup
* Upgrading from Beta
  * Essential changes
  * Breaking Changes Reference
  * Before and After Example
* Example use cases
  * Basic workflow
  * Using skills
  * Custom automation with prompts
  * Common use cases
* Best practices
  * CLAUDE.md configuration
  * Security considerations
  * Optimizing performance
  * CI costs
* Configuration examples
* Using with AWS Bedrock & Google Vertex AI
  * Prerequisites
    * For Google Cloud Vertex AI:
    * For AWS Bedrock:
* Troubleshooting
  * Claude not responding to @claude commands
  * CI not running on Claude's commits
  * Authentication errors
* Advanced configuration
  * Action parameters
    * Pass CLI arguments
  * Alternative integration methods
  * Customizing Claude's behavior

#### [github-enterprise-server](https://code.claude.com/docs/en/github-enterprise-server.md)

* What works with GitHub Enterprise Server
* Admin setup
  * GitHub App permissions
  * Manual setup
  * Network requirements
* Developer workflow
  * Teleport sessions to your terminal
* Plugin marketplaces on GHES
  * Add a GHES marketplace
  * Allowlist GHES marketplaces in managed settings
* Limitations
* Troubleshooting
  * Web session fails to clone repository
  * Marketplace add fails with a policy error
  * GHES instance not reachable
* Related resources

#### [gitlab-ci-cd](https://code.claude.com/docs/en/gitlab-ci-cd.md)

* Why use Claude Code with GitLab?
* How it works
* What can Claude do?
* Setup
  * Quick setup
  * Manual setup (recommended for production)
* Example use cases
  * Turn issues into MRs
  * Get implementation help
  * Fix bugs quickly
* Using with AWS Bedrock & Google Vertex AI
* Configuration examples
  * Basic .gitlab-ci.yml (Claude API)
  * AWS Bedrock job example (OIDC)
  * Google Vertex AI job example (Workload Identity Federation)
* Best practices
  * CLAUDE.md configuration
  * Security considerations
  * Optimizing performance
  * CI costs
* Security and governance
* Troubleshooting
  * Claude not responding to @claude commands
  * Job can't write comments or open MRs
  * Authentication errors
* Advanced configuration
  * Common parameters and variables
  * Customizing Claude's behavior

## Platforms and integrations

### [platforms](https://code.claude.com/docs/en/platforms.md)

* Where to run Claude Code
* Connect your tools
* Work when you are away from your terminal
* Related resources
  * Platforms
  * Integrations
  * Remote access

### [remote-control](https://code.claude.com/docs/en/remote-control.md)

* Requirements
* Start a Remote Control session
  * Connect from another device
  * Enable Remote Control for all sessions
* Connection and security
* Remote Control vs Claude Code on the web
* Limitations
* Troubleshooting
  * "Remote Control requires a claude.ai subscription"
  * "Remote Control requires a full-scope login token"
  * "Unable to determine your organization for Remote Control eligibility"
  * "Remote Control is not yet enabled for your account"
  * "Remote Control is disabled by your organization's policy"
  * "Remote credentials fetch failed"
* Choose the right approach
* Related resources

### [chrome](https://code.claude.com/docs/en/chrome.md)

* Capabilities
* Prerequisites
* Get started in the CLI
  * Enable Chrome by default
  * Manage site permissions
* Example workflows
  * Test a local web application
  * Debug with console logs
  * Automate form filling
  * Draft content in Google Docs
  * Extract data from web pages
  * Run multi-site workflows
  * Record a demo GIF
* Troubleshooting
  * Extension not detected
  * Browser not responding
  * Connection drops during long sessions
  * Windows-specific issues
  * Common error messages
* See also

### [computer-use](https://code.claude.com/docs/en/computer-use.md)

* What you can do with computer use
* When computer use applies
* Enable computer use
* Approve apps per session
* How Claude works on your screen
  * One session at a time
  * Apps are hidden while Claude works
  * Screenshots are downscaled automatically
  * Stop at any time
* Safety and the trust boundary
* Example workflows
  * Validate a native build
  * Reproduce a layout bug
  * Test a simulator flow
* Differences from the Desktop app
* Troubleshooting
  * "Computer use is in use by another Claude session"
  * macOS permissions prompt keeps reappearing
  * `computer-use` doesn't appear in `/mcp`
* See also

### [vs-code](https://code.claude.com/docs/en/vs-code.md)

* Prerequisites
* Install the extension
* Get started
* Use the prompt box
  * Reference files and folders
  * Resume past conversations
  * Resume remote sessions from Claude.ai
* Customize your workflow
  * Choose where Claude lives
  * Run multiple conversations
  * Switch to terminal mode
* Manage plugins
  * Install plugins
  * Manage marketplaces
* Automate browser tasks with Chrome
* VS Code commands and shortcuts
  * Launch a VS Code tab from other tools
* Configure settings
  * Extension settings
* VS Code extension vs. Claude Code CLI
  * Rewind with checkpoints
  * Run CLI in VS Code
  * Switch between extension and CLI
  * Include terminal output in prompts
  * Monitor background processes
  * Connect to external tools with MCP
* Work with git
  * Create commits and pull requests
  * Use git worktrees for parallel tasks
* Use third-party providers
* Security and privacy
  * The built-in IDE MCP server
* Fix common issues
  * Extension won't install
  * Spark icon not visible
  * Claude Code never responds
* Uninstall the extension
* Next steps

### [jetbrains](https://code.claude.com/docs/en/jetbrains.md)

* Supported IDEs
* Features
* Installation
  * Marketplace Installation
* Usage
  * From Your IDE
  * From External Terminals
* Configuration
  * Claude Code Settings
  * Plugin Settings
    * General Settings
    * ESC Key Configuration
* Special Configurations
  * Remote Development
  * WSL Configuration
* Troubleshooting
  * Plugin Not Working
  * IDE Not Detected
  * Command Not Found
* Security Considerations

### [slack](https://code.claude.com/docs/en/slack.md)

* Use cases
* Prerequisites
* Setting up Claude Code in Slack
* How it works
  * Automatic detection
  * Context gathering
  * Session flow
* User interface elements
  * App Home
  * Message actions
  * Repository selection
* Access and permissions
  * User-level access
  * Workspace-level access
  * Channel-based access control
* What's accessible where
* Best practices
  * Writing effective requests
  * When to use Slack vs. web
* Troubleshooting
  * Sessions not starting
  * Repository not showing
  * Wrong repository selected
  * Authentication errors
  * Session expiration
* Current limitations
* Related resources

## Agents

### [sub-agents](https://code.claude.com/docs/en/sub-agents.md)

* Built-in subagents
* Quickstart: create your first subagent
* Configure subagents
  * Use the /agents command
  * Choose the subagent scope
  * Write subagent files
    * Supported frontmatter fields
  * Choose a model
  * Control subagent capabilities
    * Available tools
    * Restrict which subagents can be spawned
    * Scope MCP servers to a subagent
    * Permission modes
    * Preload skills into subagents
    * Enable persistent memory
      * Persistent memory tips
    * Conditional rules with hooks
    * Disable specific subagents
  * Define hooks for subagents
    * Hooks in subagent frontmatter
    * Project-level hooks for subagent events
* Work with subagents
  * Understand automatic delegation
  * Invoke subagents explicitly
  * Run subagents in foreground or background
  * Common patterns
    * Isolate high-volume operations
    * Run parallel research
    * Chain subagents
  * Choose between subagents and main conversation
  * Manage subagent context
    * Resume subagents
    * Auto-compaction
* Example subagents
  * Code reviewer
  * Debugger
  * Data scientist
  * Database query validator
* Next steps

### [agent-teams](https://code.claude.com/docs/en/agent-teams.md)

* When to use agent teams
  * Compare with subagents
* Enable agent teams
* Start your first agent team
* Control your agent team
  * Choose a display mode
  * Specify teammates and models
  * Require plan approval for teammates
  * Talk to teammates directly
  * Assign and claim tasks
  * Shut down teammates
  * Clean up the team
  * Enforce quality gates with hooks
* How agent teams work
  * How Claude starts agent teams
  * Architecture
  * Use subagent definitions for teammates
  * Permissions
  * Context and communication
  * Token usage
* Use case examples
  * Run a parallel code review
  * Investigate with competing hypotheses
* Best practices
  * Give teammates enough context
  * Choose an appropriate team size
  * Size tasks appropriately
  * Wait for teammates to finish
  * Start with research and review
  * Avoid file conflicts
  * Monitor and steer
* Troubleshooting
  * Teammates not appearing
  * Too many permission prompts
  * Teammates stopping on errors
  * Lead shuts down before work is done
  * Orphaned tmux sessions
* Limitations
* Next steps

## Tools and plugins

### [mcp](https://code.claude.com/docs/en/mcp.md)

* Quickstart
* Add an MCP server
  * In code
  * From a config file
* Allow MCP tools
  * Tool naming convention
  * Grant access with allowedTools
  * Discover available tools
* Transport types
  * stdio servers
  * HTTP/SSE servers
  * SDK MCP servers
* MCP tool search
* Authentication
  * Pass credentials via environment variables
  * HTTP headers for remote servers
  * OAuth2 authentication
* Examples
  * List issues from a repository
  * Query a database
* Error handling
* Troubleshooting
  * Server shows "failed" status
  * Tools not being called
  * Connection timeouts
* Related resources

### [discover-plugins](https://code.claude.com/docs/en/discover-plugins.md)

* How marketplaces work
* Official Anthropic marketplace
  * Code intelligence
    * What Claude gains from code intelligence plugins
  * External integrations
  * Development workflows
  * Output styles
* Try it: add the demo marketplace
* Add marketplaces
  * Add from GitHub
  * Add from other Git hosts
  * Add from local paths
  * Add from remote URLs
* Install plugins
* Manage installed plugins
  * Apply plugin changes without restarting
* Manage marketplaces
  * Use the interactive interface
  * Use CLI commands
  * Configure auto-updates
* Configure team marketplaces
* Security
* Troubleshooting
  * /plugin command not recognized
  * Common issues
  * Code intelligence issues
* Next steps

### [plugins](https://code.claude.com/docs/en/plugins.md)

* What are plugins?
* Loading plugins
  * Path specifications
* Verifying plugin installation
* Using plugin skills
* Complete example
* Plugin structure reference
* Common use cases
  * Development and testing
  * Project-specific extensions
  * Multiple plugin sources
* Troubleshooting
  * Plugin not loading
  * Skills not appearing
  * Path resolution issues
* See also

### [skills](https://code.claude.com/docs/en/skills.md)

* Overview
* How Skills Work with the SDK
* Using Skills with the SDK
* Skill Locations
* Creating Skills
* Tool Restrictions
* Discovering Available Skills
* Testing Skills
* Troubleshooting
  * Skills Not Found
  * Skill Not Being Used
  * Additional Troubleshooting
* Related Documentation
  * Skills Guides
  * SDK Resources

## Automation

### [hooks-guide](https://code.claude.com/docs/en/hooks-guide.md)

* Set up your first hook
* What you can automate
  * Get notified when Claude needs input
  * Auto-format code after edits
  * Block edits to protected files
  * Re-inject context after compaction
  * Audit configuration changes
  * Reload environment when directory or files change
  * Auto-approve specific permission prompts
* How hooks work
  * Read input and return output
    * Hook input
    * Hook output
    * Structured JSON output
  * Filter hooks with matchers
    * Filter by tool name and arguments with the `if` field
  * Configure hook location
* Prompt-based hooks
* Agent-based hooks
* HTTP hooks
* Limitations and troubleshooting
  * Limitations
  * Hooks and permission modes
  * Hook not firing
  * Hook error in output
  * `/hooks` shows no hooks configured
  * Stop hook runs forever
  * JSON validation failed
  * Debug techniques
* Learn more

### [channels](https://code.claude.com/docs/en/channels.md)

* Supported channels
* Quickstart
* Security
* Enterprise controls
  * Enable channels for your organization
  * Restrict which channel plugins can run
* Research preview
* How channels compare
* Next steps

### [scheduled-tasks](https://code.claude.com/docs/en/scheduled-tasks.md)

* Compare scheduling options
* Run a prompt repeatedly with /loop
  * Run on a fixed interval
  * Let Claude choose the interval
  * Run the built-in maintenance prompt
  * Customize the default prompt with loop.md
* Set a one-time reminder
* Manage scheduled tasks
* How scheduled tasks run
  * Jitter
  * Seven-day expiry
* Cron expression reference
* Disable scheduled tasks
* Limitations

### [headless](https://code.claude.com/docs/en/headless.md)

* Basic usage
  * Start faster with bare mode
* Examples
  * Get structured output
  * Stream responses
  * Auto-approve tools
  * Create a commit
  * Customize the system prompt
  * Continue conversations
* Next steps

## Troubleshooting

### [troubleshooting](https://code.claude.com/docs/en/troubleshooting.md)

* Troubleshoot installation issues
* Debug installation problems
  * Check network connectivity
  * Verify your PATH
  * Check for conflicting installations
  * Check directory permissions
  * Verify the binary works
* Common installation issues
  * Install script returns HTML instead of a shell script
  * `command not found: claude` after installation
  * `curl: (56) Failure writing output to destination`
  * TLS or SSL connection errors
  * `Failed to fetch version from storage.googleapis.com`
  * Windows: wrong install command
  * Install killed on low-memory Linux servers
  * Install hangs in Docker
  * Windows: Claude Desktop overrides `claude` CLI command
  * Windows: "Claude Code on Windows requires git-bash"
  * Windows: "Claude Code does not support 32-bit Windows"
  * Linux: wrong binary variant installed (musl/glibc mismatch)
  * `Illegal instruction` on Linux
  * `dyld: cannot load` on macOS
  * Windows installation issues: errors in WSL
  * WSL2 sandbox setup
  * Permission errors during installation
* Permissions and authentication
  * Repeated permission prompts
  * Authentication issues
  * OAuth error: Invalid code
  * 403 Forbidden after login
  * Model not found or not accessible
  * "This organization has been disabled" with an active subscription
  * OAuth login fails in WSL2
  * "Not logged in" or token expired
* Configuration file locations
  * Resetting configuration
* Performance and stability
  * High CPU or memory usage
  * Auto-compaction stops with a thrashing error
  * Command hangs or freezes
  * Search and discovery issues
  * Slow or incomplete search results on WSL
* IDE integration issues
  * JetBrains IDE not detected on WSL2
    * WSL2 networking modes
  * Report Windows IDE integration issues
  * Escape key not working in JetBrains IDE terminals
* Markdown formatting issues
  * Missing language tags in code blocks
  * Inconsistent spacing and formatting
  * Reduce markdown formatting issues
* Get more help

## Deployment

### [third-party-integrations](https://code.claude.com/docs/en/third-party-integrations.md)

* Compare deployment options
* Configure proxies and gateways
  * Amazon Bedrock
  * Microsoft Foundry
  * Google Vertex AI
* Best practices for organizations
  * Invest in documentation and memory
  * Simplify deployment
  * Start with guided usage
  * Pin model versions for cloud providers
  * Configure security policies
  * Leverage MCP for integrations
* Next steps

### [amazon-bedrock](https://code.claude.com/docs/en/amazon-bedrock.md)

* Prerequisites
* Sign in with Bedrock
* Set up manually
  * 1. Submit use case details
  * 2. Configure AWS credentials
    * Advanced credential configuration
      * Example configuration
      * Configuration settings explained
  * 3. Configure Claude Code
  * 4. Pin model versions
    * Map each model version to an inference profile
* Startup model checks
* IAM configuration
* 1M token context window
* AWS Guardrails
* Use the Mantle endpoint
  * Enable Mantle
  * Select a Mantle model
  * Run Mantle alongside the Invoke API
  * Route Mantle through a gateway
  * Mantle environment variables
* Troubleshooting
  * Authentication loop with SSO and corporate proxies
  * Region issues
  * Mantle endpoint errors
* Additional resources

### [google-vertex-ai](https://code.claude.com/docs/en/google-vertex-ai.md)

* Prerequisites
* Sign in with Vertex AI
* Region configuration
* Set up manually
  * 1. Enable Vertex AI API
  * 2. Request model access
  * 3. Configure GCP credentials
  * 4. Configure Claude Code
  * 5. Pin model versions
* Startup model checks
* IAM configuration
* 1M token context window
* Troubleshooting
* Additional resources

### [microsoft-foundry](https://code.claude.com/docs/en/microsoft-foundry.md)

* Prerequisites
* Setup
  * 1. Provision Microsoft Foundry resource
  * 2. Configure Azure credentials
  * 3. Configure Claude Code
  * 4. Pin model versions
* Azure RBAC configuration
* Troubleshooting
* Additional resources

### [network-config](https://code.claude.com/docs/en/network-config.md)

* Proxy configuration
  * Environment variables
  * Basic authentication
* CA certificate store
* Custom CA certificates
* mTLS authentication
* Network access requirements
* Additional resources

### [llm-gateway](https://code.claude.com/docs/en/llm-gateway.md)

* Gateway requirements
* Configuration
  * Model selection
* LiteLLM configuration
  * Prerequisites
  * Basic LiteLLM setup
    * Authentication methods
      * Static API key
      * Dynamic API key with helper
    * Unified endpoint (recommended)
    * Provider-specific pass-through endpoints (alternative)
      * Claude API through LiteLLM
      * Amazon Bedrock through LiteLLM
      * Google Vertex AI through LiteLLM
* Additional resources

### [devcontainer](https://code.claude.com/docs/en/devcontainer.md)

* Key features
* Getting started in 4 steps
* Configuration breakdown
* Security features
* Customization options
* Example use cases
  * Secure client work
  * Team onboarding
  * Consistent CI/CD environments
* Related resources

## Administration

### [setup](https://code.claude.com/docs/en/setup.md)

* System requirements
  * Additional dependencies
* Install Claude Code
  * Set up on Windows
  * Alpine Linux and musl-based distributions
* Verify your installation
* Authenticate
* Update Claude Code
  * Auto-updates
  * Configure release channel
  * Disable auto-updates
  * Update manually
* Advanced installation options
  * Install a specific version
  * Deprecated npm installation
    * Migrate from npm to native
    * Install with npm
  * Binary integrity and code signing
    * Verify the manifest signature
    * Platform code signatures
* Uninstall Claude Code
  * Native installation
  * Homebrew installation
  * WinGet installation
  * npm
  * Remove configuration files

### [authentication](https://code.claude.com/docs/en/authentication.md)

* Log in to Claude Code
* Set up team authentication
  * Claude for Teams or Enterprise
  * Claude Console authentication
  * Cloud provider authentication
* Credential management
  * Authentication precedence
  * Generate a long-lived token

### [security](https://code.claude.com/docs/en/security.md)

* How we approach security
  * Security foundation
  * Permission-based architecture
  * Built-in protections
  * User responsibility
* Protect against prompt injection
  * Core protections
  * Privacy safeguards
  * Additional safeguards
* MCP security
* IDE security
* Cloud execution security
* Security best practices
  * Working with sensitive code
  * Team security
  * Reporting security issues
* Related resources

### [server-managed-settings](https://code.claude.com/docs/en/server-managed-settings.md)

* Requirements
* Choose between server-managed and endpoint-managed settings
* Configure server-managed settings
  * Verify settings delivery
  * Access control
  * Managed-only settings
  * Current limitations
* Settings delivery
  * Settings precedence
  * Fetch and caching behavior
  * Enforce fail-closed startup
  * Security approval dialogs
* Platform availability
* Audit logging
* Security considerations
* See also

### [data-usage](https://code.claude.com/docs/en/data-usage.md)

* Data policies
  * Data training policy
  * Development Partner Program
  * Feedback using the `/feedback` command
  * Session quality surveys
  * Data retention
* Data access
* Local Claude Code: Data flow and dependencies
  * Cloud execution: Data flow and dependencies
* Telemetry services
* Default behaviors by API provider

### [zero-data-retention](https://code.claude.com/docs/en/zero-data-retention.md)

* ZDR scope
  * What ZDR covers
  * What ZDR does not cover
* Features disabled under ZDR
* Data retention for policy violations
* Request ZDR

### [monitoring-usage](https://code.claude.com/docs/en/monitoring-usage.md)

* Quick start
* Administrator configuration
* Configuration details
  * Common configuration variables
  * Metrics cardinality control
  * Traces (beta)
  * Dynamic headers
    * Settings configuration
    * Script requirements
    * Refresh behavior
  * Multi-team organization support
  * Example configurations
* Available metrics and events
  * Standard attributes
  * Metrics
  * Metric details
    * Session counter
    * Lines of code counter
    * Pull request counter
    * Commit counter
    * Cost counter
    * Token counter
    * Code edit tool decision counter
    * Active time counter
  * Events
    * Event correlation attributes
    * User prompt event
    * Tool result event
    * API request event
    * API error event
    * Tool decision event
* Interpret metrics and events data
  * Usage monitoring
  * Cost monitoring
  * Alerting and segmentation
  * Detect retry exhaustion
  * Event analysis
* Backend considerations
  * For metrics
  * For events/logs
  * For traces
* Service information
* ROI measurement resources
* Security and privacy
* Monitor Claude Code on Amazon Bedrock

### [costs](https://code.claude.com/docs/en/costs.md)

* Track your costs
  * Using the `/cost` command
* Managing costs for teams
  * Rate limit recommendations
  * Agent team token costs
* Reduce token usage
  * Manage context proactively
  * Choose the right model
  * Reduce MCP server overhead
  * Install code intelligence plugins for typed languages
  * Offload processing to hooks and skills
  * Move instructions from CLAUDE.md to skills
  * Adjust extended thinking
  * Delegate verbose operations to subagents
  * Manage agent team costs
  * Write specific prompts
  * Work efficiently on complex tasks
* Background token usage
* Understanding changes in Claude Code behavior

### [analytics](https://code.claude.com/docs/en/analytics.md)

* Access analytics for Team and Enterprise
  * Enable contribution metrics
  * Review summary metrics
  * Explore the charts
    * Track adoption
    * Measure PRs per user
    * View pull requests breakdown
    * Find top contributors
  * PR attribution
    * Tagging criteria
    * Attribution process
    * Time window
    * Excluded files
    * Attribution notes
  * Get the most from analytics
    * Monitor adoption
    * Measure ROI
    * Identify power users
    * Access data programmatically
* Access analytics for API customers
  * View team insights
* Related resources

### [plugin-marketplaces](https://code.claude.com/docs/en/plugin-marketplaces.md)

* Overview
* Walkthrough: create a local marketplace
* Create the marketplace file
* Marketplace schema
  * Required fields
  * Owner fields
  * Optional metadata
* Plugin entries
  * Required fields
  * Optional plugin fields
* Plugin sources
  * Relative paths
  * GitHub repositories
  * Git repositories
  * Git subdirectories
  * npm packages
  * Advanced plugin entries
  * Strict mode
* Host and distribute marketplaces
  * Host on GitHub (recommended)
  * Host on other git services
  * Private repositories
  * Test locally before distribution
  * Require marketplaces for your team
  * Pre-populate plugins for containers
  * Managed marketplace restrictions
    * Common configurations
    * How restrictions work
  * Version resolution and release channels
    * Set up release channels
      * Example
      * Assign channels to user groups
* Validation and testing
* Manage marketplaces from the CLI
  * Plugin marketplace add
  * Plugin marketplace list
  * Plugin marketplace remove
  * Plugin marketplace update
* Troubleshooting
  * Marketplace not loading
  * Marketplace validation errors
  * Plugin installation failures
  * Private repository authentication fails
  * Marketplace updates fail in offline environments
  * Git operations time out
  * Plugins with relative paths fail in URL-based marketplaces
  * Files not found after installation
* See also

## Configuration

### [settings](https://code.claude.com/docs/en/settings.md)

* Configuration scopes
  * Available scopes
  * When to use each scope
  * How scopes interact
  * What uses scopes
* Settings files
  * Available settings
  * Global config settings
  * Worktree settings
  * Permission settings
  * Permission rule syntax
  * Sandbox settings
    * Sandbox path prefixes
  * Attribution settings
  * File suggestion settings
  * Hook configuration
  * Settings precedence
  * Verify active settings
  * Key points about the configuration system
  * System prompt
  * Excluding sensitive files
* Subagent configuration
* Plugin configuration
  * Plugin settings
    * `enabledPlugins`
    * `extraKnownMarketplaces`
    * `strictKnownMarketplaces`
  * Managing plugins
* Environment variables
* Tools available to Claude
* See also

### [permissions](https://code.claude.com/docs/en/permissions.md)

* How permissions are evaluated
* Allow and deny rules
* Permission modes
  * Available modes
  * Set permission mode
  * Mode details
    * Accept edits mode (`acceptEdits`)
    * Don't ask mode (`dontAsk`)
    * Bypass permissions mode (`bypassPermissions`)
    * Plan mode (`plan`)
* Related resources

### [sandboxing](https://code.claude.com/docs/en/sandboxing.md)

* Overview
* Why sandboxing matters
* How it works
  * Filesystem isolation
  * Network isolation
  * OS-level enforcement
* Getting started
  * Prerequisites
  * Enable sandboxing
  * Sandbox modes
  * Configure sandboxing
    * Granting subprocess write access to specific paths
* Security benefits
  * Protection against prompt injection
  * Reduced attack surface
  * Transparent operation
* Security Limitations
* How sandboxing relates to permissions
* Advanced usage
  * Custom proxy configuration
  * Integration with existing security tools
* Best practices
* Open source
* Limitations
* What sandboxing does not cover
* See also

### [terminal-config](https://code.claude.com/docs/en/terminal-config.md)

* Themes and appearance
* Line breaks
  * Set up Shift+Enter with /terminal-setup
  * Set up Shift+Enter in tmux
  * Set up Option+Enter on macOS
* Notification setup
  * Terminal notifications
  * Notification hooks
* Reduce flicker and memory usage
* Handling large inputs
* Vim Mode

### [fullscreen](https://code.claude.com/docs/en/fullscreen.md)

* Enable fullscreen rendering
* What changes
* Use the mouse
* Scroll the conversation
  * Adjust wheel scroll speed
* Search and review the conversation
* Use with tmux
* Keep native text selection
* Research preview

### [model-config](https://code.claude.com/docs/en/model-config.md)

* Available models
  * Model aliases
  * Setting your model
* Restrict model selection
  * Default model behavior
  * Control the model users run on
  * Merge behavior
  * Mantle model IDs
* Special model behavior
  * `default` model setting
  * `opusplan` model setting
  * Adjust effort level
  * Extended context
* Checking your current model
* Add a custom model option
* Environment variables
  * Pin models for third-party deployments
  * Customize pinned model display and capabilities
  * Override model IDs per version
  * Prompt caching configuration

### [fast-mode](https://code.claude.com/docs/en/fast-mode.md)

* Toggle fast mode
* Understand the cost tradeoff
* Decide when to use fast mode
  * Fast mode vs effort level
* Requirements
  * Enable fast mode for your organization
  * Require per-session opt-in
* Handle rate limits
* Research preview
* See also

### [voice-dictation](https://code.claude.com/docs/en/voice-dictation.md)

* Requirements
* Enable voice dictation
* Record a prompt
* Change the dictation language
* Rebind the push-to-talk key
* Troubleshooting
  * Terminal not listed in macOS Microphone settings
* See also

### [output-styles](https://code.claude.com/docs/en/output-styles.md)

* Built-in output styles
* How output styles work
* Change your output style
* Create a custom output style
  * Frontmatter
* Comparisons to related features
  * Output Styles vs. CLAUDE.md vs. --append-system-prompt
  * Output Styles vs. [Agents](/en/sub-agents)
  * Output Styles vs. [Skills](/en/skills)

### [statusline](https://code.claude.com/docs/en/statusline.md)

* Set up a status line
  * Use the /statusline command
  * Manually configure a status line
  * Disable the status line
* Build a status line step by step
* How status lines work
* Available data
  * Context window fields
* Examples
  * Context window usage
  * Git status with colors
  * Cost and duration tracking
  * Display multiple lines
  * Clickable links
  * Rate limit usage
  * Cache expensive operations
  * Windows configuration
* Tips
* Troubleshooting

### [keybindings](https://code.claude.com/docs/en/keybindings.md)

* Configuration file
* Contexts
* Available actions
  * App actions
  * History actions
  * Chat actions
  * Autocomplete actions
  * Confirmation actions
  * Permission actions
  * Transcript actions
  * History search actions
  * Task actions
  * Theme actions
  * Help actions
  * Tabs actions
  * Attachments actions
  * Footer actions
  * Message selector actions
  * Diff actions
  * Model picker actions
  * Select actions
  * Plugin actions
  * Settings actions
  * Voice actions
  * Scroll actions
* Keystroke syntax
  * Modifiers
  * Uppercase letters
  * Chords
  * Special keys
* Unbind default shortcuts
* Reserved shortcuts
* Terminal conflicts
* Vim mode interaction
* Validation

## Reference

### [cli-reference](https://code.claude.com/docs/en/cli-reference.md)

* CLI commands
* CLI flags
  * System prompt flags
* See also

### [commands](https://code.claude.com/docs/en/commands.md)

* MCP prompts
* See also

### [env-vars](https://code.claude.com/docs/en/env-vars.md)

* See also

### [tools-reference](https://code.claude.com/docs/en/tools-reference.md)

* Bash tool behavior
* LSP tool behavior
* Monitor tool
* PowerShell tool
  * Enable the PowerShell tool
  * Shell selection in settings, hooks, and skills
  * Preview limitations
* Check which tools are available
* See also

### [interactive-mode](https://code.claude.com/docs/en/interactive-mode.md)

* Keyboard shortcuts
  * General controls
  * Text editing
  * Theme and display
  * Multiline input
  * Quick commands
  * Transcript viewer
  * Voice input
* Commands
* Vim editor mode
  * Mode switching
  * Navigation (NORMAL mode)
  * Editing (NORMAL mode)
  * Text objects (NORMAL mode)
* Command history
  * Reverse search with Ctrl+R
* Background bash commands
  * How backgrounding works
  * Bash mode with `!` prefix
* Prompt suggestions
* Side questions with /btw
* Task list
* PR review status
* See also

### [checkpointing](https://code.claude.com/docs/en/checkpointing.md)

* How checkpoints work
  * Automatic tracking
  * Rewind and summarize
    * Restore vs. summarize
* Common use cases
* Limitations
  * Bash command changes not tracked
  * External changes not tracked
  * Not a replacement for version control
* See also

### [hooks](https://code.claude.com/docs/en/hooks.md)

* How hooks work
* Available hooks
* Configure hooks
  * Matchers
  * Callback functions
    * Inputs
    * Outputs
    * Asynchronous output
* Examples
  * Modify tool input
  * Add context and block a tool
  * Auto-approve specific tools
  * Chain multiple hooks
  * Filter with regex matchers
  * Track subagent activity
  * Make HTTP requests from hooks
  * Forward notifications to Slack
* Fix common issues
  * Hook not firing
  * Matcher not filtering as expected
  * Hook timeout
  * Tool blocked unexpectedly
  * Modified input not applied
  * Session hooks not available in Python
  * Subagent permission prompts multiplying
  * Recursive hook loops with subagents
  * systemMessage not appearing in output
* Related resources

### [plugins-reference](https://code.claude.com/docs/en/plugins-reference.md)

* Plugin components reference
  * Skills
  * Agents
  * Hooks
  * MCP servers
  * LSP servers
* Plugin installation scopes
* Plugin manifest schema
  * Complete schema
  * Required fields
  * Metadata fields
  * Component path fields
  * User configuration
  * Channels
  * Path behavior rules
  * Environment variables
    * Persistent data directory
* Plugin caching and file resolution
  * Path traversal limitations
  * Working with external dependencies
* Plugin directory structure
  * Standard plugin layout
  * File locations reference
* CLI commands reference
  * plugin install
  * plugin uninstall
  * plugin enable
  * plugin disable
  * plugin update
* Debugging and development tools
  * Debugging commands
  * Common issues
  * Example error messages
  * Hook troubleshooting
  * MCP server troubleshooting
  * Directory structure mistakes
* Distribution and versioning reference
  * Version management
* See also

### [channels-reference](https://code.claude.com/docs/en/channels-reference.md)

* Overview
* What you need
* Example: build a webhook receiver
* Test during the research preview
* Server options
* Notification format
* Expose a reply tool
* Gate inbound messages
* Relay permission prompts
  * How relay works
  * Permission request fields
  * Add relay to a chat bridge
  * Full example
* Package as a plugin
* See also

## Agent SDK

### [overview](https://code.claude.com/docs/en/overview.md)

* Get started
* Capabilities
  * Claude Code features
* Compare the Agent SDK to other Claude tools
* Changelog
* Reporting bugs
* Branding guidelines
* License and terms
* Next steps

### [quickstart](https://code.claude.com/docs/en/quickstart.md)

* Prerequisites
* Setup
* Create a buggy file
* Build an agent that finds and fixes bugs
  * Run your agent
  * Try other prompts
  * Customize your agent
* Key concepts
* Next steps

## Core concepts

### [agent-loop](https://code.claude.com/docs/en/agent-loop.md)

* The loop at a glance
* Turns and messages
* Message types
  * Handle messages
* Tool execution
  * Built-in tools
  * Tool permissions
  * Parallel tool execution
* Control how the loop runs
  * Turns and budget
  * Effort level
  * Permission mode
  * Model
* The context window
  * What consumes context
  * Automatic compaction
  * Keep context efficient
* Sessions and continuity
* Handle the result
* Hooks
* Put it all together
* Next steps

### [claude-code-features](https://code.claude.com/docs/en/claude-code-features.md)

* Enable Claude Code features with settingSources
* Project instructions (CLAUDE.md and rules)
  * CLAUDE.md load locations
* Skills
* Hooks
  * When to use which hook type
* Choose the right feature
* Related resources

### [sessions](https://code.claude.com/docs/en/sessions.md)

* Choose an approach
  * Continue, resume, and fork
* Automatic session management
  * Python: `ClaudeSDKClient`
  * TypeScript: `continue: true`
* Use session options with `query()`
  * Capture the session ID
  * Resume by ID
  * Fork to explore alternatives
* Resume across hosts
* Related resources

## Input and output

### [streaming-vs-single-mode](https://code.claude.com/docs/en/streaming-vs-single-mode.md)

* Overview
* Streaming Input Mode (Recommended)
  * How It Works
  * Benefits
  * Implementation Example
* Single Message Input
  * When to Use Single Message Input
  * Limitations
  * Implementation Example

### [user-input](https://code.claude.com/docs/en/user-input.md)

* Detect when Claude needs input
* Handle tool approval requests
  * Respond to tool requests
* Handle clarifying questions
  * Question format
    * Option previews (TypeScript)
  * Response format
    * Support free-text input
  * Complete example
* Limitations
* Other ways to get user input
  * Streaming input
  * Custom tools
* Related resources

### [streaming-output](https://code.claude.com/docs/en/streaming-output.md)

* Enable streaming output
* StreamEvent reference
* Message flow
* Stream text responses
* Stream tool calls
* Build a streaming UI
* Known limitations
* Next steps

### [structured-outputs](https://code.claude.com/docs/en/structured-outputs.md)

* Why structured outputs?
* Quick start
* Type-safe schemas with Zod and Pydantic
* Output format configuration
* Example: TODO tracking agent
* Error handling
* Related resources

## Extend with tools

### [custom-tools](https://code.claude.com/docs/en/custom-tools.md)

* Quick reference
* Create a custom tool
  * Weather tool example
  * Call a custom tool
  * Add more tools
  * Add tool annotations
* Control tool access
  * Tool name format
  * Configure allowed tools
* Handle errors
* Return images and resources
  * Images
  * Resources
* Example: unit converter
* Next steps
* Related documentation

### [mcp](https://code.claude.com/docs/en/mcp.md)

* Quickstart
* Add an MCP server
  * In code
  * From a config file
* Allow MCP tools
  * Tool naming convention
  * Grant access with allowedTools
  * Discover available tools
* Transport types
  * stdio servers
  * HTTP/SSE servers
  * SDK MCP servers
* MCP tool search
* Authentication
  * Pass credentials via environment variables
  * HTTP headers for remote servers
  * OAuth2 authentication
* Examples
  * List issues from a repository
  * Query a database
* Error handling
* Troubleshooting
  * Server shows "failed" status
  * Tools not being called
  * Connection timeouts
* Related resources

### [tool-search](https://code.claude.com/docs/en/tool-search.md)

* How tool search works
* Configure tool search
* Optimize tool discovery
* Limits
* Related documentation

### [subagents](https://code.claude.com/docs/en/subagents.md)

* Overview
* Benefits of using subagents
  * Context isolation
  * Parallelization
  * Specialized instructions and knowledge
  * Tool restrictions
* Creating subagents
  * Programmatic definition (recommended)
  * AgentDefinition configuration
  * Filesystem-based definition (alternative)
* What subagents inherit
* Invoking subagents
  * Automatic invocation
  * Explicit invocation
  * Dynamic agent configuration
* Detecting subagent invocation
* Resuming subagents
* Tool restrictions
  * Common tool combinations
* Troubleshooting
  * Claude not delegating to subagents
  * Filesystem-based agents not loading
  * Windows: long prompt failures
* Related documentation

## Customize behavior

### [modifying-system-prompts](https://code.claude.com/docs/en/modifying-system-prompts.md)

* Understanding system prompts
* Methods of modification
  * Method 1: CLAUDE.md files (project-level instructions)
    * How CLAUDE.md works with the SDK
    * Example CLAUDE.md
    * Using CLAUDE.md with the SDK
    * When to use CLAUDE.md
  * Method 2: Output styles (persistent configurations)
    * Creating an output style
    * Using output styles
  * Method 3: Using `systemPrompt` with append
  * Method 4: Custom system prompts
* Comparison of all four approaches
* Use cases and best practices
  * When to use CLAUDE.md
  * When to use output styles
  * When to use `systemPrompt` with append
  * When to use custom `systemPrompt`
* Combining approaches
  * Example: Output style with session-specific additions
* See also

### [slash-commands](https://code.claude.com/docs/en/slash-commands.md)

* Discovering Available Slash Commands
* Sending Slash Commands
* Common Slash Commands
  * `/compact` - Compact Conversation History
  * `/clear` - Clear Conversation
* Creating Custom Slash Commands
  * File Locations
  * File Format
    * Basic Example
    * With Frontmatter
  * Using Custom Commands in the SDK
  * Advanced Features
    * Arguments and Placeholders
    * Bash Command Execution
    * File References
  * Organization with Namespacing
  * Practical Examples
    * Code Review Command
    * Test Runner Command
* See Also

### [skills](https://code.claude.com/docs/en/skills.md)

* Overview
* How Skills Work with the SDK
* Using Skills with the SDK
* Skill Locations
* Creating Skills
* Tool Restrictions
* Discovering Available Skills
* Testing Skills
* Troubleshooting
  * Skills Not Found
  * Skill Not Being Used
  * Additional Troubleshooting
* Related Documentation
  * Skills Guides
  * SDK Resources

### [plugins](https://code.claude.com/docs/en/plugins.md)

* What are plugins?
* Loading plugins
  * Path specifications
* Verifying plugin installation
* Using plugin skills
* Complete example
* Plugin structure reference
* Common use cases
  * Development and testing
  * Project-specific extensions
  * Multiple plugin sources
* Troubleshooting
  * Plugin not loading
  * Skills not appearing
  * Path resolution issues
* See also

## Control and observability

### [permissions](https://code.claude.com/docs/en/permissions.md)

* How permissions are evaluated
* Allow and deny rules
* Permission modes
  * Available modes
  * Set permission mode
  * Mode details
    * Accept edits mode (`acceptEdits`)
    * Don't ask mode (`dontAsk`)
    * Bypass permissions mode (`bypassPermissions`)
    * Plan mode (`plan`)
* Related resources

### [hooks](https://code.claude.com/docs/en/hooks.md)

* How hooks work
* Available hooks
* Configure hooks
  * Matchers
  * Callback functions
    * Inputs
    * Outputs
    * Asynchronous output
* Examples
  * Modify tool input
  * Add context and block a tool
  * Auto-approve specific tools
  * Chain multiple hooks
  * Filter with regex matchers
  * Track subagent activity
  * Make HTTP requests from hooks
  * Forward notifications to Slack
* Fix common issues
  * Hook not firing
  * Matcher not filtering as expected
  * Hook timeout
  * Tool blocked unexpectedly
  * Modified input not applied
  * Session hooks not available in Python
  * Subagent permission prompts multiplying
  * Recursive hook loops with subagents
  * systemMessage not appearing in output
* Related resources

### [file-checkpointing](https://code.claude.com/docs/en/file-checkpointing.md)

* How checkpointing works
* Implement checkpointing
* Common patterns
  * Checkpoint before risky operations
  * Multiple restore points
* Try it out
* Limitations
* Troubleshooting
  * Checkpointing options not recognized
  * User messages don't have UUIDs
  * "No file checkpoint found for message" error
  * "ProcessTransport is not ready for writing" error
* Next steps

### [cost-tracking](https://code.claude.com/docs/en/cost-tracking.md)

* Understand token usage
* Get the total cost of a query
* Track per-step and per-model usage
  * Track per-step usage
  * Break down usage per model
* Accumulate costs across multiple calls
* Handle errors, caching, and token discrepancies
  * Resolve output token discrepancies
  * Track costs on failed conversations
  * Track cache tokens
* Related documentation

### [observability](https://code.claude.com/docs/en/observability.md)

* How telemetry flows from the SDK
* Enable telemetry export
  * Flush telemetry from short-lived calls
* Read agent traces
* Tag telemetry from your agent
* Control sensitive data in exports
* Related documentation

### [todo-tracking](https://code.claude.com/docs/en/todo-tracking.md)

* Todo Lifecycle
* When Todos Are Used
* Examples
  * Monitoring Todo Changes
  * Real-time Progress Display
* Related Documentation

## Deployment

### [hosting](https://code.claude.com/docs/en/hosting.md)

* Hosting Requirements
  * Container-Based Sandboxing
  * System Requirements
* Understanding the SDK Architecture
* Sandbox Provider Options
* Production Deployment Patterns
  * Pattern 1: Ephemeral Sessions
  * Pattern 2: Long-Running Sessions
  * Pattern 3: Hybrid Sessions
  * Pattern 4: Single Containers
* FAQ
  * How do I communicate with my sandboxes?
  * What is the cost of hosting a container?
  * When should I shut down idle containers vs. keeping them warm?
  * How often should I update the Claude Code CLI?
  * How do I monitor container health and agent performance?
  * How long can an agent session run before timing out?
* Next Steps

### [secure-deployment](https://code.claude.com/docs/en/secure-deployment.md)

* Threat model
* Built-in security features
* Security principles
  * Security boundaries
  * Least privilege
  * Defense in depth
* Isolation technologies
  * Sandbox runtime
  * Containers
  * gVisor
  * Virtual machines
  * Cloud deployments
* Credential management
  * The proxy pattern
  * Configuring Claude Code to use a proxy
  * Implementing a proxy
  * Credentials for other services
    * Custom tools
    * Traffic forwarding
* Filesystem configuration
  * Read-only code mounting
  * Writable locations
* Further reading

## SDK references

### [typescript](https://code.claude.com/docs/en/typescript.md)

* Installation
* Functions
  * `query()`
    * Parameters
    * Returns
  * `tool()`
    * Parameters
    * `ToolAnnotations`
  * `createSdkMcpServer()`
    * Parameters
  * `listSessions()`
    * Parameters
    * Return type: `SDKSessionInfo`
    * Example
  * `getSessionMessages()`
    * Parameters
    * Return type: `SessionMessage`
    * Example
  * `getSessionInfo()`
    * Parameters
  * `renameSession()`
    * Parameters
  * `tagSession()`
    * Parameters
* Types
  * `Options`
  * `Query` object
    * Methods
  * `SDKControlInitializeResponse`
  * `AgentDefinition`
  * `AgentMcpServerSpec`
  * `SettingSource`
    * Default behavior
    * Why use settingSources
    * Settings precedence
  * `PermissionMode`
  * `CanUseTool`
  * `PermissionResult`
  * `ToolConfig`
  * `McpServerConfig`
    * `McpStdioServerConfig`
    * `McpSSEServerConfig`
    * `McpHttpServerConfig`
    * `McpSdkServerConfigWithInstance`
    * `McpClaudeAIProxyServerConfig`
  * `SdkPluginConfig`
* Message Types
  * `SDKMessage`
  * `SDKAssistantMessage`
  * `SDKUserMessage`
  * `SDKUserMessageReplay`
  * `SDKResultMessage`
  * `SDKSystemMessage`
  * `SDKPartialAssistantMessage`
  * `SDKCompactBoundaryMessage`
  * `SDKPermissionDenial`
* Hook Types
  * `HookEvent`
  * `HookCallback`
  * `HookCallbackMatcher`
  * `HookInput`
  * `BaseHookInput`
    * `PreToolUseHookInput`
    * `PostToolUseHookInput`
    * `PostToolUseFailureHookInput`
    * `NotificationHookInput`
    * `UserPromptSubmitHookInput`
    * `SessionStartHookInput`
    * `SessionEndHookInput`
    * `StopHookInput`
    * `SubagentStartHookInput`
    * `SubagentStopHookInput`
    * `PreCompactHookInput`
    * `PermissionRequestHookInput`
    * `SetupHookInput`
    * `TeammateIdleHookInput`
    * `TaskCompletedHookInput`
    * `ConfigChangeHookInput`
    * `WorktreeCreateHookInput`
    * `WorktreeRemoveHookInput`
  * `HookJSONOutput`
    * `AsyncHookJSONOutput`
    * `SyncHookJSONOutput`
* Tool Input Types
  * `ToolInputSchemas`
  * Agent
  * AskUserQuestion
  * Bash
  * Monitor
  * TaskOutput
  * Edit
  * Read
  * Write
  * Glob
  * Grep
  * TaskStop
  * NotebookEdit
  * WebFetch
  * WebSearch
  * TodoWrite
  * ExitPlanMode
  * ListMcpResources
  * ReadMcpResource
  * Config
  * EnterWorktree
* Tool Output Types
  * `ToolOutputSchemas`
  * Agent
  * AskUserQuestion
  * Bash
  * Monitor
  * Edit
  * Read
  * Write
  * Glob
  * Grep
  * TaskStop
  * NotebookEdit
  * WebFetch
  * WebSearch
  * TodoWrite
  * ExitPlanMode
  * ListMcpResources
  * ReadMcpResource
  * Config
  * EnterWorktree
* Permission Types
  * `PermissionUpdate`
  * `PermissionBehavior`
  * `PermissionUpdateDestination`
  * `PermissionRuleValue`
* Other Types
  * `ApiKeySource`
  * `SdkBeta`
  * `SlashCommand`
  * `ModelInfo`
  * `AgentInfo`
  * `McpServerStatus`
  * `McpServerStatusConfig`
  * `AccountInfo`
  * `ModelUsage`
  * `ConfigScope`
  * `NonNullableUsage`
  * `Usage`
  * `CallToolResult`
  * `ThinkingConfig`
  * `SpawnedProcess`
  * `SpawnOptions`
  * `McpSetServersResult`
  * `RewindFilesResult`
  * `SDKStatusMessage`
  * `SDKTaskNotificationMessage`
  * `SDKToolUseSummaryMessage`
  * `SDKHookStartedMessage`
  * `SDKHookProgressMessage`
  * `SDKHookResponseMessage`
  * `SDKToolProgressMessage`
  * `SDKAuthStatusMessage`
  * `SDKTaskStartedMessage`
  * `SDKTaskProgressMessage`
  * `SDKFilesPersistedEvent`
  * `SDKRateLimitEvent`
  * `SDKLocalCommandOutputMessage`
  * `SDKPromptSuggestionMessage`
  * `AbortError`
* Sandbox Configuration
  * `SandboxSettings`
    * Example usage
  * `SandboxNetworkConfig`
  * `SandboxFilesystemConfig`
  * Permissions Fallback for Unsandboxed Commands
* See also

### [typescript-v2-preview](https://code.claude.com/docs/en/typescript-v2-preview.md)

* Installation
* Quick start
  * One-shot prompt
  * Basic session
  * Multi-turn conversation
  * Session resume
  * Cleanup
* API reference
  * `unstable_v2_createSession()`
  * `unstable_v2_resumeSession()`
  * `unstable_v2_prompt()`
  * SDKSession interface
* Feature availability
* Feedback
* See also

### [python](https://code.claude.com/docs/en/python.md)

* Installation
* Choosing between `query()` and `ClaudeSDKClient`
  * Quick comparison
  * When to use `query()` (new session each time)
  * When to use `ClaudeSDKClient` (continuous conversation)
* Functions
  * `query()`
    * Parameters
    * Returns
    * Example - With options
  * `tool()`
    * Parameters
    * Input schema options
    * Returns
    * Example
    * `ToolAnnotations`
  * `create_sdk_mcp_server()`
    * Parameters
    * Returns
    * Example
  * `list_sessions()`
    * Parameters
    * Return type: `SDKSessionInfo`
    * Example
  * `get_session_messages()`
    * Parameters
    * Return type: `SessionMessage`
    * Example
  * `get_session_info()`
    * Parameters
    * Example
  * `rename_session()`
    * Parameters
    * Example
  * `tag_session()`
    * Parameters
    * Example
* Classes
  * `ClaudeSDKClient`
    * Key Features
    * Methods
    * Context Manager Support
    * Example - Continuing a conversation
    * Example - Streaming input with ClaudeSDKClient
    * Example - Using interrupts
    * Example - Advanced permission control
* Types
  * `SdkMcpTool`
  * `Transport`
  * `ClaudeAgentOptions`
  * `OutputFormat`
  * `SystemPromptPreset`
  * `SettingSource`
    * Default behavior
    * Why use setting\_sources
    * Settings precedence
  * `AgentDefinition`
  * `PermissionMode`
  * `CanUseTool`
  * `ToolPermissionContext`
  * `PermissionResult`
  * `PermissionResultAllow`
  * `PermissionResultDeny`
  * `PermissionUpdate`
  * `PermissionRuleValue`
  * `ToolsPreset`
  * `ThinkingConfig`
  * `SdkBeta`
  * `McpSdkServerConfig`
  * `McpServerConfig`
    * `McpStdioServerConfig`
    * `McpSSEServerConfig`
    * `McpHttpServerConfig`
  * `McpServerStatusConfig`
  * `McpStatusResponse`
  * `McpServerStatus`
  * `SdkPluginConfig`
* Message Types
  * `Message`
  * `UserMessage`
  * `AssistantMessage`
  * `AssistantMessageError`
  * `SystemMessage`
  * `ResultMessage`
  * `StreamEvent`
  * `RateLimitEvent`
  * `RateLimitInfo`
  * `TaskStartedMessage`
  * `TaskUsage`
  * `TaskProgressMessage`
  * `TaskNotificationMessage`
* Content Block Types
  * `ContentBlock`
  * `TextBlock`
  * `ThinkingBlock`
  * `ToolUseBlock`
  * `ToolResultBlock`
* Error Types
  * `ClaudeSDKError`
  * `CLINotFoundError`
  * `CLIConnectionError`
  * `ProcessError`
  * `CLIJSONDecodeError`
* Hook Types
  * `HookEvent`
  * `HookCallback`
  * `HookContext`
  * `HookMatcher`
  * `HookInput`
  * `BaseHookInput`
  * `PreToolUseHookInput`
  * `PostToolUseHookInput`
  * `PostToolUseFailureHookInput`
  * `UserPromptSubmitHookInput`
  * `StopHookInput`
  * `SubagentStopHookInput`
  * `PreCompactHookInput`
  * `NotificationHookInput`
  * `SubagentStartHookInput`
  * `PermissionRequestHookInput`
  * `HookJSONOutput`
    * `SyncHookJSONOutput`
    * `HookSpecificOutput`
    * `AsyncHookJSONOutput`
  * Hook Usage Example
* Tool Input/Output Types
  * Agent
  * AskUserQuestion
  * Bash
  * Monitor
  * Edit
  * Read
  * Write
  * Glob
  * Grep
  * NotebookEdit
  * WebFetch
  * WebSearch
  * TodoWrite
  * BashOutput
  * KillBash
  * ExitPlanMode
  * ListMcpResources
  * ReadMcpResource
* Advanced Features with ClaudeSDKClient
  * Building a Continuous Conversation Interface
  * Using Hooks for Behavior Modification
  * Real-time Progress Monitoring
* Example Usage
  * Basic file operations (using query)
  * Error handling
  * Streaming mode with client
  * Using custom tools with ClaudeSDKClient
* Sandbox Configuration
  * `SandboxSettings`
    * Example usage
  * `SandboxNetworkConfig`
  * `SandboxIgnoreViolations`
  * Permissions Fallback for Unsandboxed Commands
* See also

### [migration-guide](https://code.claude.com/docs/en/migration-guide.md)

* Overview
* What's Changed
* Migration Steps
  * For TypeScript/JavaScript Projects
  * For Python Projects
* Breaking changes
  * Python: ClaudeCodeOptions renamed to ClaudeAgentOptions
  * System prompt no longer default
  * Settings Sources No Longer Loaded by Default
* Why the Rename?
* Getting Help
* Next Steps

## What's New

### [index](https://code.claude.com/docs/en/index.md)

* (No headings found)

### [2026-w15](https://code.claude.com/docs/en/2026-w15.md)

* (No headings found)

### [2026-w14](https://code.claude.com/docs/en/2026-w14.md)

* (No headings found)

### [2026-w13](https://code.claude.com/docs/en/2026-w13.md)

* (No headings found)

## Resources

### [legal-and-compliance](https://code.claude.com/docs/en/legal-and-compliance.md)

* Legal agreements
  * License
  * Commercial agreements
* Compliance
  * Healthcare compliance (BAA)
* Usage policy
  * Acceptable use
  * Authentication and credential use
* Security and trust
  * Trust and safety
  * Security vulnerability reporting
