Follow Discord
Sweep 31 Oct 2026 · 01:10Z Build v2.1.316 534 read Stable v2.1.309 Latest v2.1.316 Next v2.1.316 Feeds RSS JSON llms.txt llms-full.txt Unofficial
HomeDocsSearch
Search the documentation

1,595 pages for form.

Titles and paths first, then pages whose text carries it. Each row opens that page as this site last read it.

Glossary Claude Code CLI · in the page glossary …model-level concepts like tokens, temperature, and RAG, see the [platform glossary](https://platform.claude.com/docs/en/about-claude/glossary). For Claude Desktop terms such as desktop extension, MCP… Keep Claude working toward a goal Claude Code CLI · in the page goal …op ends, so a goal that runs many turns can look stuck. Add `--output-format stream-json --verbose` to emit each message as the loop runs. Interrupt the process with Ctrl+C to stop a non-interactive… Run Claude Code programmatically Claude Code CLI · in the page headless …wedTools` for [auto-approving tools](#auto-approve-tools) * `--output-format` for [structured output](#get-structured-output) This example asks Claude a question about your codebase and prints the re… Set up Claude Code (local mode) for a HIPAA-ready organization Claude Code CLI · in the page hipaa-setup …de Enterprise plans, for organizations that handle protected health information (PHI) and have a [Business Associate Agreement (BAA)](https://support.claude.com/en/articles/8114513-business-associate-… Hooks reference Claude Code CLI · in the page hooks …for Claude Code hook events, configuration schema, JSON input/output formats, exit codes, async hooks, HTTP hooks, prompt hooks, and MCP tool hooks. > [!TIP] > > For a quickstart guide with examples… Automate actions with hooks Claude Code CLI · in the page hooks-guide …tically when Claude Code edits files, finishes tasks, or needs input. Format code, send notifications, validate commands, and enforce project rules. Hooks are user-defined shell commands. Claude Code… How Claude Code works Claude Code CLI · in the page how-claude-code-works …om/claude-code/ikqp3_70mqIahteV/images/agentic-loop.svg?fit=max\&auto=format\&n=ikqp3_70mqIahteV\&q=85\&s=4a30fb7ce2815012a9f27c955e2c6bb0) The loop adapts to what you ask. A question about your code… Interactive mode Claude Code CLI · in the page interactive-mode …Keyboard shortcuts > [!NOTE] > > Keyboard shortcuts may vary by platform and terminal. In [fullscreen rendering](https://code.claude.com/docs/en/fullscreen.md), press `?` in the transcript viewer to… JetBrains IDEs Claude Code CLI · in the page jetbrains …command path in plugin settings 3. For WSL users, use the WSL command format mentioned in the configuration section ## Security considerations When Claude Code runs in a JetBrains IDE in [`acceptEdi… Customize keyboard shortcuts Claude Code CLI · in the page keybindings …cs screen. ## Available actions Actions follow a `namespace:action` format, such as `chat:submit` to send a message or `app:toggleTodos` to show the task list. Each context has specific actions avai… Set up Claude Code in a monorepo or large codebase Claude Code CLI · in the page large-codebases …reads unrelated to the task, costing tokens and degrading Claude's performance. This guide shows individual developers and engineering teams how to scope Claude to the part of the codebase a task tou… Legal and compliance Claude Code CLI · in the page legal-and-compliance …liance > Legal agreements, compliance certifications, and security information for Claude Code. ## Legal agreements ### License Your use of Claude Code is subject to: * [Commercial Terms of Servi… Other LLM gateways Claude Code CLI · in the page llm-gateway …n/llm-gateway-protocol.md) Any gateway that exposes a [supported API format](https://code.claude.com/docs/en/llm-gateway-protocol.md#api-formats) works. Anthropic doesn't endorse, maintain, or audit… Connect Claude Code to an LLM gateway Claude Code CLI · in the page llm-gateway-connect …as a custom header, a credential helper, model discovery, a provider-format base URL, or turning off traffic outside the gateway path. Set these only if your administrator named them or your network… Claude Code gateway compatibility guide Claude Code CLI · in the page llm-gateway-protocol …claude.com/docs/en/llm-gateway-connect.md) This page covers: * [API formats](#api-formats) and the endpoints to serve for each * [Client behavior by connection method](#how-the-connection-method-cha… Roll out an LLM gateway for your organization Claude Code CLI · in the page llm-gateway-rollout …r the Anthropic API: an API key from the [Claude Console](https://platform.claude.com/settings/keys) * For a cloud provider: cloud credentials with model access. See the prerequisites on the [Amazon… Control MCP server access for your organization Claude Code CLI · in the page managed-mcp …n Linux. Claude Code looks for the file at one of these paths: | Platform | Path | | :- | :- | | macOS | `/Library/Application Support/ClaudeCode/managed-mcp.json` | | Linux and WSL | `/etc/claude-co… Deploy managed settings Claude Code CLI · in the page managed-settings …ntial](https://code.claude.com/docs/en/server-managed-settings.md#platform-availability), signs in to a gateway with `/login`, or runs in Claude Desktop's Code tab behind a gateway that [serves that s… Connect Claude Code to tools via MCP Claude Code CLI · in the page mcp …ly an SDK host application can register`. > [!NOTE] > > In `--output-format stream-json` runs, Claude Code also reports a skipped `--mcp-config` entry in the `system/init` event's [`mcp_server_errors… Connect to MCP servers Claude Code CLI · in the page mcp-quickstart …he [scope table](#find-your-configuration-on-disk) uses the same JSON format for server entries. This section edits `.mcp.json`, the project-scope file. It's the one most worth writing by hand because… How Claude remembers your project Claude Code CLI · in the page memory …e concrete enough to verify: * "Use 2-space indentation" instead of "Format code properly" * "Run `npm test` before committing" instead of "Test your changes" * "API handlers live in `src/api/handler… Claude Code on Microsoft Foundry Claude Code CLI · in the page microsoft-foundry …figure a deployment, you also choose its [hosting option](https://platform.claude.com/docs/en/build-with-claude/claude-in-microsoft-foundry#hosting-options), which determines whether inference runs on… Claude Code on mobile Claude Code CLI · in the page mobile …you are away from your terminal](https://code.claude.com/docs/en/platforms.md#work-when-you-are-away-from-your-terminal). Cloud sessions and Remote Control run from the **Code** tab. For Dispatch, w… Model configuration Claude Code CLI · in the page model-config …A **model name** * Anthropic API: a full **[model name](https://platform.claude.com/docs/en/about-claude/models/overview)** * Amazon Bedrock: an inference profile ARN * Microsoft Foundry: a depl… Monitoring Claude Code CLI · in the page monitoring-usage …or Managed Agents, see [OpenTelemetry for the Claude API](https://platform.claude.com/docs/en/manage-claude/opentelemetry). ## Quick start Configure OpenTelemetry using environment variables: ```ba… Enterprise network configuration Claude Code CLI · in the page network-config …mple.com:8080 # Bypass proxy for specific requests - space-separated format export NO_PROXY="localhost 192.168.1.1 example.com .example.com" # Bypass proxy for specific requests - comma-separated for… Output styles Claude Code CLI · in the page output-styles # Output styles > Change Claude Code's role, tone, and response format with a built-in output style such as Concise or Explanatory, or write a custom style. An output style is a set of instructions… Overview Claude Code CLI · in the page overview …ocs\&utm_content=overview_pricing) or [Anthropic Console](https://platform.claude.com/) account. The Terminal CLI, VS Code, and JetBrains also support [third-party providers](https://code.claude.com/d… Choose a permission mode Claude Code CLI · in the page permission-modes …rmissions.md#set-permission-mode). These examples show the auto mode form for the CLI and each SDK: > [tab] CLI > > ```bash theme={null} > claude -p "Run the test suite and fix any failures" --permi… Configure permissions Claude Code CLI · in the page permissions …a7CKjMeIChox26S/images/permission-prompt-bash-light.png?fit=max\&auto=format\&n=oa7CKjMeIChox26S\&q=85\&s=87585d008a29304873466399f7b476f6) The third option, **Yes, and switch to auto mode**, [doesn'… Test plugins with evals Claude Code CLI · in the page plugin-evals …ll-creator) runs a similar comparison with its own `evals/evals.json` format, and neither tool reads the other's case files. To create a plugin, see [Create a plugin](https://code.claude.com/docs/en/p… Recommend your plugin from your CLI Claude Code CLI · in the page plugins/cli-hints …-cli` without the variable and confirm nothing extra prints. ## Hint format The tag must occupy its own line; Claude Code ignores a tag embedded mid-line. The tag takes three attributes, all requir… Plugin commands reference Claude Code CLI · in the page plugins/cli-reference …tplace`. When two marketplaces offer the same name, use the qualified form. `configure` takes only the qualified form. * **Scopes**: `--scope` takes `user`, `project`, or `local`, and names the settin… Add components to a plugin Claude Code CLI · in the page plugins/components …and the [component support table](https://claude.com/docs/plugins/platform-support#compare-component-support-by-app) ## Explore the plugin directory The explorer shows an example plugin, `my-plugin`… Create a Claude Code plugin Claude Code CLI · in the page plugins/create …and the [component support table](https://claude.com/docs/plugins/platform-support#compare-component-support-by-app) Start from the section that matches what you already have: * **Nothing yet**: fol… Plugin dependencies Claude Code CLI · in the page plugins/dependencies …gin, and installing it installs every dependency. For example, a platform team can publish role-specific bundles in an internal marketplace so engineers run one `claude plugin install` instead of ins… Host and maintain a marketplace Claude Code CLI · in the page plugins/host-marketplace …/docs/en/plugins/cli-reference.md#plugin-marketplace-add) lists every form the command accepts. A successful add prints `Successfully added marketplace: your-marketplace`. Claude Code takes that name… Install and manage plugins Claude Code CLI · in the page plugins/install …> > Type `/` and look for the plugin's skills under its name, in the form `/<plugin>:<skill>`. For `commit-commands`, `/commit-commands:commit` appears. Two other places list the plugin too: > > * Op… Plugin loading reference Claude Code CLI · in the page plugins/loading …at). ## Find where a plugin came from Every plugin has an id of the form `<name>@<origin>`, which is what you see in settings files and in `claude plugin list --json`. The part after `@` tells you w… Plugin manifest reference Claude Code CLI · in the page plugins/manifest-reference …for plugin.json: every field with its type and default, accepted path forms, and the userConfig and environment variable schemas. A plugin manifest is the `plugin.json` file in a plugin's `.claude-pl… Marketplace reference Claude Code CLI · in the page plugins/marketplace-reference …an official Anthropic/Claude marketplace`. A control or bidirectional-formatting character in a name also reports `Marketplace name cannot contain control or bidirectional-formatting characters`. A ma… Measure plugin cost and usage Claude Code CLI · in the page plugins/measure …with `--plugin-dir` in the same command, as in `claude --plugin-dir ./formatter plugin details formatter`. This example reads an installed plugin named `formatter` that has two skills, a command, an… Manage mods for your organization Claude Code CLI · in the page plugins/mods/admin …DM, it works the same way on Amazon Bedrock, Google Cloud's Agent Platform, and Microsoft Foundry. For delivery from the claude.ai admin console, see [Platform availability](https://code.claude.com/do… Use the mods API Claude Code CLI · in the page plugins/mods/api …message. To give the model instructions, such as a role or an output format, also pass `system`, which becomes the system prompt. This hook answers a `/triage` command, [registered as a command](#ad… Create a mod Claude Code CLI · in the page plugins/mods/create …de-code/dgiVO_Od1X1faduV/images/mods-first-mod-light.mp4?fit=max&auto=format&n=dgiVO_Od1X1faduV&q=85&s=eb561134afa90375777408453ba51c77" aria-label="In a Claude Code session, the prompt 'list the file… React to events with a mod Claude Code CLI · in the page plugins/mods/events …ent as `e`, and the next handler as `next`. The handlers for an event form a middleware chain. `next(e)` calls the next handler, which is another mod's hook or, at the end of the chain, Claude Code's… Interface gallery for mods Claude Code CLI · in the page plugins/mods/gallery …interface from elements: text, boxes, buttons, fields, and a few that format content for you. The samples here show the code that draws an element, and most come with a screenshot of the result in a t… Draw in the interface with a mod Claude Code CLI · in the page plugins/mods/interface …claude-code/dgiVO_Od1X1faduV/images/mods-screen-map.svg?fit=max\&auto=format\&n=dgiVO_Od1X1faduV\&q=85\&s=5fda26b6609c62b68c6f9e528c1590ea) In a narrower terminal, the pane sits above the prompt inst… Mods overview Claude Code CLI · in the page plugins/mods/overview …ude-code/dgiVO_Od1X1faduV/images/mods-overview-light.mp4?fit=max&auto=format&n=dgiVO_Od1X1faduV&q=85&s=00a18aa0743b59a700f0275ce226e6d1" aria-label="In a Claude Code session, the prompt 'list the file… Mods reference Claude Code CLI · in the page plugins/mods/reference …#show-code-and-changes) | `source`, `language`, `path`, `startLine`, `format`, `wrap` | ✓ | ✓ | ✓ | | `Markdown` | `text`, `key`, `dimColor`, `onLinkPress`, `pressableLinks` | ✓ | ✓ | ✓ | | [`Input`](…
Feedback