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

136 pages for settings.json.

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

Automate actions with hooks Claude Code CLI · in the page hooks-guide …the terminal. **1. Add the hook to your settings** Open `~/.claude/settings.json` and add a `Notification` hook. If the file doesn't exist, create it. The example below uses `osascript` for macOS;… How Claude Code works Claude Code CLI · in the page how-claude-code-works …g your source files You can also allow specific commands in `.claude/settings.json` so Claude doesn't ask each time. This is useful for trusted commands like `npm test` or `git status`. Settings can… Interactive mode Claude Code CLI · in the page interactive-mode …pping like `jj` returns you to NORMAL mode. The following `~/.claude/settings.json` example turns on vim mode and maps `jj` to Escape: ```json theme={null} { "editorMode": "vim", "vimInsertModeR… Set up Claude Code in a monorepo or large codebase Claude Code CLI · in the page large-codebases …is scoped to one package or subsystem | Project settings in `.claude/settings.json` aren't inherited from parent directories the way CLAUDE.md files are. For which directory's `.claude/settings.json`… Connect Claude Code to an LLM gateway Claude Code CLI · in the page llm-gateway-connect …ng on your shell. Settings files have different scopes: * `~/.claude/settings.json` applies to all your projects. On Windows the path is `%USERPROFILE%\.claude\settings.json` * `.claude/settings.loca… Control MCP server access for your organization Claude Code CLI · in the page managed-mcp …ngs, an MDM-deployed plist or HKLM registry key, or a system `managed-settings.json` file. Placing it in user or project settings has no effect, so users cannot re-enable connectors that exclusive con… Deploy managed settings Claude Code CLI · in the page managed-settings …This is the quickest way to put a policy on each machine: a `managed-settings.json` file. If you haven't picked how to deliver managed settings yet, or your devices are under MDM or developers run cl… Connect Claude Code to tools via MCP Claude Code CLI · in the page mcp …-reference#enabledmcpjsonservers) committed to the project's `.claude/settings.json` is ignored in an untrusted folder, and the server stays at `⏸ Pending approval` instead of being connected and heal… How Claude remembers your project Claude Code CLI · in the page memory …keep it on for every session, add it to the `env` block in `~/.claude/settings.json` as shown in [Set environment variables](/docs/en/env-vars.md#set-environment-variables). This loads `CLAUDE.md`, `… Claude Code on Microsoft Foundry Claude Code CLI · in the page microsoft-foundry …onfig.md#correct-the-window-for-a-gateway-or-custom-model-id). This `settings.json` entry tells Claude Code that a deployment named `team-opus-prod` serves Opus 4.8: ```json theme={null} { "modelO… Model configuration Claude Code CLI · in the page model-config …de couldn't save your choice.** `/model` writes `model` to `~/.claude/settings.json`. If you can't write to that file, for example because another tool generates it or links it to a read-only copy, th… Monitoring Claude Code CLI · in the page monitoring-usage …e.md#variables-claude-code-ignores-in-env) in a repository's `.claude/settings.json` and `.claude/settings.local.json`, so a repository can't use them to turn telemetry on, choose where it goes, or ca… 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). ## Proxy configuration ### Environment variables Claude Code respects standard proxy enviro… Output styles Claude Code CLI · in the page output-styles …a style your default across projects, set `outputStyle` in `~/.claude/settings.json`. A project's own settings files [take precedence](/docs/en/settings.md#settings-precedence) over that value. When… Choose a permission mode Claude Code CLI · in the page permission-modes …/settings.md#where-settings-live) If you set `"auto"` in `.claude/settings.json` or `.claude/settings.local.json`, the value doesn't take effect, and Claude Code then uses the built-in default rat… Configure permissions Claude Code CLI · in the page permissions …s with `/permissions`. The dialog lists all permission rules and the `settings.json` file each rule comes from. You can open the dialog while Claude is working: when you add or remove a rule, Claude C… Plugin commands reference Claude Code CLI · in the page plugins/cli-reference …| `projectEnabled` | boolean | Whether the project's shared `.claude/settings.json` turns the plugin on. Marketplace installs only. Requires Claude Code v2.1.285 or later | | `dataDirSize` | object |… Add components to a plugin Claude Code CLI · in the page plugins/components …his: ```bash theme={null} #!/bin/bash npx prettier --write . ``` A `settings.json` at the plugin root holds [settings](/docs/en/settings-reference.md) that apply while the plugin is enabled, so a pl… Create a Claude Code plugin Claude Code CLI · in the page plugins/create …laude-plugin`. **3. Move your hooks** If you have hooks in `.claude/settings.json` or `.claude/settings.local.json`, create a hooks directory: ```bash theme={null} mkdir -p my-plugin/hooks ``` Cre… 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 …installed on your own machine or the ones your repository's `.claude/settings.json` turns on. For plugins your organization distributes through managed settings, see [Manage plugins for your organiza… Plugin loading reference Claude Code CLI · in the page plugins/loading …ugin through a repository, list it under `enabledPlugins` in `.claude/settings.json` or place it under `.claude/skills/`. Claude Code doesn't scan a project's `.claude/plugins/` directory. A cloud se… Plugin manifest reference Claude Code CLI · in the page plugins/manifest-reference …`subagentStatusLine` take effect; other keys are dropped at load. A `settings.json` at the plugin root takes precedence over this key. See [Default settings](/docs/en/plugins/components.md#default-se… Manage mods for your organization Claude Code CLI · in the page plugins/mods/admin …nConfigs`, keyed by `cc-plugin-sec-default@builtin`: ```json managed-settings.json theme={null} { "pluginConfigs": { "cc-plugin-sec-default@builtin": { "options": { "allowManagedM… Mods overview Claude Code CLI · in the page plugins/mods/overview …s": true`](/docs/en/settings-reference#disableallhooks) in `~/.claude/settings.json`. Your settings hooks and custom status line stop too. What your organization manages keeps running. If you use Cla… Mods reference Claude Code CLI · in the page plugins/mods/reference …- | | `CLAUDE_CODE_PLUGIN_DIRS` | Environment, or `env` in `~/.claude/settings.json` | Plugin directories to load as `--plugin-dir` does, for apps you can't pass a flag to. Absolute paths separated by… Troubleshoot a mod Claude Code CLI · in the page plugins/mods/troubleshoot …ge the value. The end of the line names its `pluginConfigs` entry in `settings.json`. ### `code nested too deep to scan: more than 2000 scopes` The line starts with the mod's name, then `hooks modul… Manage Claude Code plugins for your organization Claude Code CLI · in the page plugins/org …min console or as endpoint-managed settings through MDM or a `managed-settings.json` file. Most controls on this page take effect only from managed settings. This page is for administrators, and the… Plugins overview Claude Code CLI · in the page plugins/overview …everyone who works in this repository, through the committed `.claude/settings.json`. Each collaborator still [installs it on their own machine](/docs/en/plugins/loading.md#enabled-in-project-settings… Recommend plugins for your org Claude Code CLI · in the page plugins/relevance …to get its plugins suggested across your org. The following `managed-settings.json` registers an org marketplace from a GitHub repository and enables its suggestions: ```json theme={null} { "extra… Troubleshoot plugins Claude Code CLI · in the page plugins/troubleshooting …ur user or managed settings; a declaration in a repository's `.claude/settings.json` or `.claude/settings.local.json` doesn't count * For a source that differs from its settings declaration, re-add th… Continue local sessions from any device with Remote Control Claude Code CLI · in the page remote-control …ever it's set, in your shell environment or in the `env` block of a [`settings.json` file](/docs/en/settings-reference#all-settings), to use Remote Control. * If you set only `DISABLE_TELEMETRY` or… Automate work with scheduled tasks Claude Code CLI · in the page routines …HROPIC_AUTH_TOKEN` is set in your shell, or `apiKeyHelper` is set in `settings.json`, remove it first, since these take precedence over a claude.ai login. A profile or federation credential takes prec… Choose a sandbox environment Claude Code CLI · in the page sandbox-environments …e launching Claude Code through it. Put your configuration in `~/.srt-settings.json`, or in a file you pass with `--settings`. The package [README](https://github.com/anthropics/sandbox-runtime) docum… Configure the sandboxed Bash tool Claude Code CLI · in the page sandboxing …`true` in a [settings file](/docs/en/settings.md) such as `~/.claude/settings.json`. The table shows what a sandboxed command can reach by default and the settings that change each default. | Acces… Catch security issues as Claude writes code Claude Code CLI · in the page security-guidance …oad plugins from your user settings or from the repository's `.claude/settings.json`, as [What carries over from your setup](/docs/en/cloud-environments.md#what-carries-over-from-your-setup) explains.… Customize sessions in self-hosted environments Claude Code CLI · in the page self-hosted-environments-configuration …n` isn't connected. To use both, give your server a different name. `settings.json` doesn't carry MCP server definitions, and there is no top-level `mcpServers` field in the settings schema. In manag… Deploy self-hosted environments to production Claude Code CLI · in the page self-hosted-environments-deploy …e#attribution-sessionurl) to `false` in the runner host's [`~/.claude/settings.json`](/docs/en/self-hosted-environments-configuration#how-each-session’s-config-is-assembled), then restart the runner.… Self-hosted environments reference Claude Code CLI · in the page self-hosted-environments-reference …ted permission grants and configure allow rules in the host config's `settings.json` instead; repository-committed `sandbox.*` settings still apply either way, which is why the [repo-settings guard](/… Test self-hosted environments end to end Claude Code CLI · in the page self-hosted-environments-testing …elow on the runner host: * The settings block: merge into `~/.claude/settings.json` on the runner host * The script: save as `~/.claude/hooks/e2e-stop-hook-capture.sh` on the runner host and make it… Configure server-managed settings Claude Code CLI · in the page server-managed-settings …ttings** Add your configuration as JSON. All [settings available in `settings.json`](/docs/en/settings-reference#all-settings) are supported except those restricted to OS-level policy delivery; see [… Manage sessions Claude Code CLI · in the page sessions …ses them to locate the session. The standard settings files, such as `settings.json` and `settings.local.json`, are re-read at launch, so configuration that lives in them doesn't need to be passed aga… Claude Code settings Claude Code CLI · in the page settings …| Server-managed settings, plist / registry, or system-level `managed-settings.json` | All organization members for server-managed delivery; all users on the machine for plist, HKLM registry, and file… Example settings files Claude Code CLI · in the page settings-example # Example settings files > Realistic settings.json files for a developer, a team, and an organization: copy one, keep the keys you want, and change the values. This page holds three example `setting… All settings Claude Code CLI · in the page settings-reference # All settings > Complete reference for every Claude Code settings.json key: where each one goes, its type and default, and a paste-ready example, with an index of every key. [Back to index](#all-se… Advanced setup Claude Code CLI · in the page setup …-behavior). If Claude Code can't find Git Bash, set the path in your [settings.json file](/docs/en/settings.md): ```json theme={null} { "env": { "CLAUDE_CODE_GIT_BASH_PATH": "C:\\Progra… Extend Claude with skills Claude Code CLI · in the page skills …m as `--add-dir`. The `permissions.additionalDirectories` setting in `settings.json` grants file access only and loads none of these. Claude Code watches `.claude/skills/` in a directory you pass wit… Customize your status line Claude Code CLI · in the page statusline …atus line Add a `statusLine` field to your user settings (`~/.claude/settings.json`, where `~` is your home directory) or [project settings](/docs/en/settings.md#where-settings-live). Set `type` to `… Create custom subagents Claude Code CLI · in the page sub-agents …ermissions.allow`](/docs/en/settings-reference#permissions-allow) in `settings.json` or `settings.local.json`, but these rules apply to the entire session, not only the plugin subagent. > > If you're… Configure your terminal for Claude Code Claude Code CLI · in the page terminal-config …llowing settings entry turns on the terminal bell: ```json ~/.claude/settings.json theme={null} { "preferredNotifChannel": "terminal_bell" } ``` The desktop notification reaches your local machine…
Feedback