Follow Discord
Sweep 22 Oct 2026 · 21:04Z Build v2.1.309 528 read Stable v2.1.308 Latest v2.1.309 Next v2.1.309 Feeds RSS JSON llms.txt llms-full.txt Unofficial
HomeDocsSearch
Search the documentation

409 pages for options.

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

Hooks reference Claude Code CLI · in the page hooks …e-web.md). Use this reference to look up event schemas, configuration options, JSON input/output formats, and advanced features like async hooks, HTTP hooks, and MCP tool hooks. A plugin can also reg… Automate actions with hooks Claude Code CLI · in the page hooks-guide …} ] } ] } } ``` For full configuration options, see [Prompt-based hooks](/docs/en/hooks.md#prompt-based-hooks) in the reference. ## Agent-based hooks > [!WARNING] > >… Interactive mode Claude Code CLI · in the page interactive-mode …omatic continue stopped after repeated usage-limit hits · /rate-limit-options to try again`. ### Cancel the wait Press `Esc` at an empty prompt, or `Ctrl+C`, while the lines show, or run [`/rate-lim… Customize keyboard shortcuts Claude Code CLI · in the page keybindings …| Previous option | | `select:pageUp` | PageUp | Move up one page of options | | `select:pageDown` | PageDown | Move down one page of options | | `select:first` | Home | First option | | `select:last… Connect Claude Code to an LLM gateway Claude Code CLI · in the page llm-gateway-connect …secrets.GATEWAY_API_KEY }} ``` For the action's other authentication options, including `CLAUDE_CODE_OAUTH_TOKEN` and workload identity federation, see [Claude Code GitHub Actions](/docs/en/github-ac… Claude Code gateway compatibility guide Claude Code CLI · in the page llm-gateway-protocol …the `/model` picker. If you or your administrator set `replaceBuiltInOptions` in a [`modelPicker`](/docs/en/settings-reference#modelpicker) lineup, Claude Code hides the discovered models from the pi… Roll out an LLM gateway for your organization Claude Code CLI · in the page llm-gateway-rollout …ocs/en/admin-setup.md#decide-how-settings-reach-devices) compares the options ### Gateway requirements Whichever product provides the gateway, it must: * **Accept a supported API format**: one of t… Connect Claude Code to tools via MCP Claude Code CLI · in the page mcp …eed the default. ```bash theme={null} # Basic syntax claude mcp add [options] <name> -- <command> [args...] # Real example: Add Airtable server claude mcp add --env AIRTABLE_API_KEY=YOUR_KEY --trans… How Claude remembers your project Claude Code CLI · in the page memory …ocs/en/managed-settings.md) for other organization-wide configuration options. The `claudeMd` key lets you put managed CLAUDE.md content directly inside `managed-settings.json` instead of deploying a… Claude Code on Microsoft Foundry Claude Code CLI · in the page microsoft-foundry …ude.com/docs/en/build-with-claude/claude-in-microsoft-foundry#hosting-options), which determines whether inference runs on Azure or on Anthropic infrastructure. ### 2. Configure Azure credentials Cl… Model configuration Claude Code CLI · in the page model-config …uch as an older version that the list pins. If you set `replaceBuiltInOptions` in a [`modelPicker`](/docs/en/settings-reference#modelpicker) lineup, that row doesn't appear. Before v2.1.199, such an I… Monitoring Claude Code CLI · in the page monitoring-usage …nfigure only what you need) export OTEL_METRICS_EXPORTER=otlp # Options: otlp, prometheus, console, none export OTEL_LOGS_EXPORTER=otlp # Options: otlp, console, none # 3. Configure OT… Output styles Claude Code CLI · in the page output-styles …k](/docs/en/hooks-guide.md). > * For skills, subagents, and the other options, see [Choose between an output style and other features](#choose-between-an-output-style-and-other-features). ## Built-in… Overview Claude Code CLI · in the page overview …> [!TIP] > > See [advanced setup](/docs/en/setup.md) for installation options, manual updates, or uninstallation instructions. Visit [installation troubleshooting](/docs/en/troubleshoot-install.md) if… Choose a permission mode Claude Code CLI · in the page permission-modes …tarts-in) start in Manual mode. This mode appears as `default` in SDK options and settings. Calls needing approval are denied unless you approve them with an allow rule, hook, `canUseTool` callback, o… Configure permissions Claude Code CLI · in the page permissions …permission prompt shows what Claude is about to do, followed by your options. This example is the prompt for a Bash command, from a session in Manual mode: ![A Claude Code permission prompt titled B… Platforms and integrations Claude Code CLI · in the page platforms …vents from chat apps or your own servers into a session * [Scheduling options](/docs/en/scheduled-tasks.md#compare-scheduling-options): run prompts on a recurring schedule Test plugins with evals Claude Code CLI · in the page plugin-evals …runs. A case passes when its score meets the [`--threshold`](#command-options), `1.0` by default. In model calls, a suite makes roughly cases × runs agent runs with the plugin and the same number aga… Plugin commands reference Claude Code CLI · in the page plugins/cli-reference …r one session. The tables below list each subcommand's commonly used options, not every option. Run `claude plugin --help` in your shell to see which subcommands your version has, and `claude plugin… Add components to a plugin Claude Code CLI · in the page plugins/components …e plugins dialog](/docs/en/vs-code.md#install-plugins) asks for unset options as a form after an install, and a gear icon on the plugin's row opens the form again with every option. The `claude plugi… Create a Claude Code plugin Claude Code CLI · in the page plugins/create …ugin's [`userConfig`](/docs/en/plugins/components#user-configuration) options is part of installing through `/plugin` in a session. Loading with `--plugin-dir` doesn't show it, and neither does `claud… Install and manage plugins Claude Code CLI · in the page plugins/install …security.md). **3. Choose a scope** Select one of the three install options: * **Install for you (user scope)**: you get the plugin in every project on this machine * **Install for all collaborator… Plugin manifest reference Claude Code CLI · in the page plugins/manifest-reference …nized top-level field as a warning * **Strict objects**: `userConfig` options, `channels` entries, `lspServers` configs, and `monitors` entries are strict. An unknown key inside one is an error, and t… Marketplace reference Claude Code CLI · in the page plugins/marketplace-reference …lace. Removing it also uninstalls its plugins and deletes their data, options, and secrets. This named refusal message requires Claude Code v2.1.282 or later. If a settings file declares the marketpl… Measure plugin cost and usage Claude Code CLI · in the page plugins/measure …hanges reduce what it adds to every session. If you only use it, your options are to disable or uninstall it; see [Manage installed plugins](/docs/en/plugins/install.md#manage-installed-plugins). The… Manage mods for your organization Claude Code CLI · in the page plugins/mods/admin …{ "pluginConfigs": { "cc-plugin-sec-default@builtin": { "options": { "allowManagedModsOnly": true } } } } ``` With the option set in managed settings: * **No mod a u… Use the mods API Claude Code CLI · in the page plugins/mods/api …n/plugins/mods/create.md#get-the-types-for-your-build) list the other options, such as `effort`, and the [limits](/docs/en/plugins/mods/reference.md#limits) give the `maxTokens` default. ### Use prom… Create a mod Claude Code CLI · in the page plugins/mods/create …ugin.json` lists under `dependencies`. | | `tsconfig.json` | Compiler options that fit a hooks module | If your mod has no `tsconfig.json` of its own, Claude Code adds one at the mod's root that exte… React to events with a mod Claude Code CLI · in the page plugins/mods/events …call `$.ui.ask`. It shows your question above a numbered list of your options, in the dialog Claude uses to ask you something, and resolves to the label the user picks. After your options, the dialog… Interface gallery for mods Claude Code CLI · in the page plugins/mods/gallery …26bc747a) ### `Select` A `Select` lets the user pick one of several options, and runs `onSelect` with the option's `value`: ```javascript theme={null} Select({ key: 'format', label: 'Format',… Draw in the interface with a mod Claude Code CLI · in the page plugins/mods/interface …(value)` * **`Select`**: takes `onSelect(value)` with its choices in `options`, a list of at least one choice with unique values, such as `[{ value: 'sm', label: 'Small' }, { value: 'lg', label: 'Larg… Mods reference Claude Code CLI · in the page plugins/mods/reference …-a-mod-yourself) | Yes | The mod's entry point. Exports `register(on, options)`. Named `.js`, `.mjs`, `.cjs`, `.jsx`, `.ts`, `.mts`, `.cts`, or `.tsx`. An ES module. | | [`types/index.d.ts`](/docs/en/… Test a mod Claude Code CLI · in the page plugins/mods/test …Without it, your mod loads as `user`. * **`plugins`**: pass `test` an options object ahead of the test body. Its `plugins` array holds mods you write inline, each with a `name` and a `register` functi… Troubleshoot a mod Claude Code CLI · in the page plugins/mods/troubleshoot …d the mod and didn't write it, ask its author to fix the error. ### `options do not fit plugin.json userConfig` The line starts with the mod's name, then `hooks module did not load: options do not f… Publish and distribute a plugin Claude Code CLI · in the page plugins/publish …to distribute](#choose-how-to-distribute) to compare the distribution options. If you already know your route, go to [Prepare your plugin for release](#prepare-your-plugin-for-release), then follow yo… Plugin security and trust Claude Code CLI · in the page plugins/security …ane, select **Open homepage** or **View on GitHub** below the install options. If the pane offers neither, open the marketplace repository you found in the first step. Find the plugin's directory ther… Troubleshoot plugins Claude Code CLI · in the page plugins/troubleshooting …esn't rewrite the file, so the record isn't lost. Take the message's options in order: 1. Update Claude Code with `claude update`. 2. If you can't update, uninstall the named plugin with the version… How Claude Code uses prompt caching Claude Code CLI · in the page prompt-caching …ude.com/docs/en/build-with-claude/claude-in-microsoft-foundry#hosting-options). Hosted on Azure deployments are served on Azure infrastructure; Hosted on Anthropic deployments are served on Anthropic'… Quickstart Claude Code CLI · in the page quickstart …P, and more See [advanced setup](/docs/en/setup.md) for installation options, manual updates, or uninstallation instructions. ## Getting help * **In Claude Code**: type `/help` or ask a "how do I"… Automate work with scheduled tasks Claude Code CLI · in the page routines …/scheduled-tasks). To choose among all three, see [Compare scheduling options](/docs/en/scheduled-tasks.md#compare-scheduling-options). Team and Enterprise Owners can turn off scheduled tasks for all… Choose a sandbox environment Claude Code CLI · in the page sandbox-environments # Choose a sandbox environment > Compare Claude Code sandbox options: the built-in sandboxed Bash tool, sandbox runtime, dev containers, Docker, and VMs. Choose the right isolation for your threat mo… Configure the sandboxed Bash tool Claude Code CLI · in the page sandboxing …ttings key * [CLI reference](/docs/en/cli-reference.md): command-line options Run prompts on a schedule Claude Code CLI · in the page scheduled-tasks …[GitHub Actions](/docs/en/github-actions.md). ## Compare scheduling options Claude Code offers three ways to schedule recurring or one-off work: | | [Cloud](/docs/en/routines.md) | [Desktop](/docs… Security Claude Code CLI · in the page security …the GitHub credential on the server side. See [GitHub authentication options](/docs/en/claude-code-on-the-web.md#github-authentication-options) for how you grant access * **Push restrictions**: The [… Self-hosted environments Claude Code CLI · in the page self-hosted-environments …/docs/en/self-hosted-environments-deploy.md#configure-git) covers the options. Sessions reach your internal services from inside your network, and your git host the same way when it's internal; the tr… Customize sessions in self-hosted environments Claude Code CLI · in the page self-hosted-environments-configuration …`, and `GIT_ASKPASS` as you set them in its environment. * **`git -c` options**: a `git -c` option inside the hook overrides a `GIT_CONFIG_KEY_n` pair, the runner's or yours. It doesn't change `GIT_AL… Self-hosted environments quickstart Claude Code CLI · in the page self-hosted-environments-quickstart …-deploy.md#build-the-runner-image). * **Git 2.24 or newer**. Some git options on the deploy page need newer versions; [Configure git](/docs/en/self-hosted-environments-deploy.md#configure-git) states… Configure server-managed settings Claude Code CLI · in the page server-managed-settings …not `CLAUDE_CODE_DISABLE_1M_CONTEXT` * Terminal UI and accessibility options * Numeric limits, budgets, and timeouts Other delivered variables can require the user's approval before they take effect… Claude Code settings Claude Code CLI · in the page settings …erface where you can view status information and modify configuration options. From v2.1.181, you can change a single option without opening the interface by passing `key=value` to `/config`, for exam… All settings Claude Code CLI · in the page settings-reference …never combines lineups from two sources. * **Type**: object with an `options` array of rows and an optional `replaceBuiltInOptions` Boolean * **Default**: unset, so the picker shows the built-in line…
Feedback