600 pages for settings.

Keep Claude working toward a goal Claude Code CLI · in the page goal …d it's active for the current session only. A Stop hook lives in your settings file, applies to every session in its scope, and can run a script for deterministic checks or a prompt for model-evaluate… Claude Code on Google Cloud's Agent Platform Claude Code CLI · in the page google-vertex-ai …ts you pin them. It saves the result to the `env` block of your [user settings file](/docs/en/settings), so you don't need to export environment variables yourself. </Step> </Steps> After you've si… Run Claude Code programmatically Claude Code CLI · in the page headless …thout `--bare`, a `-p` session runs the hooks in a project's `.claude/settings.json` and connects the servers in its `.mcp.json`, even in a folder you've never trusted. A `-p` session shows no workspa… Hooks reference Claude Code CLI · in the page hooks …at output it can return. ## Configuration Hooks are defined in JSON settings files. The configuration has three levels of nesting: 1. Choose a [hook event](#hook-events) to respond to, like `PreToo… Automate actions with hooks Claude Code CLI · in the page hooks-guide …# Set up your first hook To create a hook, add a `hooks` block to a [settings file](#configure-hook-location). This walkthrough creates a desktop notification hook, so you get alerted whenever Claude… How Claude Code works Claude Code CLI · in the page how-claude-code-works …change or remove the attribution lines, set [`attribution`](/docs/en/settings-reference#attribution). To remove Claude Code's built-in commit and pull request instructions, set [`includeGitInstructio… Interactive mode Claude Code CLI · in the page interactive-mode …in Claude Code v2.1.261 and later. The [`keybindingFlavor`](/docs/en/settings-reference#keybindingflavor) setting that turned them on in earlier versions is deprecated and has no effect. You can't r… JetBrains IDEs Claude Code CLI · in the page jetbrains …, set the full path in the plugin's [Claude command setting](#general-settings). Claude Code works with any paid Claude subscription (Pro, Max, Team, or Enterprise) or a Claude Console account, and n… Customize keyboard shortcuts Claude Code CLI · in the page keybindings …n chat input area | | `Autocomplete` | Autocomplete menu is open | | `Settings` | Settings menu | | `Confirmation` | Permission and confirmation dialogs | | `Tabs` | Tab navigation components | | `Hel… Set up Claude Code in a monorepo or large codebase Claude Code CLI · in the page large-codebases …ted to the repository. ## What this guide covers The [table below](#settings-on-this-page) lists each setting and what it accomplishes. The [file tree after it](#the-example-monorepo) is the example… Other LLM gateways Claude Code CLI · in the page llm-gateway …es one credential. 3. Distribute the configuration through a [managed settings file](/docs/en/managed-settings#delivery-mechanisms) and your secrets tooling, so every machine receives the base URL and… Connect Claude Code to an LLM gateway Claude Code CLI · in the page llm-gateway-connect …rs can distribute the gateway address and credential through [managed settings](/docs/en/managed-settings), device management, or an [`apiKeyHelper`](#rotate-credentials-with-apikeyhelper), so Claude… Claude Code gateway compatibility guide Claude Code CLI · in the page llm-gateway-protocol …`GET /protocol`, covering that gateway's sign-in, inference, managed settings, model discovery, and telemetry endpoints. It is a separate document from this guide. <Note> * To roll out an existing… Roll out an LLM gateway for your organization Claude Code CLI · in the page llm-gateway-rollout …e developer credentials, distribute the configuration through managed settings, and verify the rollout. This page walks an administrator through rolling out an LLM gateway for Claude Code. It assumes… Control MCP server access for your organization Claude Code CLI · in the page managed-mcp …vide servers to every user, with managed configuration files, managed settings, allowlists, and denylists. By default, anyone running Claude Code can connect any [MCP server](/docs/en/mcp) they choos… Connect Claude Code to tools via MCP Claude Code CLI · in the page mcp …de skips a `"type": "sdk"` entry in `.mcp.json`, `~/.claude.json`, or settings and reports `Skipped — MCP server "<name>" declares type "sdk", which only an SDK host application can register`. In `--… Connect to MCP servers Claude Code CLI · in the page mcp-quickstart …ge MCP access for an organization](/docs/en/managed-mcp) with managed settings and policy controls * [Reference MCP resources](/docs/en/mcp#use-mcp-resources) in prompts with @ mentions * [Run MCP pro… How Claude remembers your project Claude Code CLI · in the page memory …fore you run `/init`. Set it in your shell or in the `env` block of a settings file, as shown in [Set environment variables](/docs/en/env-vars#set-environment-variables). With it set, `/init` asks whi… Model configuration Claude Code CLI · in the page model-config …teway). </Note> ### Model aliases Use a model alias to select model settings without remembering exact version numbers: | Model alias | Behavior | | - | - | | **`default`** | Special value that cle… Monitoring Claude Code CLI · in the page monitoring-usage …ministrator configuration Administrators can configure OpenTelemetry settings for all users through the [managed settings file](/docs/en/managed-settings#delivery-mechanisms). See the [settings prece… Enterprise network configuration Claude Code CLI · in the page network-config …environment variables shown on this page can also be configured in [`settings.json`](/docs/en/settings). </Note> ## Proxy configuration ### Environment variables Claude Code respects standard prox… Output styles Claude Code CLI · in the page output-styles …Change your output style Pick a style with the command, a menu, or a settings file. The command and both menus save your choice to `.claude/settings.local.json` at the [local project level](/docs/en/… Overview Claude Code CLI · in the page overview …e same underlying Claude Code engine, so your repo's CLAUDE.md files, settings, and MCP servers work across all of them. Beyond the [Terminal](/docs/en/quickstart), [VS Code](/docs/en/vs-code), [JetB… Choose a permission mode Claude Code CLI · in the page permission-modes …n starts in](#which-mode-a-session-starts-in) covers the surfaces and settings that change the starting permission mode. You can also change a running session's permission mode at any time. ## Availa… Configure permissions Claude Code CLI · in the page permissions …he agent is allowed to do and what it can't. You can check permission settings into version control to share them with every developer in your organization, and each developer can customize their own.… Test plugins with evals Claude Code CLI · in the page plugin-evals …ne your plugin declares * Any grader you mark `arm: with-only` Three settings change that exclusion: * **Every grader excluded**: if every grader in a case is in the excluded set, they're scored nor… Plugin commands reference Claude Code CLI · in the page plugins/cli-reference …copes**: `--scope` takes `user`, `project`, or `local`, and names the settings file the command writes to. `update` also takes `managed`. ### plugin init Scaffold a new plugin at `~/.claude/skills/<… Add components to a plugin Claude Code CLI · in the page plugins/components …nents#hooks', linkText: 'Go to the Hooks section' }, { id: 'settings', name: 'Default settings', path: 'settings.json', lines: [{ depth: 0, kind: 'file', text:… Create a Claude Code plugin Claude Code CLI · in the page plugins/create …op-level `"hooks"` key whose value has the same shape as `hooks` in a settings file | | `.mcp.json` | MCP server definitions | <Warning> Only `plugin.json` goes inside `.claude-plugin/`. Components… Create a marketplace Claude Code CLI · in the page plugins/create-marketplace …s `✔ Successfully added marketplace: my-marketplace (declared in user settings)`, which means the marketplace is recorded in your user settings file. Install the plugin. The install id is the ent… Plugin dependencies Claude Code CLI · in the page plugins/dependencies …organization, an administrator adds it to `enabledPlugins` in managed settings. See [Pre-install and require plugins](/docs/en/plugins/org#pre-install-and-require-plugins). ### Depend on a plugin fro… Host and maintain a marketplace Claude Code CLI · in the page plugins/host-marketplace …e --scope project` there once from your shell and commit the `.claude/settings.json` it writes. Claude Code then registers the marketplace for each teammate who [trusts the folder](/docs/en/plugins/or… Install and manage plugins Claude Code CLI · in the page plugins/install …[Choose an install scope](#choose-an-install-scope) says which settings file each one writes to and which applies when the same plugin is set at more than one. After you select a scope… Plugin loading reference Claude Code CLI · in the page plugins/loading …ng reference > Trace where Claude Code loads each plugin from, which settings file decides whether it loads, and why an update changed nothing. Use this page when a plugin didn't load, loaded a diff… Plugin manifest reference Claude Code CLI · in the page plugins/manifest-reference …or objects | Plugins that must be enabled for this one to work | | [`settings`](#settings) | Object | Settings Claude Code applies while the plugin is enabled. Only `agent` and `subagentStatusLine` t… Marketplace reference Claude Code CLI · in the page plugins/marketplace-reference …ere Claude Code fetches the marketplace file itself. You write one in settings, or Claude Code builds one when you run `claude plugin marketplace add`. This reference is for marketplace maintainers w… Measure plugin cost and usage Claude Code CLI · in the page plugins/measure …gin-dir` or from a skills directory * Plugins enabled through managed settings, or mounted from a [seed directory](/docs/en/plugins/org#seed-containers-and-ci) * Plugins that include a theme, output s… Manage mods for your organization Claude Code CLI · in the page plugins/mods/admin …e mods for your organization > Control Claude Code mods with managed settings: stop user-installed mods, allow only your own, review what a mod can do, and enforce policy with your own mod. A [mod](… Use the mods API Claude Code CLI · in the page plugins/mods/api …et` environment variables. Write the name as a string literal. | | `$.settings` | `read` what the settings files and managed policy hold | | `$.session` | `messages()` returns the transcript as a list… Create a mod Claude Code CLI · in the page plugins/mods/create …mparison on the overview](/docs/en/plugins/mods/overview#compare-mods-settings-hooks-skills-and-mcp-servers) first. <Note> Mods require Claude Code v2.1.287 or later. In your shell, run `claude --v… React to events with a mod Claude Code CLI · in the page plugins/mods/events …r it. The event name can be a wildcard. `'classic.*'` matches every [settings hook event](#hook-the-settings-hook-events). `'*'` matches every event except the [telemetry events](/docs/en/plugins/mod… Draw in the interface with a mod Claude Code CLI · in the page plugins/mods/interface …session reads or writes the store for [`cleanupPeriodDays`](/docs/en/settings-reference#cleanupperioddays). The store is a key-value store, saved as a JSON file of your plugin's own under `~/.claude/… Mods overview Claude Code CLI · in the page plugins/mods/overview …vents, as a shell command, HTTP request, or prompt you configure in a settings file. A mod's handlers are functions that run inside Claude Code instead. Claude Code calls both kinds hooks: on these pa… Mods reference Claude Code CLI · in the page plugins/mods/reference …nts, mods API methods, render sites, elements by surface, limits, and settings. Look up any event a [mod](/docs/en/plugins/mods/overview) can handle, mods API method it can call, or render site it ca… Test a mod Claude Code CLI · in the page plugins/mods/test …e way, and `$.classic.Stop` and the other `$.classic` methods fire a [settings hook event](/docs/en/plugins/mods/events#hook-the-settings-hook-events). A test can't fire a mods API call such as `ui.cl… Troubleshoot a mod Claude Code CLI · in the page plugins/mods/troubleshoot …ere` | A setting is blocking your mods: `disableAllHooks` in your own settings, or your organization's policy | | `hooks modules are turned off in this process` | Anthropic has turned installed mods o… Manage Claude Code plugins for your organization Claude Code CLI · in the page plugins/org …ude Code installs and allows across your organization through managed settings. Managed settings let you decide which plugins Claude Code installs and allows on every machine in your organization. Us… Plugins overview Claude Code CLI · in the page plugins/overview …skill you can run, it has to be present at each of these layers: * **Settings**: your settings list the marketplaces you've added and the plugins that are enabled. * **Disk**: `~/.claude/plugins/` ho… Publish and distribute a plugin Claude Code CLI · in the page plugins/publish …ermission to other members through a custom role under **Organization settings > Roles**. See [Confirm you can submit to the directory](https://claude.com/docs/directory/publish#confirm-you-can-submit… Recommend plugins for your org Claude Code CLI · in the page plugins/relevance …when a user's work matches, and allowlist the marketplace in managed settings. Claude Code can suggest installing a plugin from your organization's marketplace when a user's session matches signals…