@weavecode/weave 0.1.2 → 0.1.4

package/node_modules/@weavecode/harness/dist/claude/settings-catalog.generated.js

@@ -0,0 +1 @@
+export const CLAUDE_SETTINGS_GROUPS=["Model and responses","Permission settings","Sandbox settings","Memory and context","Interface and terminal","Git and attribution","Hooks and automation","Plugins and skills","MCP","Agents, sessions, and worktrees","Remote, desktop, and notifications","Authentication and providers","Updates and versioning","Tools","Privacy and telemetry","Enterprise and managed settings","Global config settings"],CLAUDE_SETTINGS_KEYS=[{key:"advisorModel",group:"Model and responses",type:"string",options:["fable","opus","sonnet","claude-opus-5-5"],default:"unset, so the advisor is off",description:"Pick which model answers when Claude calls the server-side advisor tool. Unset it to turn the advisor off. The advisor must be at least as capable as your main model. See Choose an advisor model for the accepted pairings and what happens when you pick one that isn't accepted. You don't usually edit this key by hand\u2026",scope:"any"},{key:"alwaysThinkingEnabled",group:"Model and responses",type:"Boolean",default:"unset, so thinking is on for models that support it",description:"Turn extended thinking off for every session by setting this to false. Thinking is on by default, so true changes nothing. Most people set this through /config rather than by editing the file. On models that always think, such as Opus 5.5, Sonnet 5.5, Haiku 5.5, and the Fable models, false has no effect\u2026",scope:"any"},{key:"availableModels",group:"Model and responses",type:"array of model aliases or IDs",default:"unset, so every model is available",description:"Restrict which models people can select for the main session, subagents, skills, and the advisor. A managed list constrains /model, --model, and the model key in a developer's own files; a model outside it can't be selected. With the default prefix matching, this doesn't touch the Default option on its own\u2026",scope:"any",shape:"array",valueType:"string"},{key:"availableModelsMatch",group:"Model and responses",type:"string",options:["prefix","exact"],default:'"prefix"',description:'Choose how availableModels entries match model IDs. By default a model ID entry also permits later versions that extend it, so "claude-opus-5" permits Opus 5.5. With "exact", each model ID entry permits only the version it names, so a newer version of that model stays blocked until you list it\u2026',scope:"managed"},{key:"deniedModels",group:"Model and responses",type:"array of model aliases or IDs",default:"unset, so no model is blocked",description:"Block specific models, with or without an availableModels allowlist and even when that list permits them. Claude Code hides a blocked model from the /model picker, and the model can't be selected anywhere availableModels is enforced. A session on the Default option doesn't run a blocked model either\u2026",scope:"managed",shape:"array",valueType:"string"},{key:"effortLevel",group:"Model and responses",type:"string",options:["low","medium","high","xhigh"],default:"unset",description:"Set a default effort level for models you haven't saved a level for. Lower levels are faster and cheaper on straightforward tasks, and higher levels reason more deeply on complex problems. When you run /effort low, medium, high, or xhigh in an interactive session on your machine\u2026",scope:"any"},{key:"enforceAvailableModels",group:"Model and responses",type:"Boolean",default:"false",description:"The /model picker has a Default option, and default model setting describes the model it resolves to. An availableModels allowlist limits the models you can name, but with the default prefix matching it doesn't remap your account type's default, so Default can still resolve to a model outside the list\u2026",scope:"any"},{key:"fallbackModel",group:"Model and responses",type:'array of model aliases or IDs; "default" expands to the default model',default:"unset, so a failed request isn't retried on another model",description:"Name backup models for Claude Code to try, in order, when your primary model is overloaded or unavailable. Claude Code switches to the next available model in the chain for the rest of the turn and shows a notice. Without a chain, Claude Code retries the same model and then surfaces the server's error\u2026",scope:"any",shape:"array",valueType:"string"},{key:"fastMode",group:"Model and responses",type:"Boolean",default:"unset, so fast mode is off",description:"Turn fast mode on for sessions where it's available, for interactive work like rapid iteration or live debugging where you want speed at a higher cost per token. You don't usually edit this key by hand: running /fast writes fastMode: true to ~/.claude/settings.json\u2026",scope:"any"},{key:"fastModePerSessionOptIn",group:"Model and responses",type:"Boolean",default:"false",description:"Normally, running /fast saves fastMode to a person's user settings, so fast mode is on at the start of every later session. Set this key to true to stop that: a saved fastMode: true no longer turns fast mode on at session start, and each person has to run /fast in each session they want it\u2026",scope:"any"},{key:"language",group:"Model and responses",type:'string, any language name, such as "japanese", "spanish", or "french"\u2026',default:"unset; session titles then match the language of your conversation",description:"Have Claude respond in a language other than English by default. There is no fixed list for responses: Claude Code passes the value verbatim to Claude as an instruction to always respond in that language, so any language name Claude can read works. Claude Code doesn't check the value\u2026",scope:"any"},{key:"maxEffortLevel",group:"Model and responses",type:"string",options:["low","medium","high","xhigh","max"],default:"unset, so no cap applies",description:"Cap the effort level a session can use, leaving lower levels available. Any higher level runs at the cap instead, including one from /effort, the /model picker, --effort, CLAUDE_CODE_EFFORT_LEVEL, a skill's or subagent's effort frontmatter, or the model's own default\u2026",scope:"any"},{key:"model",group:"Model and responses",type:"string, a model alias or full model ID",default:"unset, so Claude Code uses your account's default model",description:"Set the model every new session uses, so you don't have to pick one with /model each time. Setting it here doesn't stop you from switching mid-session. If your admin set an organization default model to override user selection, you get that model even when you set this key in user, project, or local settings.",scope:"any"},{key:"modelOverrides",group:"Model and responses",type:"object mapping model ID to provider model ID",default:"unset",description:"Map Anthropic model IDs to provider-specific model IDs, such as Amazon Bedrock inference profile ARNs. Each model picker entry then uses its mapped value when calling the provider API. Administrators use this on Amazon Bedrock, Google Cloud's Agent Platform\u2026",scope:"any",shape:"map",valueType:"string"},{key:"modelPicker",group:"Model and responses",type:"object with an options array of rows and an optional replaceBuiltInOptions Boolean",default:"unset, so the picker shows the built-in lineup",description:"List the models the /model picker offers, in the order you write them and under labels you choose, so the picker lists the models your organization runs, after the built-in lineup or instead of it. Each row's model is taken verbatim, so it accepts anything --model accepts: an alias such as opus, an Anthropic model ID\u2026",scope:"any"},{key:"modelPicker.options",group:"Model and responses",type:"array of rows, each with a required model and optional label, description, and behavesAs",description:"The rows the picker shows, in this order, except that a grayed-out row moves to the bottom. Without a label, Claude Code titles the row with the built-in name for a model it knows, or the model ID otherwise, and without a description it writes a generic second line",scope:"any",nested:!0},{key:"modelPicker.replaceBuiltInOptions",group:"Model and responses",type:"Boolean",description:"Set it to true to show only these rows, Default, and a row for the model the session is already using. Leave it unset to add these rows after the built-in lineup",scope:"any",nested:!0},{key:"modelPricing",group:"Model and responses",type:"object with an optional multiplier and an optional overrides map",default:"unset, so Claude Code reports list price unless a host application supplies a table",description:"Report spend at the rates your organization pays instead of list price. Set it when your organization has contracted rates, so the dollar figures developers see match your bill. Claude Code applies the rates in /usage, the status line, the Agent SDK's total_cost_usd, the --max-budget-usd limit\u2026",scope:"managed"},{key:"modelPricing.multiplier",group:"Model and responses",type:"number greater than 0 and at most 10",description:"Scales every cost Claude Code computes, whether or not an overrides row covers it. Below 1 is a discount, above 1 a markup",scope:"any",nested:!0},{key:"modelPricing.overrides",group:"Model and responses",type:"map of model ID to a rate object with input, output, cacheRead, and cacheWrite, each 0 to 10000",description:"The USD-per-million-token rates for that model, all four required. cacheWrite covers both five-minute and one-hour cache writes. See Which models a row applies to",scope:"any",nested:!0},{key:"modelSettings",group:"Model and responses",type:"object mapping a model name to an object with any of these fields",default:"unset",description:"Save an effort level for each model you use. Requires Claude Code v2.1.251 or later. In an interactive session on your machine, when you save low, medium, high, or xhigh as your default with /effort or the /model picker's effort slider, Claude Code writes that level here under the model you're using\u2026",scope:"any",shape:"map",fields:[{name:"effortLevel",type:"enum",options:["low","medium","high","xhigh"],description:'one of "low", "medium", "high", or "xhigh"'},{name:"maxEffortLevel",type:"string",description:"the highest effort level the model may run at"},{name:"autoCompactWindow",type:"number",description:'a number of tokens from 100000 to 1000000, or "auto" for the window tuned for the model. /autocompact saves here. For that model, the value takes precedence over a top-level autoCompactWindow in the same settings file. Requires Claude Code v2.1.288 or later'}]},{key:"outputStyle",group:"Model and responses",type:"string, the name of a built-in or custom output style",default:"unset, so Claude Code uses the default style",description:"Select an output style by name. An output style is a saved set of instructions that changes Claude's role, tone, and output format, such as the built-in Explanatory and Learning styles or one you wrote yourself. If you change this key during a session, Claude uses the new style starting with your next message\u2026",scope:"any"},{key:"promptCacheTtl",group:"Model and responses",type:"string",options:["5m","1h"],default:"unset, so each main-conversation request gets its default lifetime",description:"Choose how long the prompt cache holds the main conversation. This key applies to your interactive, -p, and Agent SDK turns, together with the helpers Claude Code runs inline with them. The one-hour lifetime keeps the cache warm across longer breaks\u2026",scope:"any"},{key:"showThinkingSummaries",group:"Model and responses",type:"Boolean",default:"false",description:"See summaries of Claude's extended thinking in interactive sessions. Set it if you want the full summaries when you expand thinking with Ctrl+O. When unset or false, the Anthropic API redacts thinking blocks and Claude Code shows a collapsed stub.",scope:"any"},{key:"subagentPromptCacheTtl",group:"Model and responses",type:"string",options:["5m","1h"],default:"unset, so each of these requests gets its default lifetime",description:"Choose how long the prompt cache holds the requests Claude Code makes outside the main conversation. This key applies to subagents, workflows, and Claude Code's own background and helper requests, such as compaction and session titles. The one-hour lifetime keeps the cache warm across longer breaks\u2026",scope:"any"},{key:"switchModelsOnFlag",group:"Model and responses",type:"Boolean",default:"unset. Claude Code switches automatically, though it may ask first in an interactive session",description:"Choose what happens when a safety classifier flags a request: switch to the fallback model and continue, or pause so you can choose between switching and editing the prompt.",scope:"any"},{key:"ultracode",group:"Model and responses",type:"Boolean",default:"unset, so ultracode is off",description:"Start sessions with ultracode on. With it on, Claude plans a workflow for each substantive task instead of waiting for you to ask. Claude plans workflows only when dynamic workflows are enabled for you and your model supports xhigh effort\u2026",scope:"any"},{key:"allowManagedPermissionRulesOnly",group:"Permission settings",type:"Boolean",default:"unset, so Claude Code applies permission rules from user, project, and local settings and from --settings, in addition to the managed ones",description:"Make managed settings the only settings source of permission rules. Claude Code then ignores allow, ask, and deny rules in user, project, local, and --settings files, ignores --allowedTools, hides the always-allow choices in permission prompts, and stops saving new rules\u2026",scope:"managed"},{key:"autoMode",group:"Permission settings",type:"object with environment, allow, soft_deny, and hard_deny arrays of prose rules\u2026",default:"unset, so the classifier uses only its built-in rules",description:"Add your own rules to what the auto mode classifier blocks and allows. Use it to tell the classifier which repos, buckets, and domains your organization trusts, so it stops blocking routine internal operations. The classifier ships with built-in allow and deny rules\u2026",scope:"any"},{key:"autoMode.environment",group:"Permission settings",type:"array of strings",description:"autoMode: object with environment, allow, soft_deny, and hard_deny arrays of prose rules, plus the classifyAllShell Boolean",scope:"any",nested:!0},{key:"autoMode.allow",group:"Permission settings",type:"array of strings",description:"autoMode: object with environment, allow, soft_deny, and hard_deny arrays of prose rules, plus the classifyAllShell Boolean",scope:"any",nested:!0},{key:"autoMode.soft_deny",group:"Permission settings",type:"array of strings",description:"autoMode: object with environment, allow, soft_deny, and hard_deny arrays of prose rules, plus the classifyAllShell Boolean",scope:"any",nested:!0},{key:"autoMode.hard_deny",group:"Permission settings",type:"array of strings",description:"autoMode: object with environment, allow, soft_deny, and hard_deny arrays of prose rules, plus the classifyAllShell Boolean",scope:"any",nested:!0},{key:"autoMode.classifyAllShell",group:"Permission settings",type:"Boolean",default:"false",description:"Send every Bash and PowerShell command through the auto mode classifier while auto mode is active. By default, auto mode suspends only allow rules that could run arbitrary code: tool-wide and wildcard rules such as Bash(*), and interpreter or shell-wrapper prefixes such as Bash(python *)\u2026",scope:"any"},{key:"disableAutoMode",group:"Permission settings",type:'the string "disable"',default:"unset",description:"Remove auto mode from the Shift+Tab cycle. Any session that would otherwise start in auto mode, whether from --permission-mode auto, a settings file, or the built-in default, starts in default instead. Administrators set it in managed settings to prevent developers in their organization from using auto mode.",scope:"any"},{key:"permissions",group:"Permission settings",type:"object with allow, ask, deny, additionalDirectories, blockReadsOutsideWorkingDirectories\u2026",default:"unset",description:"Control which tools Claude can use without asking, which ones always prompt, and which ones are blocked, and set the permission mode a session starts in. Every permissions.* key below nests under this object.",scope:"any"},{key:"permissions.allow",group:"Permission settings",type:"array of permission rule strings",default:"unset",description:"List the tool uses Claude Code approves without asking you. In an MCP rule, * can appear only in the tool name after the mcp<server> prefix, such as mcpgithubget_*; it can't appear in the server name.",scope:"any",shape:"array",valueType:"string"},{key:"permissions.ask",group:"Permission settings",type:"array of permission rule strings",default:"unset",description:"List the tool uses that prompt you for confirmation even in a permission mode that would otherwise approve them, such as acceptEdits or bypassPermissions. In dontAsk mode Claude Code denies a matching tool use instead of prompting.",scope:"any",shape:"array",valueType:"string"},{key:"permissions.deny",group:"Permission settings",type:"array of permission rule strings",default:"unset",description:"List the tool uses Claude Code blocks. Use it for files that hold API keys, secrets, or environment values: Claude Code excludes matching files from file discovery and search results, denies reads of them, and blocks the Edit and Write tools on the matching paths\u2026",scope:"any",shape:"array",valueType:"string"},{key:"permissions.additionalDirectories",group:"Permission settings",type:"array of directory paths",default:"unset",description:"Give Claude file access to directories outside the one you started in, as additional working directories. Most .claude/ configuration is not discovered from these directories.",scope:"any",shape:"array",valueType:"string"},{key:"permissions.blockReadsOutsideWorkingDirectories",group:"Permission settings",type:"Boolean",default:"unset, so reads outside the working directories follow your permission mode",description:"Make Claude's file tools refuse reads outside your working directories in every permission mode, including bypassPermissions. Claude Code denies Read, Grep, Glob, and LSP calls on those paths and tells Claude to ask you to add the directory with /add-dir. Files Claude Code itself needs stay readable\u2026",scope:"any"},{key:"permissions.defaultMode",group:"Permission settings",type:"string",options:["default","acceptEdits","plan","auto","dontAsk","bypassPermissions","manual"],default:"unset",description:"Set the permission mode new sessions start in. When you leave it unset, sessions start in the built-in default for your surface.",scope:"any"},{key:"permissions.disableBypassPermissionsMode",group:"Permission settings",type:'the string "disable"',default:"unset",description:"Prevent anyone from entering bypassPermissions mode. Claude Code then rejects the --dangerously-skip-permissions flag, and ignores an agent definition's permissionMode: bypassPermissions, so the subagent runs with the parent session's permission mode.",scope:"any"},{key:"permissions.disableAutoMode",group:"Permission settings",type:"string",description:"permissions: object with allow, ask, deny, additionalDirectories, blockReadsOutsideWorkingDirectories, defaultMode, disableBypassPermissionsMode, and disableAutoMode",scope:"any",nested:!0},{key:"useAutoModeDuringPlan",group:"Permission settings",type:"Boolean",default:"true",description:"Choose whether Claude Code uses the auto mode classifier to review shell commands in plan mode. With the default true, the classifier reviews each command during planning when auto mode is available and you see no prompt, except for critical-path removals\u2026",scope:"any"},{key:"skipAutoPermissionPrompt",group:"Permission settings",type:"Boolean",default:"unset, so the notice appears once",description:"Skip the one-time notice describing auto mode that Claude Code shows when you first enter auto mode yourself, for example through your own settings or the mode selector, rather than when the built-in default starts a session in it. Claude Code shows that notice once and then records that it was shown\u2026",scope:"any"},{key:"skipDangerousModePermissionPrompt",group:"Permission settings",type:"Boolean",default:"unset, so the dialog appears",description:'Skip the confirmation dialog Claude Code shows before a session enters bypassPermissions mode, whether from --dangerously-skip-permissions or from defaultMode: "bypassPermissions". Claude Code writes true here in your user settings when you accept that dialog once.',scope:"any"},{key:"sandbox",group:"Sandbox settings",type:"object with enabled, failIfUnavailable, autoAllowBashIfSandboxed, excludedCommands\u2026",default:"unset, so Claude Code runs commands without a sandbox",description:"Isolate the Bash commands Claude runs from your filesystem and network with sandboxing. Turn the sandbox on with enabled, then narrow or widen what sandboxed commands can touch with the filesystem, network, and credentials sub-objects. The sandbox runs on macOS, Linux, and WSL2.",scope:"any"},{key:"sandbox.enabled",group:"Sandbox settings",type:"Boolean",default:"false",description:"Turn on sandboxing for Bash commands. When you pick a mode in the /sandbox panel, Claude Code writes this key to .claude/settings.local.json for the current project; set it in ~/.claude/settings.json to sandbox every project.",scope:"any"},{key:"sandbox.failIfUnavailable",group:"Sandbox settings",type:"Boolean",default:"false",description:"Make Claude Code exit with an error at startup when sandbox.enabled is true but the sandbox can't start, because a dependency is missing or the platform is unsupported. Without this key, Claude Code runs commands unsandboxed. Managed deployments that require sandboxing as a security gate can use this setting\u2026",scope:"any"},{key:"sandbox.autoAllowBashIfSandboxed",group:"Sandbox settings",type:"Boolean",default:"true",description:"Let Claude Code run sandboxed Bash commands without a permission prompt. Commands that can't run in the sandbox still go through the regular permission flow, and deny rules and content-scoped ask rules such as Bash(git push *) still apply; a bare Bash ask rule is skipped for sandboxed commands\u2026",scope:"any"},{key:"sandbox.excludedCommands",group:"Sandbox settings",type:"array of command patterns",default:"unset, so no command is excluded",description:"Name commands that Claude Code runs outside the sandbox, such as tools that don't work under it. Each entry uses the same syntax as the content of a Bash(...) permission rule: an exact command, a prefix such as docker *, or a wildcard pattern. A pattern with no wildcard is an exact match\u2026",scope:"any",shape:"array",valueType:"string"},{key:"sandbox.allowUnsandboxedCommands",group:"Sandbox settings",type:"Boolean",default:"true",description:"Let Claude retry a command outside the sandbox with the dangerouslyDisableSandbox parameter after the sandbox blocks it. When it's false, Claude Code ignores that parameter. While the sandbox is running, commands Claude runs are then sandboxed unless they match an excludedCommands entry\u2026",scope:"any"},{key:"sandbox.enableWeakerNestedSandbox",group:"Sandbox settings",type:"Boolean",default:"false",description:"Run the Linux sandbox inside an unprivileged Docker container, where bubblewrap can't mount a fresh /proc. Instead the inner sandbox bind-mounts the container's existing /proc, which exposes process information that a fresh mount would hide. This reduces security\u2026",scope:"any"},{key:"sandbox.enableWeakerNetworkIsolation",group:"Sandbox settings",type:"Boolean",default:"false",description:"Let sandboxed commands on macOS reach the system TLS trust service, com.apple.trustd.agent. Go-based tools such as gh, gcloud, and terraform need it to verify TLS certificates when you use network.httpProxyPort with a MITM proxy and a custom CA\u2026",scope:"any"},{key:"sandbox.allowAppleEvents",group:"Sandbox settings",type:"Boolean",default:"false",description:"Let sandboxed commands on macOS send Apple Events, which open, osascript, and tools that open URLs in a browser need; without it they fail with error -600. This removes code-execution isolation: sandboxed commands can launch other applications unsandboxed with no user prompt\u2026",scope:"any"},{key:"sandbox.bwrapPath",group:"Sandbox settings",type:"string, an absolute path; Claude Code drops a relative path and falls back to PATH lookup",default:"unset, so Claude Code finds bwrap on PATH",description:"Point the sandbox at a bubblewrap binary installed outside PATH, such as a vendored copy on an air-gapped host. Claude Code uses the path both for the startup dependency check and when it wraps each sandboxed command.",scope:"managed"},{key:"sandbox.socatPath",group:"Sandbox settings",type:"string, an absolute path; Claude Code drops a relative path and falls back to PATH lookup",default:"unset, so Claude Code finds socat on PATH",description:"Point the sandbox network proxy at a socat binary installed outside PATH.",scope:"managed"},{key:"sandbox.ignoreViolations",group:"Sandbox settings",type:"object mapping a command substring to an array of violation substrings, usually paths",default:"unset, so every violation is reported",description:"Silence sandbox violation reports for paths you expect a command to probe and be refused, such as a tool that checks /etc/hosts on startup, so those denials don't show up as violations or in what Claude sees. The sandbox still blocks the access; only the report is suppressed\u2026",scope:"any",shape:"map",valueType:"array of strings"},{key:"sandbox.ripgrep",group:"Sandbox settings",type:"object with command, the path to the ripgrep binary, and optional args\u2026",default:"unset, so the sandbox uses the same ripgrep binary as Claude Code. That is the bundled binary unless you set USE_BUILTIN_RIPGREP to 0",description:"Point the sandbox at a ripgrep binary of your own instead of the one Claude Code uses, for example when your platform needs a differently built rg.",scope:"any"},{key:"sandbox.filesystem",group:"Sandbox settings",type:"object with allowWrite, denyWrite, denyRead, and allowRead arrays\u2026",default:"unset, so the default read and write boundaries apply",description:"Control which paths sandboxed commands can read and write. By default they can write to the working directory, the per-user temp directory, and directories you add with --add-dir, /add-dir, or permissions.additionalDirectories, and can read the rest of the filesystem, including credential files\u2026",scope:"any"},{key:"sandbox.network",group:"Sandbox settings",type:"object with the sub-keys below",default:"unset, so no domains are pre-allowed and your permission mode decides what happens to each new host",description:"Control which hosts, ports, and sockets sandboxed commands can reach. The sandbox routes outbound traffic through a proxy that enforces these lists; see Network isolation for how the proxy decides and when it prompts.",scope:"any"},{key:"sandbox.credentials",group:"Sandbox settings",type:"object with files, envVars, allowPlaintextInject, awsPairs, and sigv4",default:"unset, so no credentials are protected",description:"Declare the credential files and environment variables to protect from sandboxed commands. Each entry names a file path or a variable name and a mode: deny hides the credential inside the sandbox, and mask shows sandboxed commands a placeholder while the sandbox proxy substitutes the real value on outbound requests\u2026",scope:"any"},{key:"sandbox.filesystem.allowWrite",group:"Sandbox settings",type:"array of path strings, using the sandbox path prefixes",default:"unset, so sandboxed commands can write to the working directory, the per-user temp directory, directories you've added with --add-dir or /add-dir, and directories in permissions.additionalDirectories",description:"Add paths where sandboxed commands can write, beyond the working directory, the per-user temp directory, and the directories you've added with --add-dir, /add-dir, or permissions.additionalDirectories. Use it when a subprocess such as kubectl or a build tool needs to write outside the project.",scope:"any",shape:"array",valueType:"string"},{key:"sandbox.filesystem.denyWrite",group:"Sandbox settings",type:"array of path strings, using the sandbox path prefixes",default:"unset",description:"Block sandboxed commands from writing to specific paths, including paths inside a directory that is otherwise writable.",scope:"any",shape:"array",valueType:"string"},{key:"sandbox.filesystem.denyRead",group:"Sandbox settings",type:"array of path strings, using the sandbox path prefixes",default:"unset, so sandboxed commands keep the default read access, which includes credential files such as ~/.aws/credentials",description:"Block sandboxed commands from reading specific paths, such as credential files that the default read policy would otherwise expose. To protect a credential file and keep it usable through the sandbox proxy, see sandbox.credentials instead.",scope:"any",shape:"array",valueType:"string"},{key:"sandbox.filesystem.allowRead",group:"Sandbox settings",type:"array of path strings, using the sandbox path prefixes",default:"unset",description:"Re-open reading for specific paths inside a region that denyRead blocks, to build workspace-only read access. An exact or wildcard denyRead entry stays blocked inside a broader allowRead, as the overlap table shows. When a wildcard denyRead entry such as ~//.env matches a directory\u2026",scope:"any",shape:"array",valueType:"string"},{key:"sandbox.filesystem.allowManagedReadPathsOnly",group:"Sandbox settings",type:"Boolean",default:"false",description:"Honor only the allowRead entries that come from managed settings, so developers can't re-open read access to paths your organization blocked. Claude Code still merges denyRead entries from every settings scope the session loads.",scope:"managed"},{key:"sandbox.filesystem.disabled",group:"Sandbox settings",type:"Boolean",default:"false, so filesystem isolation stays on",description:"Skip filesystem isolation while keeping network isolation. Sandboxed commands get unrestricted read and write access to the host filesystem, and their network egress stays confined to network.allowedDomains. Use it when you sandbox to control where commands connect rather than what they write\u2026",scope:"any"},{key:"sandbox.ripgrep.command",group:"Sandbox settings",type:"string",description:"sandbox.ripgrep: object with command, the path to the ripgrep binary, and optional args, an array of arguments to prepend",scope:"any",nested:!0},{key:"sandbox.ripgrep.args",group:"Sandbox settings",type:"array of strings",description:"sandbox.ripgrep: object with command, the path to the ripgrep binary, and optional args, an array of arguments to prepend",scope:"any",nested:!0},{key:"sandbox.credentials.files",group:"Sandbox settings",type:'array of objects, each with path and a mode of "deny" or "mask"\u2026',default:"unset, so no credential files are protected",description:'Protect credential files or directories from sandboxed commands. With "mode": "deny", Claude Code blocks reads of the path inside the sandbox, the same read block as sandbox.filesystem.denyRead. With "mode": "mask", sandboxed commands on Linux and WSL2 read a sentinel copy of the file\u2026',scope:"any",shape:"array",valueType:"string"},{key:"sandbox.credentials.envVars",group:"Sandbox settings",type:'array of objects, each with name and a mode of "deny" or "mask"\u2026',default:"unset, so no environment variables are protected",description:'Protect environment variables from sandboxed commands. With "mode": "deny", Claude Code removes the variable from the environment of sandboxed commands. With "mode": "mask", sandboxed commands see a per-session sentinel value\u2026',scope:"any",shape:"array",valueType:"string"},{key:"sandbox.credentials.allowPlaintextInject",group:"Sandbox settings",type:"Boolean",default:"false",description:"Allow mask substitution on plain HTTP requests as well as TLS-terminated HTTPS. On plain HTTP the upstream identity is unverified and the credential travels in cleartext, so leave this off outside trusted test networks.",scope:"any"},{key:"sandbox.credentials.awsPairs",group:"Sandbox settings",type:"array of objects, each with accessKeyIdVar, secretAccessKeyVar, and optionally sessionTokenVar\u2026",default:"unset, so only the conventional trio is paired",description:"Group masked environment variables that form one AWS credential for SigV4 re-signing when your credential lives in variables with non-standard names. Claude Code links the conventional AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_SESSION_TOKEN trio automatically when you mask their whole values\u2026",scope:"any",shape:"array",valueType:"string"},{key:"sandbox.credentials.sigv4",group:"Sandbox settings",type:"object with streaming, presigned, and sigv4a, each",default:'unset, so every form is "deny"',description:"Choose what the sandbox proxy does with AWS request forms it can't re-sign: streaming for aws-chunked streaming uploads, presigned for presigned URLs, and sigv4a for SigV4A asymmetric signatures. This applies only to requests signed with a masked pair's placeholder access key ID. Requires Claude Code v2.1.224 or later.",scope:"any"},{key:"sandbox.credentials.sigv4.streaming",group:"Sandbox settings",type:"enum",options:["deny","passthrough"],description:"sandbox.credentials.sigv4: object with streaming, presigned, and sigv4a, each",scope:"any",nested:!0},{key:"sandbox.credentials.sigv4.presigned",group:"Sandbox settings",type:"enum",options:["deny","passthrough"],description:"sandbox.credentials.sigv4: object with streaming, presigned, and sigv4a, each",scope:"any",nested:!0},{key:"sandbox.credentials.sigv4.sigv4a",group:"Sandbox settings",type:"enum",options:["deny","passthrough"],description:"sandbox.credentials.sigv4: object with streaming, presigned, and sigv4a, each",scope:"any",nested:!0},{key:"sandbox.network.allowUnixSockets",group:"Sandbox settings",type:"array of strings, each a socket path",default:"unset, so the macOS sandbox blocks every Unix socket",description:"List the Unix socket paths sandboxed commands can connect to on macOS. Claude Code ignores this list on Linux and WSL2, where the seccomp filter can't inspect socket paths; use allowAllUnixSockets there instead.",scope:"any",shape:"array",valueType:"string"},{key:"sandbox.network.allowAllUnixSockets",group:"Sandbox settings",type:"Boolean",default:"false",description:"Let sandboxed commands connect to every Unix socket. On Linux and WSL2, the sandbox's seccomp filter blocks socket(AF_UNIX, ...) calls, so this is the only way to permit Unix sockets there. When the filter is missing, which /sandbox reports on its Dependencies tab, the sandbox doesn't block Unix-socket calls\u2026",scope:"any"},{key:"sandbox.network.allowLocalBinding",group:"Sandbox settings",type:"Boolean",default:"false",description:"Let sandboxed commands on macOS listen on network ports, for example to start a dev server, and connect to any port on localhost. A command that listens on a non-loopback address accepts connections from other machines. The key has no effect on Linux and WSL2\u2026",scope:"any"},{key:"sandbox.network.allowMachLookup",group:"Sandbox settings",type:"array of strings, each a service name; a single trailing * matches a prefix\u2026",default:"unset",description:"List additional XPC and Mach service names the macOS sandbox may look up. Tools that communicate over XPC, such as the iOS Simulator or Playwright, need their services listed here.",scope:"any",shape:"array",valueType:"string"},{key:"sandbox.network.allowedDomains",group:"Sandbox settings",type:"array of strings, each a domain, wildcard pattern, or IP literal, with an optional :port suffix",default:"unset, so your permission mode decides what happens to each new host",description:"Pre-allow domains for outbound traffic from sandboxed commands, so the sandbox doesn't prompt for them. Wildcards such as *.example.com match subdomains, and an optional :port suffix limits an entry to one port; an entry without a port matches every port.",scope:"any",shape:"array",valueType:"string"},{key:"sandbox.network.deniedDomains",group:"Sandbox settings",type:"array of strings, each a domain, wildcard pattern, or IP literal, with an optional :port suffix",default:"unset",description:"Block domains for outbound traffic from sandboxed commands, using the same wildcard, port, and IPv6 syntax as allowedDomains. A denied domain stays blocked even when an allowedDomains entry matches it too.",scope:"any",shape:"array",valueType:"string"},{key:"sandbox.network.strictAllowlist",group:"Sandbox settings",type:"Boolean",default:"false",description:"Deny sandboxed commands access to hosts outside the allowlist instead of prompting for approval. The allowlist is allowedDomains plus domains from WebFetch(domain:...) allow rules, or only the managed settings entries when allowManagedDomainsOnly is set\u2026",scope:"any"},{key:"sandbox.network.allowManagedDomainsOnly",group:"Sandbox settings",type:"Boolean",default:"false",description:"Lock the network allowlist to what managed settings define. Claude Code then honors only allowedDomains and WebFetch(domain:...) allow rules from managed settings, ignores domains from user, project, local, and --settings settings, and blocks a non-allowed domain automatically instead of prompting.",scope:"managed"},{key:"sandbox.network.httpProxyPort",group:"Sandbox settings",type:"number, a local TCP port",default:"unset, so Claude Code runs its own proxy",description:"Point the sandbox at your own HTTP proxy instead of the one Claude Code runs. Organizations do this to inspect HTTPS traffic, apply their own filtering rules, or log requests. Your proxy takes over filtering, and Claude Code stops applying its domain lists and network prompts to traffic sent there. When unset\u2026",scope:"any"},{key:"sandbox.network.socksProxyPort",group:"Sandbox settings",type:"number, a local TCP port",default:"unset, so Claude Code runs its own proxy",description:"Point the sandbox at your own SOCKS5 proxy instead of the one Claude Code runs. Your proxy takes over filtering, and Claude Code stops applying its domain lists and network prompts to traffic sent there. When unset, Claude Code starts its own proxy for SOCKS traffic.",scope:"any"},{key:"sandbox.network.tlsTerminate",group:"Sandbox settings",type:"object with optional caCertPath and caKeyPath strings, each a file path",default:"unset, so the proxy doesn't terminate or inspect TLS",description:"Make the sandbox proxy terminate TLS so it can read the contents of HTTPS requests. This is experimental, and mask credential substitution requires it. Set {} to generate an ephemeral certificate authority for the session, or set caCertPath and caKeyPath to use your own.",scope:"any"},{key:"sandbox.network.tlsTerminate.caCertPath",group:"Sandbox settings",type:"string",description:"sandbox.network.tlsTerminate: object with optional caCertPath and caKeyPath strings, each a file path",scope:"any",nested:!0},{key:"sandbox.network.tlsTerminate.caKeyPath",group:"Sandbox settings",type:"string",description:"sandbox.network.tlsTerminate: object with optional caCertPath and caKeyPath strings, each a file path",scope:"any",nested:!0},{key:"autoCompactEnabled",group:"Memory and context",type:"Boolean",default:"true",description:"Have Claude Code compact the conversation automatically when context approaches the limit. Appears in /config as Auto-compact, and toggling it there writes this key to your user settings.",scope:"any"},{key:"autoCompactWindow",group:"Memory and context",type:"number of tokens, from 100000 to 1000000. Claude Code caps the value at your model's context window;\u2026",default:"unset, so Claude Code picks a window tuned for your model",description:"Set how full the context window gets before Claude Code compacts automatically.",scope:"any"},{key:"autoMemoryDirectory",group:"Memory and context",type:"string, an absolute or ~/-prefixed directory path",default:"unset, so Claude Code uses ~/.claude/projects/<project>/memory/",description:"Store auto memory in a directory of your choice instead of the per-project default.",scope:"any"},{key:"autoMemoryEnabled",group:"Memory and context",type:"Boolean",default:"true",description:"Turn auto memory on or off. When false, Claude doesn't read from or write to the auto memory directory. You can also toggle it with /memory during a session, which writes this key to your user settings.",scope:"any"},{key:"bashOutputMaxChars",group:"Memory and context",type:"number of characters, a positive integer. Claude Code clamps the value into the range 4000 to 128000",default:"unset, so Claude receives up to 30,000 characters inline",description:"Set how many characters of a successful Bash or PowerShell command's output Claude receives inline. When output passes the limit, Claude Code saves it to a file and Claude receives a short preview plus the file's path. Raise the limit when command output, such as a verbose build or a full test-suite log\u2026",scope:"any"},{key:"claudeMd",group:"Memory and context",type:"string, the text of a CLAUDE.md file; write it as you would the file, Markdown included\u2026",default:"unset",description:"Inject CLAUDE.md-style instructions as organization-managed memory without deploying a separate file. Claude Code loads the text as a managed memory entry ahead of user and project CLAUDE.md files.",scope:"managed"},{key:"claudeMdExcludes",group:"Memory and context",type:"array of strings, each a glob pattern or absolute path",default:"unset, so Claude Code loads every CLAUDE.md it finds",description:"Skip specific CLAUDE.md files when Claude Code loads memory. In a large monorepo, use it to skip CLAUDE.md files from other teams that aren't relevant to your work; Exclude irrelevant CLAUDE.md files in the large-codebases guide walks through that case. Patterns match against absolute file paths.",scope:"any",shape:"array",valueType:"string"},{key:"env",group:"Memory and context",type:"object mapping variable names to string values",default:"unset",description:"Set environment variables for every session and for the subprocesses Claude Code starts from it. Most variables in the environment variables reference can go here, which is how you apply one to every session or roll it out to your team. Project and local settings can't set some of them.",scope:"any"},{key:"fileCheckpointingEnabled",group:"Memory and context",type:"Boolean",default:"true",description:"Have Claude Code snapshot files before each edit so /rewind can restore them. Appears in /config as Rewind code (checkpoints), and toggling it there writes this key to your user settings.",scope:"any"},{key:"idleCompaction",group:"Memory and context",type:"Boolean",default:"true",description:"Idle compaction compacts a long conversation that you've stepped away from, shortly before its prompt cache expires. Your next message then sends a summary instead of the whole conversation. When you come back, the conversation shows a line that starts with Compacted while idle, before the prompt cache expired\u2026",scope:"any"},{key:"plansDirectory",group:"Memory and context",type:"string, a path relative to the project root",default:"unset, so Claude Code uses ~/.claude/plans",description:"Choose where Claude Code stores the plan files it writes in plan mode. Claude Code resolves the path relative to the project root.",scope:"any"},{key:"skillListingBudgetFraction",group:"Memory and context",type:"number, a fraction greater than 0 and at most 1",default:"0.01, which reserves 1% of the context window",description:"Each turn, Claude sees a listing of your skills with their descriptions, and Claude Code caps that listing at a share of the context window. When the listing is over the cap, Claude Code keeps every skill's name but drops the descriptions of the least-used skills\u2026",scope:"any"},{key:"skillListingMaxDescChars",group:"Memory and context",type:"number of characters, a positive integer",default:"1536",description:"Each turn, Claude sees a listing of your skills that shows each skill's description and when_to_use text. This key caps how many characters of that text Claude Code shows per skill; longer text is cut at the cap.",scope:"any"},{key:"askUserQuestionTimeout",group:"Interface and terminal",type:"string",options:["60s","5m","10m","never"],default:'"never"',description:"Let an unanswered AskUserQuestion dialog auto-continue after a period of idle time, submitting whatever options you had already selected. Set it when you step away and want Claude to continue without you. With the default, questions wait until you answer them. For when the timer pauses or never starts\u2026",scope:"any"},{key:"autoContinueAtUsageLimit",group:"Interface and terminal",type:"Boolean",default:"true",description:"After a claude.ai usage limit stops your session, wait in the open session and continue the task automatically after the reset. See Turn automatic continue off. Requires Claude Code v2.1.234 or later.",scope:"any"},{key:"autoScrollEnabled",group:"Interface and terminal",type:"Boolean",default:"true",description:"Follow new output to the bottom of the conversation in fullscreen rendering. Turn it off to stay where you scrolled while Claude keeps working; permission prompts still scroll into view.",scope:"any"},{key:"axScreenReader",group:"Interface and terminal",type:"Boolean",default:"unset, so screen-reader mode is off",description:"Render screen-reader friendly output: flat text without decorative borders or animations. Screen-reader mode uses the classic renderer, so the tui setting has no effect while it is active; attached background sessions still render fullscreen.",scope:"any"},{key:"bashEditDiffEnabled",group:"Interface and terminal",type:"Boolean",default:"unset, so Claude Code records changes in auto mode and bypassPermissions mode when it directs Claude to edit files through Bash",description:"Choose whether Claude Code records which files changed in a Git repository while a Bash command runs. When it records them, you see their diff in the terminal after the command, and your PostToolUse Bash hooks receive the changed-file list. A listed file isn't always one the command changed\u2026",scope:"any"},{key:"companyAnnouncements",group:"Interface and terminal",type:"array of strings",default:"unset, so no announcement shows",description:"Show your organization's announcements to users at startup. When you list more than one, Claude Code picks one at random for each session; on a person's very first launch it shows the first entry.",scope:"any",shape:"array",valueType:"string"},{key:"defaultShell",group:"Interface and terminal",type:"string",options:["bash","powershell"],default:`"bash", or "powershell" on Windows when Bash isn't available`,description:'Choose whether Bash or PowerShell runs the shell commands you type with the ! prefix in the input box, the ones Claude Code runs directly and adds to the session. "powershell" works only while the PowerShell tool is on. The tool is on by default on Windows without Git Bash\u2026',scope:"any"},{key:"dialogExpiry",group:"Interface and terminal",type:"string",options:["60s","5m","10m","never"],default:'"5m"',description:"Set the deadline for dialogs Claude Code forwards to a remote client, such as a Remote Control or SDK host, and for the approval dialog for a held cross-session message. On Claude Code v2.1.236 or later\u2026",scope:"any"},{key:"editorMode",group:"Interface and terminal",type:"string",options:["normal","vim"],default:'"normal"',description:"Choose the key binding mode for the input prompt.",scope:"any"},{key:"emojiCompletionEnabled",group:"Interface and terminal",type:"Boolean",default:"true",description:"Show emoji suggestions when you type : plus a shortcode in the prompt input, and replace a completed shortcode such as :heart: with its emoji. Set it to false to turn off both.",scope:"any"},{key:"fileSuggestion",group:"Interface and terminal",type:'object with type, always "command", and command, the shell command to run',default:"unset, so Claude Code uses the built-in file suggestion",description:"Run your own command to supply @ file path autocomplete instead of the built-in file suggestion. The built-in suggestion uses fast filesystem traversal; a large monorepo may do better with project-specific indexing such as a pre-built file index.",scope:"any"},{key:"fileSuggestion.type",group:"Interface and terminal",type:"string",description:'fileSuggestion: object with type, always "command", and command, the shell command to run',scope:"any",nested:!0},{key:"fileSuggestion.command",group:"Interface and terminal",type:"string",description:'fileSuggestion: object with type, always "command", and command, the shell command to run',scope:"any",nested:!0},{key:"footerLinksRegexes",group:"Interface and terminal",type:'array of objects, each with type set to "regex", a pattern regex, a url template\u2026',default:"unset, so no badges render",description:"Render extra clickable badges in the footer below the input box when a regex matches turn output: tool results, including file contents and fetched pages, and Claude's own responses. Use it to turn IDs printed by project CLIs, such as review tools and issue trackers, into session links.",scope:"any",shape:"array",valueType:"string"},{key:"keybindingFlavor",group:"Interface and terminal",type:'string, "classic" or "readline"',default:"unset",description:"> [!WARNING] > > Deprecated since v2.1.261 and has no effect. The prompt's word-editing keys always follow readline conventions, as in Bash. Claude Code still accepts keybindingFlavor, so a settings file that sets it stays valid. In v2.1.238 through v2.1.260\u2026",scope:"any",deprecated:!0},{key:"maxProseWidth",group:"Interface and terminal",type:"number of terminal columns, a whole number, minimum 40. Claude Code ignores any other value",default:"unset, so prose wraps at the terminal edge",description:"Cap the width of the prose in Claude's responses so lines stay readable in a wide terminal. Paragraphs, headings, lists, and blockquotes wrap within this many columns, while tables and code blocks keep the full terminal width. Requires Claude Code v2.1.282 or later.",scope:"any"},{key:"prefersReducedMotion",group:"Interface and terminal",type:"Boolean",default:"false",description:"Reduce or turn off interface animations such as the spinner, shimmer, and flash effects. Appears in /config as Reduce motion.",scope:"any"},{key:"promptSuggestionEnabled",group:"Interface and terminal",type:"Boolean",default:"true",description:"Show or hide prompt suggestions, the grayed-out predictions that appear in your prompt input. Set it to false, or turn off Prompt suggestions in /config, to hide them.",scope:"any"},{key:"respectGitignore",group:"Interface and terminal",type:"Boolean",default:"true",description:"Control whether the @ file picker leaves out files that match .gitignore patterns. Appears in /config as Respect .gitignore in file picker.",scope:"any"},{key:"respondToBashCommands",group:"Interface and terminal",type:"Boolean",default:"true",description:"Choose whether Claude responds after you run a shell command with the ! prefix in the input box. By default, Claude Code adds the command's output to the conversation and Claude replies to it. Set this key to false to add the output to context without a reply\u2026",scope:"any"},{key:"showClearContextOnPlanAccept",group:"Interface and terminal",type:"Boolean",default:"false",description:"When Claude finishes a plan in plan mode, it shows an approval menu. Planning can use a lot of context, so this key adds a first option to that menu, Yes, clear context and \u2026, that approves the plan, clears the conversation context, and starts implementing from the plan alone\u2026",scope:"any"},{key:"showTurnDuration",group:"Interface and terminal",type:"Boolean",default:"true",description:'Show or hide the turn duration message after each response, such as "Cooked for 1m 6s \xB7 done 6:05 PM". The clock after "done" shows when the turn finished; timeFormat and timeZone control its format and zone. Appears in /config as Show turn duration.',scope:"any"},{key:"spellcheck",group:"Interface and terminal",type:'object with enabled (Boolean), checker ("aspell", "hunspell", "ispell", or "auto")\u2026',default:`unset, so spell checking is off; checker defaults to "auto", the first of the three found on PATH; language defaults to the checker's own dictionary; color defaults to the theme's error color`,description:"Underline misspelled words in the prompt input as you type, using a spell checker you install. Claude Code checks only the text in the input box. Check spelling as you type covers installing aspell, hunspell, or ispell and what the checker covers. Requires Claude Code v2.1.235 or later.",scope:"any"},{key:"spellcheck.enabled",group:"Interface and terminal",type:"string",description:'spellcheck: object with enabled (Boolean), checker ("aspell", "hunspell", "ispell", or "auto"), language (string, passed to the checker as its dictionary name), and color (string, a terminal color name, #rrggbb, rgb(r,g,b), ansi256(n), or ansi:<name>)',scope:"any",nested:!0},{key:"spellcheck.checker",group:"Interface and terminal",type:"string",description:'spellcheck: object with enabled (Boolean), checker ("aspell", "hunspell", "ispell", or "auto"), language (string, passed to the checker as its dictionary name), and color (string, a terminal color name, #rrggbb, rgb(r,g,b), ansi256(n), or ansi:<name>)',scope:"any",nested:!0},{key:"spellcheck.aspell",group:"Interface and terminal",type:"string",description:'spellcheck: object with enabled (Boolean), checker ("aspell", "hunspell", "ispell", or "auto"), language (string, passed to the checker as its dictionary name), and color (string, a terminal color name, #rrggbb, rgb(r,g,b), ansi256(n), or ansi:<name>)',scope:"any",nested:!0},{key:"spellcheck.hunspell",group:"Interface and terminal",type:"string",description:'spellcheck: object with enabled (Boolean), checker ("aspell", "hunspell", "ispell", or "auto"), language (string, passed to the checker as its dictionary name), and color (string, a terminal color name, #rrggbb, rgb(r,g,b), ansi256(n), or ansi:<name>)',scope:"any",nested:!0},{key:"spellcheck.ispell",group:"Interface and terminal",type:"string",description:'spellcheck: object with enabled (Boolean), checker ("aspell", "hunspell", "ispell", or "auto"), language (string, passed to the checker as its dictionary name), and color (string, a terminal color name, #rrggbb, rgb(r,g,b), ansi256(n), or ansi:<name>)',scope:"any",nested:!0},{key:"spellcheck.auto",group:"Interface and terminal",type:"string",description:'spellcheck: object with enabled (Boolean), checker ("aspell", "hunspell", "ispell", or "auto"), language (string, passed to the checker as its dictionary name), and color (string, a terminal color name, #rrggbb, rgb(r,g,b), ansi256(n), or ansi:<name>)',scope:"any",nested:!0},{key:"spellcheck.language",group:"Interface and terminal",type:"string",description:'spellcheck: object with enabled (Boolean), checker ("aspell", "hunspell", "ispell", or "auto"), language (string, passed to the checker as its dictionary name), and color (string, a terminal color name, #rrggbb, rgb(r,g,b), ansi256(n), or ansi:<name>)',scope:"any",nested:!0},{key:"spellcheck.color",group:"Interface and terminal",type:"string",description:'spellcheck: object with enabled (Boolean), checker ("aspell", "hunspell", "ispell", or "auto"), language (string, passed to the checker as its dictionary name), and color (string, a terminal color name, #rrggbb, rgb(r,g,b), ansi256(n), or ansi:<name>)',scope:"any",nested:!0},{key:"spellcheck.#rrggbb",group:"Interface and terminal",type:"string",description:'spellcheck: object with enabled (Boolean), checker ("aspell", "hunspell", "ispell", or "auto"), language (string, passed to the checker as its dictionary name), and color (string, a terminal color name, #rrggbb, rgb(r,g,b), ansi256(n), or ansi:<name>)',scope:"any",nested:!0},{key:"spellcheck.rgb(r,g,b)",group:"Interface and terminal",type:"string",description:'spellcheck: object with enabled (Boolean), checker ("aspell", "hunspell", "ispell", or "auto"), language (string, passed to the checker as its dictionary name), and color (string, a terminal color name, #rrggbb, rgb(r,g,b), ansi256(n), or ansi:<name>)',scope:"any",nested:!0},{key:"spellcheck.ansi256(n)",group:"Interface and terminal",type:"string",description:'spellcheck: object with enabled (Boolean), checker ("aspell", "hunspell", "ispell", or "auto"), language (string, passed to the checker as its dictionary name), and color (string, a terminal color name, #rrggbb, rgb(r,g,b), ansi256(n), or ansi:<name>)',scope:"any",nested:!0},{key:"spellcheck.ansi:<name>",group:"Interface and terminal",type:"string",description:'spellcheck: object with enabled (Boolean), checker ("aspell", "hunspell", "ispell", or "auto"), language (string, passed to the checker as its dictionary name), and color (string, a terminal color name, #rrggbb, rgb(r,g,b), ansi256(n), or ansi:<name>)',scope:"any",nested:!0},{key:"spinnerTipsEnabled",group:"Interface and terminal",type:"Boolean",default:"true",description:'While Claude works, the spinner line rotates through short tips about Claude Code features, such as "Use Plan Mode to prepare for a complex request before making changes. Press Shift+Tab twice to enable." Set this key to false to hide them. Appears in /config as Show tips.',scope:"any"},{key:"spinnerTipsOverride",group:"Interface and terminal",type:"object with tips, tipsFile, label, and excludeDefault fields, each optional",default:"unset, so Claude Code shows only the built-in tips",description:"Add your own tips to the spinner tips that Claude Code shows while Claude works, or replace the built-in tips with yours. Claude Code puts your tips in the same rotation as the built-in ones. If you set spinnerTipsEnabled to false, Claude Code hides all tips, yours included.",scope:"any"},{key:"spinnerTipsOverride.tips",group:"Interface and terminal",type:"string",description:"spinnerTipsOverride: object with tips, tipsFile, label, and excludeDefault fields, each optional",scope:"any",nested:!0},{key:"spinnerTipsOverride.tipsFile",group:"Interface and terminal",type:"string",description:"spinnerTipsOverride: object with tips, tipsFile, label, and excludeDefault fields, each optional",scope:"any",nested:!0},{key:"spinnerTipsOverride.label",group:"Interface and terminal",type:"string",description:"spinnerTipsOverride: object with tips, tipsFile, label, and excludeDefault fields, each optional",scope:"any",nested:!0},{key:"spinnerTipsOverride.excludeDefault",group:"Interface and terminal",type:"string",description:"spinnerTipsOverride: object with tips, tipsFile, label, and excludeDefault fields, each optional",scope:"any",nested:!0},{key:"spinnerVerbs",group:"Interface and terminal",type:"object with a verbs array of strings and mode",default:"unset, so Claude Code uses the built-in verbs",description:'While a turn is in progress, the spinner shows a rotating verb such as "Accomplishing", "Architecting", or "Baking". Use this key to add your own verbs to that rotation or replace the built-in list with yours.',scope:"any"},{key:"spinnerVerbs.verbs",group:"Interface and terminal",type:"array of strings",description:"spinnerVerbs: object with a verbs array of strings and mode",scope:"any",nested:!0},{key:"spinnerVerbs.mode",group:"Interface and terminal",type:"enum",options:["append","replace"],description:"spinnerVerbs: object with a verbs array of strings and mode",scope:"any",nested:!0},{key:"statusLine",group:"Interface and terminal",type:'object with type set to "command" and a command string, plus optional padding as a number of charact\u2026',default:"unset, so no status line",description:"Run your own command to render a status line below the prompt with context such as the model, cost, or git branch. Optional fields adjust spacing, add periodic re-runs, and hide the built-in vim mode indicator when your script renders vim.mode itself.",scope:"any"},{key:"statusLine.type",group:"Interface and terminal",type:"string",description:'statusLine: object with type set to "command" and a command string, plus optional padding as a number of characters, refreshInterval as a number of seconds, minimum 1, and hideVimModeIndicator as a Boolean',scope:"any",nested:!0},{key:"statusLine.command",group:"Interface and terminal",type:"string",description:'statusLine: object with type set to "command" and a command string, plus optional padding as a number of characters, refreshInterval as a number of seconds, minimum 1, and hideVimModeIndicator as a Boolean',scope:"any",nested:!0},{key:"statusLine.padding",group:"Interface and terminal",type:"number",description:'statusLine: object with type set to "command" and a command string, plus optional padding as a number of characters, refreshInterval as a number of seconds, minimum 1, and hideVimModeIndicator as a Boolean',scope:"any",nested:!0},{key:"statusLine.refreshInterval",group:"Interface and terminal",type:"number",description:'statusLine: object with type set to "command" and a command string, plus optional padding as a number of characters, refreshInterval as a number of seconds, minimum 1, and hideVimModeIndicator as a Boolean',scope:"any",nested:!0},{key:"statusLine.1",group:"Interface and terminal",type:"string",description:'statusLine: object with type set to "command" and a command string, plus optional padding as a number of characters, refreshInterval as a number of seconds, minimum 1, and hideVimModeIndicator as a Boolean',scope:"any",nested:!0},{key:"statusLine.hideVimModeIndicator",group:"Interface and terminal",type:"Boolean",description:'statusLine: object with type set to "command" and a command string, plus optional padding as a number of characters, refreshInterval as a number of seconds, minimum 1, and hideVimModeIndicator as a Boolean',scope:"any",nested:!0},{key:"subagentStatusLine",group:"Interface and terminal",type:'object with type set to "command" and a command string',default:"unset, so Claude Code renders the default rows",description:"When Claude runs subagents, Claude Code lists them in a task display below the prompt, one row per subagent showing name \xB7 description \xB7 token count. This key lets you run your own command to rewrite those rows, for example to show each subagent's context usage as a percentage. On each refresh\u2026",scope:"any"},{key:"subagentStatusLine.type",group:"Interface and terminal",type:"string",description:'subagentStatusLine: object with type set to "command" and a command string',scope:"any",nested:!0},{key:"subagentStatusLine.command",group:"Interface and terminal",type:"string",description:'subagentStatusLine: object with type set to "command" and a command string',scope:"any",nested:!0},{key:"syntaxHighlightingDisabled",group:"Interface and terminal",type:"Boolean",default:"false",description:"Claude Code colors code by language in the diffs, code blocks, and file previews it shows in the terminal, with its built-in highlighter; no plugin or language server is involved. Set this key to true to show them as plain text instead, for example if the colors clash with your terminal theme or slow a screen reader.",scope:"any"},{key:"terminalProgressBarEnabled",group:"Interface and terminal",type:"Boolean",default:"true",description:"Some terminals can show a progress indicator on the tab or in the taskbar for the program running in them. While Claude is working, Claude Code reports an in-progress state to the terminal, so you can see from another tab or window whether the session is still busy\u2026",scope:"any"},{key:"terminalTitleFromRename",group:"Interface and terminal",type:"Boolean",default:"true",description:"Claude Code sets your terminal tab's title. By default it uses a title it generates from the conversation, and once you give the session a name with /rename or --name, the tab shows that name instead. Set this key to false to keep the generated title on the tab even after you name the session\u2026",scope:"any"},{key:"theme",group:"Interface and terminal",type:"string",options:["auto","dark","light","dark-daltonized","light-daltonized","dark-ansi","light-ansi"],default:'"dark"',description:"Pick the color theme for the interface. Appears in /config as Theme.",scope:"any"},{key:"timeFormat",group:"Interface and terminal",type:"string",options:["auto","12-hour","24-hour","24-hour-utc"],default:'"auto"',description:"Choose how Claude Code writes the times it shows in the interface, such as the done 6:05 PM at the end of each turn duration message and the timestamps in the transcript viewer. To pick a preset, run /config and set Time format. Requires Claude Code v2.1.257 or later.",scope:"any"},{key:"timeZone",group:"Interface and terminal",type:"string, an IANA time zone name. When Claude Code doesn't recognize the name\u2026",default:"unset, so times show in your system time zone",description:`Show the times in the interface in a time zone other than your system's. Set it to an IANA time zone name, such as "UTC" or "Europe/Dublin". The times that timeFormat controls then show in this zone. If timeFormat is "24-hour-utc", times stay in UTC and Claude Code ignores this key. /config has no row for this key\u2026`,scope:"any"},{key:"tui",group:"Interface and terminal",type:"string",options:["default","fullscreen"],default:"unset, so Claude Code picks the renderer for you",description:'Choose the terminal UI renderer. Use "fullscreen" for the flicker-free alt-screen renderer with virtualized scrollback, or "default" for the classic main-screen renderer. Running /tui fullscreen or /tui default writes this key for you.',scope:"any"},{key:"verbose",group:"Interface and terminal",type:"Boolean",default:"false",description:"By default, the transcript collapses each tool call to a short summary, such as the command Claude ran and a line count of its output, and you press Ctrl+O to switch the whole transcript to the expanded view when you want the details\u2026",scope:"any"},{key:"viewMode",group:"Interface and terminal",type:"string",options:["default","verbose","focus"],default:"unset, so the verbose setting and your last /focus choice apply",description:'Set the transcript view Claude Code starts in: "default", "verbose", or "focus". When set, it overrides both the sticky /focus selection and the verbose setting.',scope:"any"},{key:"vimInsertModeRemaps",group:"Interface and terminal",type:'object mapping a two-character sequence to "<Esc>"',default:"unset",description:'Map two-key INSERT-mode sequences to Escape in vim editor mode. Each key is exactly two printable characters typed in sequence, and "<Esc>" is the only supported target; Claude Code ignores other entries.',scope:"any",shape:"map",fields:[{name:"<Esc>",type:"string"}]},{key:"voice",group:"Interface and terminal",type:"object with enabled as a Boolean, autoSubmit as a Boolean that applies in hold mode only, and mode",default:'unset, so dictation is off; when enabled is true and mode is unset, Claude Code uses "hold"',description:"Turn on voice dictation and choose how the dictation key behaves. Claude Code writes this object for you when you run /voice.",scope:"any"},{key:"voice.enabled",group:"Interface and terminal",type:"Boolean",description:"voice: object with enabled as a Boolean, autoSubmit as a Boolean that applies in hold mode only, and mode",scope:"any",nested:!0},{key:"voice.autoSubmit",group:"Interface and terminal",type:"Boolean",description:"voice: object with enabled as a Boolean, autoSubmit as a Boolean that applies in hold mode only, and mode",scope:"any",nested:!0},{key:"voice.mode",group:"Interface and terminal",type:"enum",options:["hold","tap"],description:"voice: object with enabled as a Boolean, autoSubmit as a Boolean that applies in hold mode only, and mode",scope:"any",nested:!0},{key:"voiceEnabled",group:"Interface and terminal",type:"Boolean",default:"unset",description:"> [!WARNING] > > Deprecated since v2.1.92, when the voice object replaced it. Claude Code still reads it so older settings files keep working, but new configurations should set voice.enabled. Turn voice dictation on with the single Boolean form that predates the voice object. When both are set, voice.enabled applies.",scope:"any",deprecated:!0},{key:"wheelScrollAccelerationEnabled",group:"Interface and terminal",type:"Boolean",default:"true",description:"Accelerate mouse-wheel scroll speed during fast scrolls in fullscreen rendering. Set it to false for a constant scroll rate per wheel notch.",scope:"any"},{key:"attribution",group:"Git and attribution",type:"object with commit and pr strings and a sessionUrl Boolean, or false to hide all attribution. The fa\u2026",default:"unset, so Claude Code uses the standard attribution shown under each sub-key",description:"Customize the attribution Claude Code adds to git commits and pull requests. Commits get a git trailer such as Co-Authored-By by default; pull request descriptions get plain text. Set each part separately with the sub-keys below.",scope:"any"},{key:"attribution.commit",group:"Git and attribution",type:"string",default:"unset, so Claude Code adds Co-Authored-By: <name> <noreply@anthropic.com>. The name is the model in use when the commit is made, such as Claude Sonnet 5. When a subagent makes the commit, the trailer names the subagent's model.",description:"Set the attribution text Claude Code adds to git commits, including any trailers. Set it to an empty string to hide commit attribution.",scope:"any"},{key:"attribution.pr",group:"Git and attribution",type:"string",default:"unset, so Claude Code adds \u{1F916} Generated with Claude Code",description:"Set the attribution text Claude Code adds to pull request descriptions. Set it to an empty string to hide pull request attribution.",scope:"any"},{key:"attribution.sessionUrl",group:"Git and attribution",type:"Boolean",default:"true",description:"Choose whether Claude Code appends the claude.ai session link when it commits or opens a pull request from a cloud or Remote Control session. Claude Code adds the link as a Claude-Session trailer on commits and as a link in pull request descriptions. Set it to false to omit the link.",scope:"any"},{key:"attribution.false",group:"Git and attribution",type:"string",description:"attribution: object with commit and pr strings and a sessionUrl Boolean, or false to hide all attribution. The false value requires Claude Code v2.1.281 or later; earlier versions reject it and skip the whole user, project, or local settings file that holds it",scope:"any",nested:!0},{key:"includeCoAuthoredBy",group:"Git and attribution",type:"Boolean",default:"true",description:"> [!WARNING] > > Deprecated since v2.0.62, when attribution replaced it. Claude Code still reads it, but new configurations should set attribution. Use attribution instead, which replaces this key and lets you change or hide the commit trailer, the pull request text, and the session link separately\u2026",scope:"any",deprecated:!0},{key:"includeGitInstructions",group:"Git and attribution",type:"Boolean",default:"true",description:"Claude Code gives Claude two git-related pieces of context: its built-in instructions for how to write commits and pull requests, in the Bash tool's description, and a git status snapshot of your repository. The snapshot holds the current branch, the main branch, git status output, and recent commits\u2026",scope:"any"},{key:"prUrlTemplate",group:"Git and attribution",type:"string, a URL template using any of the five placeholders",default:"unset",description:"Point the PR links Claude Code renders, in the footer badge and in tool-result summaries, at an internal code-review tool instead of github.com. Claude Code substitutes {host}, {owner}, {repo}, {number}, and {url} from the PR URL. GitLab merge request links on both surfaces keep their GitLab URL.",scope:"any"},{key:"allowedHttpHookUrls",group:"Hooks and automation",type:"array of URL patterns, with * as a wildcard",default:"unset, so any URL is allowed",description:"Limit which URLs HTTP hooks can target. When you define this key, Claude Code runs an HTTP hook only if its URL matches one of the patterns and blocks the rest without running them; an empty array blocks every HTTP hook.",scope:"any",shape:"array",valueType:"string"},{key:"allowManagedHooksOnly",group:"Hooks and automation",type:"Boolean",default:"unset, so hooks from every settings scope and plugin run",description:"Restrict hook execution to hooks your organization deploys.",scope:"managed"},{key:"disableAllHooks",group:"Hooks and automation",type:"Boolean",default:"unset, so hooks run",description:"Turn off hooks, any custom status line, and any custom file suggestion command. Use it to turn all of these off temporarily without deleting them from your settings.",scope:"any"},{key:"disableWorkflows",group:"Hooks and automation",type:"Boolean",default:"false",description:"Turn off dynamic workflows and the bundled workflow commands for everyone your settings reach, such as an organization through managed settings. To turn workflows on or off just for yourself, use enableWorkflows instead, which the Dynamic workflows toggle in /config writes to your user settings.",scope:"any"},{key:"enableWorkflows",group:"Hooks and automation",type:"Boolean",default:"unset, so workflows are on unless you're on the Pro plan, where they're off",description:"Turn dynamic workflows on or off for yourself when your plan's default isn't what you want. Appears in /config as Dynamic workflows, which writes this key to your user settings and removes it again when you toggle back to your plan's default. To turn workflows off for everyone from managed settings\u2026",scope:"any"},{key:"hooks",group:"Hooks and automation",type:'object keyed by hook event; each value is an array of { "matcher"\u2026',default:"unset, so no hooks run",description:"Run your own commands, prompts, agents, HTTP requests, or MCP tools as hooks at points in Claude Code's lifecycle, such as before a tool call or when a session starts; the hooks reference lists every event, its payload, and its exit codes. Each event maps to a list of matcher groups\u2026",scope:"any"},{key:'hooks.{ "matcher", "hooks" }',group:"Hooks and automation",type:"string",description:'hooks: object keyed by hook event; each value is an array of { "matcher", "hooks" } groups whose hooks entries have a type of "command", "prompt", "agent", "http", or "mcp_tool"',scope:"any",nested:!0},{key:"hooks.hooks",group:"Hooks and automation",type:"string",description:'hooks: object keyed by hook event; each value is an array of { "matcher", "hooks" } groups whose hooks entries have a type of "command", "prompt", "agent", "http", or "mcp_tool"',scope:"any",nested:!0},{key:"hooks.type",group:"Hooks and automation",type:"string",description:'hooks: object keyed by hook event; each value is an array of { "matcher", "hooks" } groups whose hooks entries have a type of "command", "prompt", "agent", "http", or "mcp_tool"',scope:"any",nested:!0},{key:"hooks.command",group:"Hooks and automation",type:"string",description:'hooks: object keyed by hook event; each value is an array of { "matcher", "hooks" } groups whose hooks entries have a type of "command", "prompt", "agent", "http", or "mcp_tool"',scope:"any",nested:!0},{key:"hooks.prompt",group:"Hooks and automation",type:"string",description:'hooks: object keyed by hook event; each value is an array of { "matcher", "hooks" } groups whose hooks entries have a type of "command", "prompt", "agent", "http", or "mcp_tool"',scope:"any",nested:!0},{key:"hooks.agent",group:"Hooks and automation",type:"string",description:'hooks: object keyed by hook event; each value is an array of { "matcher", "hooks" } groups whose hooks entries have a type of "command", "prompt", "agent", "http", or "mcp_tool"',scope:"any",nested:!0},{key:"hooks.http",group:"Hooks and automation",type:"string",description:'hooks: object keyed by hook event; each value is an array of { "matcher", "hooks" } groups whose hooks entries have a type of "command", "prompt", "agent", "http", or "mcp_tool"',scope:"any",nested:!0},{key:"hooks.mcp_tool",group:"Hooks and automation",type:"string",description:'hooks: object keyed by hook event; each value is an array of { "matcher", "hooks" } groups whose hooks entries have a type of "command", "prompt", "agent", "http", or "mcp_tool"',scope:"any",nested:!0},{key:"httpHookAllowedEnvVars",group:"Hooks and automation",type:"array of environment variable names",default:"unset, so each hook's own allowedEnvVars list applies",description:"An HTTP hook can put the value of an environment variable into a request header, for example an Authorization: Bearer $HOOK_TOKEN header, but only for variables the hook lists in its own allowedEnvVars\u2026",scope:"any",shape:"array",valueType:"string"},{key:"workflowKeywordTriggerEnabled",group:"Hooks and automation",type:"Boolean",default:"true",description:"Choose whether typing the keyword ultracode in a prompt triggers a dynamic workflow. Set it to false to type the word without triggering one.",scope:"any"},{key:"workflowSizeGuideline",group:"Hooks and automation",type:"string",options:["unrestricted","small","medium","large"],default:`"medium", or "small" when you're signed in on a Pro plan with Claude Code v2.1.271 or later`,description:'Set the agent count Claude aims for in the dynamic workflows it writes. Claude Code sends the value to Claude as advice, not an enforced cap: "small" asks for fewer than 5 agents, "medium" fewer than 10, and "large" fewer than 50. Choose "small" when you want to bound what a workflow spends\u2026',scope:"any"},{key:"disableBundledSkills",group:"Plugins and skills",type:"Boolean",default:"unset, so bundled skills load",description:"Turn off the skills and workflows included with Claude Code. Claude Code removes bundled skills and workflows entirely, while built-in commands such as /init stay typable but are hidden from the model.",scope:"any"},{key:"disableSkillShellExecution",group:"Plugins and skills",type:"Boolean",default:"unset, so inline shell runs",description:"Turn off inline shell execution for !... and ! blocks in skills and custom commands from user, project, plugin, or additional-directory sources. Claude Code replaces each command with [shell command execution disabled by policy] instead of running it.",scope:"any"},{key:"skillOverrides",group:"Plugins and skills",type:"object mapping skill name to",default:'unset, so every skill is "on"',description:"Hide or collapse a skill without editing its SKILL.md. Claude Code applies the value under each skill's name to the skill list Claude sees and to your / autocomplete.",scope:"any",shape:"map",valueOptions:["on","name-only","user-invocable-only","off"]},{key:"syncClaudeAiSkills",group:"Plugins and skills",type:"Boolean",default:"unset, so sessions signed in with your claude.ai account sync your skills",description:"Turn off the download of the skills enabled for your claude.ai account. Claude Code downloads them into ~/.claude/skills/synced/ in terminal sessions where you sign in with your claude.ai account, interactive or non-interactive, and in Cowork and cloud sessions\u2026",scope:"any"},{key:"syncClaudeAiPlugins",group:"Plugins and skills",type:"Boolean",default:"unset, so sessions signed in with your claude.ai account sync your plugins",description:"Turn off the download of the plugins enabled for your claude.ai account. Claude Code downloads them into ~/.claude/plugins/synced/ at the start of terminal sessions where you sign in with your claude.ai account and in Cowork sessions, and loads each one as <name>@synced\u2026",scope:"any"},{key:"allowedChannelPlugins",group:"Plugins and skills",type:'array of objects, each with marketplace and plugin strings. An entry can instead be a "plugin@market\u2026',default:"unset, so Claude Code uses the default Anthropic allowlist",description:"Choose which channel plugins can push messages into sessions in your organization. When you set it, Claude Code uses your list in place of the default Anthropic allowlist; each entry names a plugin and the marketplace it comes from.",scope:"managed",shape:"array",valueType:"string"},{key:"blockedMarketplaces",group:"Plugins and skills",type:"array of marketplace source objects, in the same forms as strictKnownMarketplaces",default:"unset, so no marketplace is blocked",description:"Block plugin marketplace sources for your organization. Claude Code checks the blocklist on marketplace add and on plugin install, update, refresh, and auto-update, so a marketplace someone added before you set the policy can't be used to fetch plugins either. Blocked sources are checked before download\u2026",scope:"managed",shape:"array",valueType:"string"},{key:"channelsEnabled",group:"Plugins and skills",type:"Boolean",default:"unset; channels are blocked on Team and Enterprise plans and on Console accounts with managed settings, and allowed on Pro and Max plans and on Console accounts without managed settings",description:"Allow channels for your organization. On claude.ai Team and Enterprise plans, Claude Code blocks channels until you set this to true. For Anthropic Console accounts that authenticate with an API key, channels are allowed by default. If your organization deploys managed settings\u2026",scope:"managed"},{key:"disableCommandPluginSources",group:"Plugins and skills",type:"Boolean",default:"unset, so Claude Code follows allowManagedHooksOnly: an organization that restricts hook execution to managed settings gets command sources disabled too",description:"Block the command plugin source, which installs a plugin by running a marketplace-declared command on the user's machine. When you set it to true, Claude Code never runs the command, doesn't install or update command-sourced plugins, and stops loading the ones already installed\u2026",scope:"managed"},{key:"pluginSuggestionMarketplaces",group:"Plugins and skills",type:"array of marketplace names",default:"unset, so no marketplace-declared suggestions surface",description:"Name the marketplaces whose plugins can appear as contextual install suggestions, in spinner tips and pinned at the top of the /plugin Discover tab. The built-in first-party frontend-design tip is unaffected. Suggestions come from each plugin's relevance declaration in its marketplace entry.",scope:"managed",shape:"array",valueType:"string"},{key:"pluginTrustMessage",group:"Plugins and skills",type:"string",default:"unset, so Claude Code shows the standard warning alone",description:"Add your organization's own text to the plugin trust warning Claude Code shows before installation, for example to confirm that plugins from your internal marketplace are vetted.",scope:"managed"},{key:"strictKnownMarketplaces",group:"Plugins and skills",type:"array of marketplace source objects; see Allowed source types",default:"unset, so users can add any marketplace. An empty array is a complete lockdown that blocks every marketplace source, including the official Anthropic marketplace",description:"Restrict which plugin marketplace sources people in your organization can add and install plugins from. Claude Code enforces the allowlist on marketplace add and on plugin install, update, refresh, and auto-update, before any network or filesystem operation\u2026",scope:"managed",shape:"array",valueType:"string"},{key:"strictPluginOnlyCustomization",group:"Plugins and skills",type:'true to lock all four kinds of customization, or an array naming the kinds to lock, from "skills"\u2026',default:"unset, so nothing is locked",description:"Block skills, agents, hooks, and MCP servers from user and project sources, so they can come only from plugins or managed settings. Combine it with strictKnownMarketplaces to control the full customization supply chain: the marketplace allowlist controls which plugins users can install.",scope:"managed"},{key:"strictPluginOnlyCustomization.skills",group:"Plugins and skills",type:'the string "skills" in the strictPluginOnlyCustomization array',default:"not locked",description:"Lock the skills surface. Claude Code stops loading skills from ~/.claude/skills/ and .claude/skills/, custom commands from ~/.claude/commands/ and .claude/commands/, skills and commands under --add-dir directories, and skills synced from your claude.ai account. It keeps loading plugin skills, bundled skills\u2026",scope:"managed"},{key:"strictPluginOnlyCustomization.agents",group:"Plugins and skills",type:'the string "agents" in the strictPluginOnlyCustomization array',default:"not locked",description:"Lock the agents surface. Claude Code stops loading agents from ~/.claude/agents/, .claude/agents/, and --add-dir directories. It keeps loading plugin agents, built-in agents, and agents in the managed policy directory.",scope:"managed"},{key:"strictPluginOnlyCustomization.hooks",group:"Plugins and skills",type:'the string "hooks" in the strictPluginOnlyCustomization array',default:"not locked",description:"Lock the hooks surface: * Stops running: * Hooks from user, project, and local settings.json * Frontmatter hooks in skills, custom commands, and agents, from the sources that a skills or agents lock would block * Keeps running: plugin hooks and hooks in managed settings Skills, custom commands\u2026",scope:"managed"},{key:"strictPluginOnlyCustomization.mcp",group:"Plugins and skills",type:'the string "mcp" in the strictPluginOnlyCustomization array',default:"not locked",description:"Lock the mcp surface. Claude Code stops loading MCP servers from ~/.claude.json and .mcp.json, and keeps loading plugin MCP servers, managed-mcp.json servers, and servers from managedMcpServers.",scope:"managed"},{key:"enabledPlugins",group:"Plugins and skills",type:"object mapping plugin-name@marketplace-name to a Boolean",default:"unset, so each plugin follows its defaultEnabled value",description:"Turn individual plugins on or off, keyed by plugin-name@marketplace-name. A plugin with no entry at any scope falls back to its defaultEnabled value. When you enable or disable a plugin with /plugin or claude plugin enable, Claude Code writes this key for you.",scope:"any",shape:"map",valueType:"Boolean"},{key:"extraKnownMarketplaces",group:"Plugins and skills",type:"object mapping a marketplace name to an object with a source object and an optional autoUpdate Boole\u2026",default:"unset",description:"Register additional plugin marketplaces by name, so that people who open the repository, or everyone your managed settings reach, get the marketplace without adding it themselves. Claude Code registers each marketplace it doesn't already know\u2026",scope:"any",shape:"map",fields:[{name:"source",type:"string"},{name:"autoUpdate",type:"Boolean"}]},{key:"pluginConfigs",group:"Plugins and skills",type:"object mapping a plugin ID to an object with an options field\u2026",default:"unset",description:"Store the non-sensitive answers you give a plugin's userConfig configuration dialog, keyed by plugin ID. Claude Code writes this key to your user settings when you fill in the dialog, so you don't need to edit it by hand. Claude Code stores sensitive options in the macOS Keychain instead\u2026",scope:"any",shape:"map",fields:[{name:"options",type:"string"},{name:"mcpServers",type:"string"}]},{key:"prependPlugins",group:"Plugins and skills",type:"array of plugin-name@marketplace-name strings",default:"unset",description:"List the managed plugins whose mods run before every mod a user installs, in the listed order. When you set this key in managed settings, name sec-default@builtin in the list to keep the built-in guard. In managed settings, Claude Code skips an id whose plugin doesn't count as your organization's\u2026",scope:"any",shape:"array",valueType:"string"},{key:"appendPlugins",group:"Plugins and skills",type:"array of plugin-name@marketplace-name strings",default:"unset",description:"List the managed plugins whose mods run after every mod a user installs, in the listed order. An id listed in both prependPlugins and appendPlugins is prepended. In managed settings, Claude Code skips an id whose plugin doesn't count as your organization's.",scope:"any",shape:"array",valueType:"string"},{key:"allowAllClaudeAiMcps",group:"MCP",type:"Boolean",default:"false, so a deployed managed-mcp.json suppresses the claude.ai connectors Claude Code fetches itself",description:"Load the claude.ai connectors Claude Code fetches itself alongside a deployed managed-mcp.json. Without this key, managed-mcp.json takes exclusive control of MCP servers and suppresses those connectors.",scope:"managed"},{key:"allowClaudeInChromeWithManagedMcp",group:"MCP",type:"Boolean",default:"false, so a deployed managed-mcp.json blocks Claude in Chrome in terminal sessions",description:"Let the built-in Claude in Chrome server run alongside a deployed managed-mcp.json. Without this key, a deployed managed-mcp.json blocks Claude in Chrome in terminal sessions. Requires Claude Code v2.1.282 or later.",scope:"managed"},{key:"allowedMcpServers",group:"MCP",type:"array of objects, each with exactly one key: serverName, a string limited to letters, numbers\u2026",default:"unset, so every server is allowed; an empty array blocks every server users add",description:"Allowlist the MCP servers people can add. Claude Code blocks any server that doesn't match an entry wherever it's defined, including plugin servers, servers a user passes with --mcp-config, and servers from claude.ai. Built-in servers such as Claude in Chrome\u2026",scope:"any",shape:"array",valueType:"array of strings"},{key:"allowManagedMcpServersOnly",group:"MCP",type:"Boolean",default:"false, so allowlists from every settings scope merge",description:"Make the managed allowlist the only one that applies. Claude Code then reads allowedMcpServers from managed settings alone and ignores allowlists in user, project, and local settings; deniedMcpServers still merges from every settings scope, so users can still block servers for themselves\u2026",scope:"managed"},{key:"deniedMcpServers",group:"MCP",type:"array of objects, each with exactly one key: serverName, a string\u2026",default:"unset, so no server is blocked; an empty array also blocks nothing",description:`Block specific MCP servers. Claude Code refuses to load a matching server wherever it's defined, including plugin servers, servers passed with --mcp-config, servers from managed-mcp.json, servers from managedMcpServers, and the claude.ai connectors it fetches itself. In-process type: "sdk" servers are exempt\u2026`,scope:"any",shape:"array",valueType:"string"},{key:"disableClaudeAiConnectors",group:"MCP",type:"Boolean",default:"false, so Claude Code fetches your connectors",description:"Turn off the claude.ai MCP connectors Claude Code fetches itself, so it neither fetches nor connects them. A true in any settings file applies: a checked-in project .claude/settings.json can opt a repository out of those connectors, but a project-level false can't override a user- or managed-level true.",scope:"any"},{key:"disabledMcpjsonServers",group:"MCP",type:"array of strings, the server names as they appear in .mcp.json",default:"unset",description:"Reject specific servers defined in a project's .mcp.json file so Claude Code never connects them or asks you to approve them. A rejection in any settings file applies, including a project .claude/settings.json checked into the repository.",scope:"any",shape:"array",valueType:"string"},{key:"enableAllProjectMcpServers",group:"MCP",type:"Boolean",default:"unset, so Claude Code asks you to approve each server",description:"Approve every MCP server defined in project .mcp.json files without a prompt. Claude Code writes this key to .claude/settings.local.json when you choose to approve all servers in the approval dialog.",scope:"any"},{key:"enabledMcpjsonServers",group:"MCP",type:"array of strings, the server names as they appear in .mcp.json",default:"unset",description:"Approve specific servers defined in project .mcp.json files so Claude Code connects them without asking. Claude Code writes this key to .claude/settings.local.json when you approve a server in the approval dialog.",scope:"any",shape:"array",valueType:"string"},{key:"managedMcpServers",group:"MCP",type:"object keyed by server name. Each entry has the .mcp.json shape for an http or sse server: a require\u2026",default:"unset, so managed settings provide no servers",description:"Provide remote MCP servers to every user from managed settings. Users keep the servers they add themselves and can't edit or remove the ones you provide. Requires Claude Code v2.1.259 or later.",scope:"managed"},{key:"managedMcpServers..mcp.json",group:"MCP",type:"string",description:"managedMcpServers: object keyed by server name. Each entry has the .mcp.json shape for an http or sse server: a required https:// url, and optionally headers, oauth, and the other HTTP and SSE options. Claude Code drops entries that fail validation, and What an entry can contain lists the conditions",scope:"any",nested:!0},{key:"managedMcpServers.http",group:"MCP",type:"string",description:"managedMcpServers: object keyed by server name. Each entry has the .mcp.json shape for an http or sse server: a required https:// url, and optionally headers, oauth, and the other HTTP and SSE options. Claude Code drops entries that fail validation, and What an entry can contain lists the conditions",scope:"any",nested:!0},{key:"managedMcpServers.sse",group:"MCP",type:"string",description:"managedMcpServers: object keyed by server name. Each entry has the .mcp.json shape for an http or sse server: a required https:// url, and optionally headers, oauth, and the other HTTP and SSE options. Claude Code drops entries that fail validation, and What an entry can contain lists the conditions",scope:"any",nested:!0},{key:"managedMcpServers.https://",group:"MCP",type:"string",description:"managedMcpServers: object keyed by server name. Each entry has the .mcp.json shape for an http or sse server: a required https:// url, and optionally headers, oauth, and the other HTTP and SSE options. Claude Code drops entries that fail validation, and What an entry can contain lists the conditions",scope:"any",nested:!0},{key:"managedMcpServers.url",group:"MCP",type:"string",description:"managedMcpServers: object keyed by server name. Each entry has the .mcp.json shape for an http or sse server: a required https:// url, and optionally headers, oauth, and the other HTTP and SSE options. Claude Code drops entries that fail validation, and What an entry can contain lists the conditions",scope:"any",nested:!0},{key:"managedMcpServers.headers",group:"MCP",type:"string",description:"managedMcpServers: object keyed by server name. Each entry has the .mcp.json shape for an http or sse server: a required https:// url, and optionally headers, oauth, and the other HTTP and SSE options. Claude Code drops entries that fail validation, and What an entry can contain lists the conditions",scope:"any",nested:!0},{key:"managedMcpServers.oauth",group:"MCP",type:"string",description:"managedMcpServers: object keyed by server name. Each entry has the .mcp.json shape for an http or sse server: a required https:// url, and optionally headers, oauth, and the other HTTP and SSE options. Claude Code drops entries that fail validation, and What an entry can contain lists the conditions",scope:"any",nested:!0},{key:"agent",group:"Agents, sessions, and worktrees",type:"string, the name of a built-in or custom agent",default:"unset, so the main thread runs as Claude Code's default agent",description:"Run the main thread as a named subagent, so Claude Code applies that subagent's system prompt, tool restrictions, and model to your session. The same key sets the default agent for sessions you dispatch from claude agents.",scope:"any"},{key:"crossSessionInbound",group:"Agents, sessions, and worktrees",type:"string",options:["accept","hold","refuse"],default:"unset, so Claude Code decides per message",description:"Choose what this session does with messages arriving from your other Claude Code sessions. When no value applies, Claude Code decides per message from the two sessions' permission-mode classes. Requires Claude Code v2.1.224 or later.",scope:"any"},{key:"disableAgentView",group:"Agents, sessions, and worktrees",type:"Boolean",default:"unset, so agent view is available",description:"Turn off background agents and agent view: claude agents, --bg, /background, and the on-demand supervisor. Set it in managed settings to enforce it for an organization.",scope:"any"},{key:"isolatePeerMachines",group:"Agents, sessions, and worktrees",type:"Boolean",default:"unset, so cross-machine messages don't prompt",description:"Require your explicit approval before Claude's SendMessage reaches one of your sessions beyond this machine; see Require approval for cross-machine messages. The approval prompt appears even in bypassPermissions mode.",scope:"any"},{key:"processWrapper",group:"Agents, sessions, and worktrees",type:"string, the launcher command as an argv prefix, such as an absolute path with optional arguments",default:"unset, so background processes start unwrapped",description:"On macOS and Linux, place a corporate launcher command in front of the background processes Claude Code starts. Claude Code runs the launcher with its own command line appended, so the launcher must exec into Claude Code; see Run Claude Code behind a corporate launcher for the launcher contract\u2026",scope:"any"},{key:"teammateMode",group:"Agents, sessions, and worktrees",type:"string",options:["in-process","auto","tmux","iterm2"],default:'"in-process"',description:"Choose where Claude Code shows agent team teammates: inside your main terminal pane, or in split panes when your terminal supports them. See Choose a display mode.",scope:"any"},{key:"worktree",group:"Agents, sessions, and worktrees",type:"object with baseRef, symlinkDirectories, sparsePaths, and bgIsolation",default:"unset",description:"Configure how Claude Code creates and manages git worktrees for --worktree, the EnterWorktree tool, and isolated subagents and background sessions.",scope:"any"},{key:"worktree.baseRef",group:"Agents, sessions, and worktrees",type:"string",options:["fresh","head"],default:'"fresh"',description:'Choose which ref new worktrees branch from. "fresh" branches from origin/<default-branch> for a clean tree matching the remote; "head" branches from your current local HEAD, so unpushed commits and feature-branch state are present in the worktree.',scope:"any"},{key:"worktree.symlinkDirectories",group:"Agents, sessions, and worktrees",type:"array of strings, directory paths relative to the repository root",default:"unset, so Claude Code symlinks no directories",description:"Symlink directories from the main repository into each worktree so you don't duplicate large directories on disk.",scope:"any",shape:"array",valueType:"string"},{key:"worktree.sparsePaths",group:"Agents, sessions, and worktrees",type:"array of strings, directory paths relative to the repository root",default:"unset, so each worktree checks out the whole tree",description:"Check out only the listed directories in each worktree through git sparse-checkout. Claude Code writes only those directories plus root-level files to disk, which is faster in large monorepos; see Check out only the directories you need.",scope:"any",shape:"array",valueType:"string"},{key:"worktree.bgIsolation",group:"Agents, sessions, and worktrees",type:"string",options:["worktree","none"],default:'"worktree"',description:'Choose how background sessions isolate their file edits. If you moved a session to the background with \u2190 or /background, that session edits files in place whatever this key says. With "worktree", Claude Code blocks Edit and Write in the main checkout until the session calls EnterWorktree; with "none"\u2026',scope:"any"},{key:"worktree.location",group:"Agents, sessions, and worktrees",type:"string, an absolute path or one that starts with ~/",default:"unset, so worktrees go inside the project",description:"Choose the folder on a remote machine where Desktop SSH sessions create their worktrees, instead of <project-root>/.claude/worktrees/. Only the desktop app reads this key: --worktree, the EnterWorktree tool, isolated subagents, and background sessions ignore it. Requires Claude Desktop v1.44121.0 or later.",scope:"user"},{key:"agentPushNotifEnabled",group:"Remote, desktop, and notifications",type:"Boolean",default:"false",description:"Allow Claude to send a push notification to your phone when it decides one is worth sending, for example when a long task finishes. Claude Code syncs this choice to your account, and pushes arrive while Remote Control is connected. Appears in /config as Push when Claude decides.",scope:"any"},{key:"awaySummaryEnabled",group:"Remote, desktop, and notifications",type:"Boolean",default:"unset, so the recap is on",description:"Show a one-line session recap when you return to the terminal after a few minutes away. Set it to false, or turn off Session recap in /config, to stop the recap.",scope:"any"},{key:"disableArtifact",group:"Remote, desktop, and notifications",type:"Boolean",default:"unset, so the tool follows your account's availability",description:"> [!WARNING] > > Deprecated, and replaced by enableArtifact. Claude Code still honors disableArtifact: true as equivalent to enableArtifact: false, and ignores disableArtifact: false. Use enableArtifact instead to turn off the Artifact tool, which publishes session output as a private web page on claude.ai\u2026",scope:"any",deprecated:!0},{key:"disableDeepLinkRegistration",group:"Remote, desktop, and notifications",type:'the string "disable"',default:"unset, so Claude Code registers the handler",description:"Stop Claude Code from registering the claude-cli:// protocol handler with the operating system, which it otherwise does after you send the first prompt of an interactive session. Deep links let external tools open a Claude Code session with a pre-filled prompt\u2026",scope:"any"},{key:"disableDesktopLocalSessions",group:"Remote, desktop, and notifications",type:"Boolean",default:"unset, so local sessions are available",description:"Turn off Code sessions that run on the device in the desktop app, for deployments where developers should work on remote machines over SSH. With the key set to true, users see this in the Code tab: * Environment selector: the entry for the user's computer is grayed out and unselectable\u2026",scope:"managed"},{key:"disableRemoteControl",group:"Remote, desktop, and notifications",type:"Boolean",default:"false",description:"Turn off Remote Control: Claude Code then refuses claude remote-control, the --remote-control flag, auto-start, and the in-session toggle, and reports that your organization's policy disabled it. Place it in managed settings for per-device MDM enforcement.",scope:"any"},{key:"enableArtifact",group:"Remote, desktop, and notifications",type:"Boolean",default:"unset, so the tool follows your account's availability",description:"Turn off the Artifact tool, which publishes session output as a private web page on claude.ai. When you turn the Artifacts row off in /config, Claude Code writes this key to your user settings, so you don't usually edit it by hand.",scope:"any"},{key:"inputNeededNotifEnabled",group:"Remote, desktop, and notifications",type:"Boolean",default:"false",description:"Get a push notification on your phone when a permission prompt or question is waiting for your input. Claude Code sends these only while Remote Control is connected. Appears in /config as Push when actions required.",scope:"any"},{key:"preferredNotifChannel",group:"Remote, desktop, and notifications",type:"string",options:["auto","terminal_bell","iterm2","iterm2_with_bell","kitty","ghostty","notifications_disabled"],default:'"auto"',description:"Choose how Claude Code notifies you when a task completes or a permission prompt is waiting. A mod's notifications use the same setting. Appears in /config as Local notifications.",scope:"any"},{key:"remote.defaultEnvironmentId",group:"Remote, desktop, and notifications",type:"string, an environment ID such as env_... or ccpool_...",default:"unset, so Claude Code uses the Anthropic-hosted environment when your list has one, and otherwise the first environment in your list that isn't a Remote Control bridge environment, or the first environment when every one is a bridge environment",description:"Pick the default cloud environment for cloud sessions you create from the CLI, such as with claude --cloud. Claude Code writes this key to your user settings when you pick an environment with /remote-env.",scope:"any"},{key:"remoteControlAtStartup",group:"Remote, desktop, and notifications",type:"Boolean",default:"unset, so the auto-connect default applies",description:"Connect Remote Control automatically when each interactive session starts, instead of waiting for /remote-control. Set it to true to turn auto-connect on, false to turn it off. Appears in /config as Enable Remote Control for all sessions.",scope:"any"},{key:"sshConfigs",group:"Remote, desktop, and notifications",type:"array of objects, each with required id, name, and sshHost and optional sshPort and sshIdentityFile",default:"unset",description:"Add SSH connections to the Desktop environment selector. Administrators use sshConfigs to distribute shared connections to a team. Users can select a managed connection and set their own Worktree folder for it. They can't edit its other fields or delete it in the app.",scope:"any",shape:"array",valueType:"string"},{key:"sshHostAllowlist",group:"Remote, desktop, and notifications",type:"array of hostname patterns",default:"unset, so any host is allowed",description:"Limit the hosts a Desktop SSH session can connect to. Only the Desktop app reads this key; the CLI doesn't. Patterns are case-insensitive: * matches any host, *.example.com matches example.com and every subdomain, and anything else is an exact match against the hostname after ~/.ssh/config resolution\u2026",scope:"managed",shape:"array",valueType:"string"},{key:"allowedProviders",group:"Authentication and providers",type:"array of strings, each",default:"unset, so any provider can be used",description:"List the services a machine may reach Claude through, such as the Anthropic API, Amazon Bedrock, or an LLM gateway. A session on a provider that isn't listed is refused at startup, at login, and when it next contacts the API, so switching to an unlisted provider mid-session is refused too\u2026",scope:"managed",shape:"array",valueOptions:["anthropic","bedrock","vertex","foundry","anthropicAws","mantle","customEndpoint","gateway"]},{key:"apiKeyHelper",group:"Authentication and providers",type:"string, a shell command line",default:"unset, so Claude Code doesn't run a helper",description:"Run your own command to produce the credential Claude Code sends with model requests. Claude Code runs the command through the system shell, /bin/sh on macOS and Linux and cmd on Windows, and sends its output as both the X-Api-Key and Authorization: Bearer headers. Use it for dynamic or rotating credentials\u2026",scope:"any"},{key:"awsAuthRefresh",group:"Authentication and providers",type:"string, a shell command line",default:"unset, so Claude Code doesn't refresh AWS credentials for you",description:"Run your own command, such as aws sso login, to refresh the credentials in your .aws directory when the ones Claude Code has for Amazon Bedrock stop working. Claude Code checks the current credentials against STS first and runs the command only when that check fails, then reads the refreshed .aws directory\u2026",scope:"any"},{key:"awsCredentialExport",group:"Authentication and providers",type:"string, a shell command line",default:"unset, so Claude Code uses the ambient AWS credential chain",description:"Run your own command that prints AWS credentials as JSON, so Claude Code can call Amazon Bedrock with credentials that don't live in your .aws directory. Claude Code accepts the aws sts output shape and the flat aws configure export-credentials shape, and scopes the credentials to its own Bedrock client\u2026",scope:"any"},{key:"forceLoginMethod",group:"Authentication and providers",type:"string",options:["claudeai","console","gateway"],default:"unset, so people pick a login method",description:'Restrict which kind of account people can log in with. Set "claudeai" to allow only claude.ai accounts, "console" to allow only Claude Console accounts, or "gateway" to send people to a cloud gateway instead of a first-party login\u2026',scope:"any"},{key:"forceLoginGatewayUrl",group:"Authentication and providers",type:"string, a full URL including the scheme",default:"unset, so the Cloud gateway screen shows an error telling people to contact their IT administrator",description:"Set the gateway URL the /login Cloud gateway screen connects to, so people reach your cloud gateway without typing its address. The screen has no URL field: with this key set, it shows your gateway URL and connects when the person presses Enter; without it, it tells them to contact their IT administrator\u2026",scope:"any"},{key:"forceLoginOrgUUID",group:"Authentication and providers",type:"string, one UUID, or array of strings, several UUIDs",default:"unset, so any organization can log in",description:"From a managed source, require claude.ai account logins to belong to one Anthropic organization, given as a single UUID, or to any of several organizations, given as an array. From any settings file, Claude Code also uses a single UUID to pre-select that organization during a claude.ai or Claude Console login\u2026",scope:"any"},{key:"gatewayInternalNetworks",group:"Authentication and providers",type:"array of strings, at most four IPv4 CIDR blocks, each /8 to /32, not overlapping one another\u2026",default:"unset, so /login accepts only gateways on private addresses",description:"Declare the public IPv4 blocks that your organization numbers its internal network from, so /login accepts a cloud gateway there. Requires Claude Code v2.1.268 or later. Without this key, /login connects to any gateway on a private address and nothing else. With it, /login also accepts a gateway inside a listed block\u2026",scope:"managed",shape:"array",valueType:"string"},{key:"gcpAuthRefresh",group:"Authentication and providers",type:"string, a shell command line",default:"unset, so Claude Code's credential error tells you to run gcloud auth application-default login yourself",description:"Run your own command to refresh Google Cloud Application Default Credentials when Claude Code finds they've expired or can't be loaded, so Google Cloud's Agent Platform requests keep working without you re-authenticating by hand. When several Claude Code processes that use the same command and credentials\u2026",scope:"any"},{key:"otelHeadersHelper",group:"Authentication and providers",type:"string, an executable path or a shell command line",default:"unset, so Claude Code adds no helper-generated headers",description:"Run your own command to generate the headers Claude Code sends with OpenTelemetry exports, for backends whose tokens rotate. Claude Code runs it at startup and periodically after that, and expects a JSON object of string header values on stdout.",scope:"any"},{key:"autoUpdatesChannel",group:"Updates and versioning",type:"string",options:["latest","stable"],default:'unset, so Claude Code follows "latest"',description:'Choose which release channel background auto-updates and claude update follow. Set "stable" for a version that is typically about one week old and skips releases with major regressions, or "latest" for the most recent release.',scope:"any"},{key:"minimumVersion",group:"Updates and versioning",type:`string, a version number such as "2.1.100"; a value that isn't a valid version is ignored`,default:"unset, so updates can install any version the channel offers",description:`Keep background auto-updates and claude update from installing any version below this one, so moving to the "stable" channel doesn't downgrade you from a newer "latest" build. Claude Code writes this key for you when you choose to stay on your current version while switching channels in /config\u2026`,scope:"any"},{key:"requiredMaximumVersion",group:"Updates and versioning",type:`string, a version number such as "2.1.150"; a value that isn't a valid version is ignored`,default:"unset, so no ceiling applies",description:"Set the newest Claude Code version your organization allows to start. When the running version is newer, Claude Code exits at startup and tells the user to install an approved version through your organization's approved method; claude install <version> may also work. Requires Claude Code v2.1.163 or later.",scope:"managed"},{key:"requiredMinimumVersion",group:"Updates and versioning",type:`string, a version number such as "2.1.150"; a value that isn't a valid version is ignored`,default:"unset, so no floor applies",description:"Set the oldest Claude Code version your organization allows to start. When the running version is older, Claude Code exits at startup and tells the user to update through your organization's approved method. The check runs at startup only, so a session that's already running continues\u2026",scope:"managed"},{key:"browserExternalPageTools",group:"Tools",type:'string, "disabled"',options:["disabled","disable"],default:"unset, so Claude's tools work on external pages",description:"Stop Claude from using its tools to read or act on external pages in the desktop app's Browser pane. People in your organization can still open external sites themselves, and local dev server previews keep working with Claude's tools. The desktop app reads this key; the terminal CLI ignores it.",scope:"managed"},{key:"disableBrowserExternalNavigation",group:"Tools",type:"Boolean",default:"unset, so external browsing is on",description:"Turn off external browsing in the desktop app's Browser pane for people and Claude alike. Localhost dev server previews keep working. The desktop app reads this key; the terminal CLI ignores it.",scope:"managed"},{key:"disableMobileSimulatorTools",group:"Tools",type:"Boolean",default:"unset, so Claude's simulator tools follow each person's settings toggle in the desktop app",description:"Block Claude's tools for the desktop app's iOS Simulator pane. People keep manual use of the pane; only Claude's access is removed, and nobody can turn it back on from inside the app. The desktop app reads this key; the terminal CLI ignores it.",scope:"managed"},{key:"cleanupPeriodDays",group:"Privacy and telemetry",type:"number of days, a whole number, minimum 1",default:"30",description:"Set how many days Claude Code keeps session transcripts and other application data before deleting them. Claude Code runs the deletion as a background sweep after a session starts, as long as it can safely determine the retention period. The sweep deletes transcripts without showing a message\u2026",scope:"any"},{key:"desktopSessionCleanupPeriodDays",group:"Privacy and telemetry",type:"number of days, a whole number, minimum 0",default:"0, which sets no age limit",description:"Set an age limit in days for the transcripts of sessions you started or most recently continued in Claude Desktop or Cowork. Without this key, Claude Code keeps those transcripts at any age. Claude Code deletes each one once it's older than both this limit and cleanupPeriodDays\u2026",scope:"any"},{key:"feedbackDrafts",group:"Privacy and telemetry",type:"string",options:["notify","quiet","off"],default:'"notify"',description:"Control Claude-drafted feedback: whether Claude can queue feedback drafts for you to review, and whether Claude Code shows a card when Claude queues one.",scope:"any"},{key:"feedbackSurveyRate",group:"Privacy and telemetry",type:"number between 0 and 1",default:"unset, so Claude Code uses the rate Anthropic sets remotely, or its built-in rate of 0.005 on Amazon Bedrock, Google Cloud's Agent Platform, and Microsoft Foundry, which don't receive remote configuration",description:"Set the probability that the session quality survey appears when a session is eligible for it. Set 0 to keep the survey from appearing.",scope:"any"},{key:"skipWebFetchPreflight",group:"Privacy and telemetry",type:"Boolean",default:"unset, so the check runs before the first fetch to each hostname in a session",description:"Skip the WebFetch domain safety check, which sends each requested hostname to api.anthropic.com before fetching. Set true in environments that block traffic to Anthropic, such as Amazon Bedrock, Google Cloud's Agent Platform, or Microsoft Foundry deployments with restrictive egress.",scope:"any"},{key:"disableSideloadFlags",group:"Enterprise and managed settings",type:"Boolean",default:"false",description:"Reject the --plugin-dir, --plugin-url, --agents, and --mcp-config CLI flags at startup, which users could otherwise pass to bypass strictKnownMarketplaces for a single run. Claude Code exits with an error naming the rejected flags. In cloud sessions\u2026",scope:"managed"},{key:"forceRemoteSettingsRefresh",group:"Enterprise and managed settings",type:"Boolean",default:"false",description:"Block CLI startup until Claude Code has freshly fetched server-managed settings. If the fetch fails, Claude Code exits instead of continuing with cached or no settings. Set it when your environment can't accept even a brief window in which a session runs without its managed policy. When the key is unset\u2026",scope:"managed"},{key:"managedSourcesBehavior",group:"Enterprise and managed settings",type:"string",options:["first-wins","merge"],default:'"first-wins"',description:"Choose whether Claude Code applies only the highest-priority managed source your organization delivers, or combines every admin source it delivers. By default Claude Code takes the highest-priority source that carries a policy key and ignores the rest\u2026",scope:"managed"},{key:"parentSettingsBehavior",group:"Enterprise and managed settings",type:"string",options:["first-wins","merge"],default:'"first-wins"',description:'Choose whether Claude Code applies managed settings supplied by an embedding host process, such as the Agent SDK or an IDE extension, when an admin-deployed managed tier is also present. With "first-wins", Claude Code drops the host-supplied settings; with "merge"\u2026',scope:"managed"},{key:"policyHelper",group:"Enterprise and managed settings",type:"object with path, timeoutMs, and refreshIntervalMs",default:"unset, so no helper runs",description:"Run an executable you deploy that computes managed settings at startup, so you can derive policy from device posture, identity, or a remote service instead of a static file. Claude Code runs the helper before it accepts the first prompt and treats the settings it emits as the managed settings for the session.",scope:"managed"},{key:"policyHelper.path",group:"Enterprise and managed settings",type:"string, an absolute path in normalized form, without . or .. segments; on Windows\u2026",default:"none; required when policyHelper is set",description:"Name the helper executable Claude Code runs. For what happens when the path breaks the rules below, see Helper failures.",scope:"managed"},{key:"policyHelper.timeoutMs",group:"Enterprise and managed settings",type:"integer, milliseconds, minimum 1000",default:"10000",description:"Set how long Claude Code waits for the helper before treating the run as failed. A timed-out run fails the same way as a non-zero exit, so at startup Claude Code refuses to start.",scope:"managed"},{key:"policyHelper.refreshIntervalMs",group:"Enterprise and managed settings",type:"integer, milliseconds: 0 to disable refresh, otherwise at least 60000",default:"unset, so Claude Code runs the helper once at startup",description:"Have Claude Code re-run the helper in the background on an interval so policy changes reach a running session. When a refresh succeeds, its output replaces the previous managed settings without a restart; when a refresh fails, Claude Code keeps the policy it already has.",scope:"managed"},{key:"wslInheritsWindowsSettings",group:"Enterprise and managed settings",type:"Boolean",default:"false, so WSL reads only /etc/claude-code",description:"Have Claude Code on WSL read managed settings from the Windows policy chain, with HKLM and the Windows managed settings file taking priority over /etc/claude-code and HKCU below it. While the chain is on\u2026",scope:"managed"},{key:"autoConnectIde",group:"Global config settings",type:"Boolean",default:"false",description:"Connect to a running IDE automatically when you start Claude Code from an external terminal. Appears in /config as Auto-connect to IDE (external terminal) when you run Claude Code outside a VS Code or JetBrains terminal.",scope:"global"},{key:"autoInstallIdeExtension",group:"Global config settings",type:"Boolean",default:"true",description:"Install the Claude Code IDE extension automatically when you run Claude Code from a VS Code terminal. Appears in /config as Auto-install IDE extension when you run Claude Code inside a VS Code or JetBrains terminal.",scope:"global"},{key:"claudeInChromeDefaultEnabled",group:"Global config settings",type:"Boolean",default:"unset, so Chrome integration is off and Claude Code can still offer to set it up",description:"Start every interactive CLI session with Chrome integration on, without passing --chrome each time. If you run claude remote-control, a session it starts for one of your project threads follows this key too, except in bypassPermissions mode. With Claude Code v2.1.287 or later\u2026",scope:"global"},{key:"copyFullResponse",group:"Global config settings",type:"Boolean",default:"false",description:"Make /copy copy the full response every time, without showing the picker. Selecting Always copy full response in that picker sets this key to true. Appears in /config as Skip the /copy picker.",scope:"global"},{key:"copyOnSelect",group:"Global config settings",type:"Boolean",default:"true",description:"Copy text to your clipboard automatically when you finish selecting it with the mouse in fullscreen rendering or agent view. Appears in /config as Copy on select while fullscreen rendering is on.",scope:"global"},{key:"defaultToAgentsView",group:"Global config settings",type:"Boolean",default:"false",description:"Open agent view instead of a new conversation when you run claude with no arguments. Appears in /config as Open agents view by default unless agent view is turned off.",scope:"global"},{key:"diffTool",group:"Global config settings",type:"string",options:["auto","terminal"],default:'"auto"',description:`Choose where Claude Code shows the diff of an Edit or Write change it proposes when a VS Code or JetBrains IDE is connected: "auto" opens it in the IDE's diff viewer, "terminal" keeps it in the terminal. Appears in /config as Diff tool only while Claude Code is connected to a VS Code or JetBrains IDE.`,scope:"global"},{key:"externalEditorContext",group:"Global config settings",type:"Boolean",default:"false",description:"When you press Ctrl+G, Claude Code opens the prompt you're typing in your external editor. With this key on, the editor buffer starts with Claude's previous response as # comment lines, so you can read it while you write, and Claude Code strips those lines when you save\u2026",scope:"global"},{key:"leftArrowOpensAgents",group:"Global config settings",type:"Boolean",default:"true",description:"Press \u2190 on an empty prompt to background the session and open agent view. Set this key to false to turn the shortcut off. Appears in /config as \u2190 opens agents when agent view is available.",scope:"global"},{key:"permissionExplainerEnabled",group:"Global config settings",type:"Boolean",default:"true",description:"> [!WARNING] > > Removed in v2.1.257, together with the Ctrl+E command explanation on Bash and PowerShell permission prompts. Setting it has no effect on current versions. Through v2.1.256, you could press Ctrl+E on a Bash or PowerShell permission prompt to see a model-generated explanation of the command\u2026",scope:"global",deprecated:!0},{key:"prStatusFooterEnabled",group:"Global config settings",type:"Boolean",default:"true",description:"Show a badge in the prompt footer for the current branch's open pull request or merge request, with a colored underline that shows its status. Appears in /config as Show PR status footer.",scope:"global"},{key:"teammateDefaultModel",group:"Global config settings",type:"string, a model alias or full model ID, or null",default:"unset",description:`> [!WARNING] > > Removed in v2.1.234, together with its /config row Default teammate model. Setting it has no effect on current versions. Through v2.1.233, you set this key to the model for agent team teammates your prompt didn't name a model for: an alias such as "sonnet", or null to follow the lead's model\u2026`,scope:"global",deprecated:!0}],CLAUDE_ENV_VARS=[{name:"ANTHROPIC_API_KEY",description:"API key sent as X-Api-Key header. When set, this key is used instead of your Claude Pro, Max, Team, or Enterprise subscription even if you are logged in. In non-interactive mode (-p), the key is always used when present. In interactive mode\u2026",kind:"string"},{name:"ANTHROPIC_AUTH_TOKEN",description:"Custom value for the Authorization header (the value you set here will be prefixed with Bearer )",kind:"string"},{name:"ANTHROPIC_AWS_API_KEY",description:"Workspace API key for Claude Platform on AWS, generated in the AWS Console. Sent as x-api-key and takes precedence over AWS SigV4",kind:"string"},{name:"ANTHROPIC_AWS_BASE_URL",description:"Override the Claude Platform on AWS endpoint URL. Use for custom regions or when routing through an LLM gateway. Defaults to https://aws-external-anthropic.{region}.api.aws. Claude Code resolves the region with the same precedence as on Amazon Bedrock",kind:"string"},{name:"ANTHROPIC_AWS_WORKSPACE_ID",description:"Required for Claude Platform on AWS. Sent on every request as the anthropic-workspace-id header",kind:"string"},{name:"ANTHROPIC_BASE_URL",description:"Override the API endpoint to route requests through a proxy or gateway. For what happens when that gateway rejects MCP tool search, see Tool search through an LLM gateway. As of v2.1.196, Remote Control is disabled when this points at a host other than api.anthropic.com, matching its behavior on Amazon Bedrock\u2026",kind:"string"},{name:"ANTHROPIC_BEDROCK_BASE_URL",description:"Override the Amazon Bedrock endpoint URL. Use for custom Amazon Bedrock endpoints or when routing through an LLM gateway. See Amazon Bedrock",kind:"string"},{name:"ANTHROPIC_BEDROCK_MANTLE_BASE_URL",description:"Override the Amazon Bedrock Mantle endpoint URL. See Mantle endpoint",kind:"string"},{name:"ANTHROPIC_BEDROCK_REGION_PREFIX",description:"Cross-region inference profile prefix (us, eu, apac, jp, au, or global) Claude Code tries first instead of the one derived from the AWS region. Ignored in AWS GovCloud regions. Requires Claude Code v2.1.224 or later. See Amazon Bedrock",kind:"string"},{name:"ANTHROPIC_BEDROCK_SERVICE_TIER",description:"Amazon Bedrock service tier (default, flex, or priority). Sent as the X-Amzn-Bedrock-Service-Tier header. See Amazon Bedrock",kind:"string"},{name:"ANTHROPIC_BETAS",description:"Comma-separated list of additional anthropic-beta header values to include in API requests. Claude Code already sends the beta headers it needs; use this to opt into an Anthropic API beta before Claude Code adds native support. Unlike the --betas flag, which requires API key authentication\u2026",kind:"list"},{name:"ANTHROPIC_CUSTOM_HEADERS",description:"Custom headers to add to requests (Name: Value format, newline-separated for multiple headers). If a name or value contains a character an HTTP header can't carry, such as a curly quote or a zero-width space, the request fails with an error that identifies the pair by position. Requires Claude Code v2.1.227 or later\u2026",kind:"string"},{name:"ANTHROPIC_CUSTOM_MODEL_OPTION",description:"Model ID to add as a custom entry in the /model picker. Use this to make a non-standard or gateway-specific model selectable without replacing built-in aliases. See Model configuration",kind:"string"},{name:"ANTHROPIC_CUSTOM_MODEL_OPTION_DESCRIPTION",description:"Display description for the custom model entry in the /model picker. Defaults to Custom model (<model-id>) when not set",kind:"string"},{name:"ANTHROPIC_CUSTOM_MODEL_OPTION_NAME",description:"Display name for the custom model entry in the /model picker. When not set, the entry shows the model's name if Claude Code recognizes the ID, and the model ID otherwise",kind:"string"},{name:"ANTHROPIC_CUSTOM_MODEL_OPTION_SUPPORTED_CAPABILITIES",description:"Comma-separated list of capabilities the custom model supports, for example effort,thinking. See Model configuration",kind:"list"},{name:"ANTHROPIC_DEFAULT_FABLE_MODEL",description:"Model ID that the fable alias resolves to, and the ID Claude Code recognizes as a Fable model for automatic model fallback on third-party providers. See Model configuration",kind:"string"},{name:"ANTHROPIC_DEFAULT_FABLE_MODEL_DESCRIPTION",description:"Display description for the pinned Fable model in the /model picker. When not set, the row shows a default description that begins Custom Fable model. See Model configuration",kind:"string"},{name:"ANTHROPIC_DEFAULT_FABLE_MODEL_NAME",description:"Display name for the pinned Fable model in the /model picker. When not set, the row shows the model's name if Claude Code recognizes the pinned ID, and the pinned ID otherwise. See Model configuration",kind:"string"},{name:"ANTHROPIC_DEFAULT_FABLE_MODEL_SUPPORTED_CAPABILITIES",description:"Comma-separated list of capabilities the pinned Fable model supports, for example effort,thinking. See Model configuration",kind:"list"},{name:"ANTHROPIC_DEFAULT_HAIKU_MODEL",description:"Model ID that the haiku alias resolves to, also used for background functionality. See Model configuration",kind:"string"},{name:"ANTHROPIC_DEFAULT_HAIKU_MODEL_DESCRIPTION",description:"Display description for the pinned Haiku model in the /model picker. When not set, the row shows a default description that begins Custom Haiku model. See Model configuration",kind:"string"},{name:"ANTHROPIC_DEFAULT_HAIKU_MODEL_NAME",description:"Display name for the pinned Haiku model in the /model picker. When not set, the row shows the model's name if Claude Code recognizes the pinned ID, and the pinned ID otherwise. See Model configuration",kind:"string"},{name:"ANTHROPIC_DEFAULT_HAIKU_MODEL_SUPPORTED_CAPABILITIES",description:"Comma-separated list of capabilities the pinned Haiku model supports, for example effort,thinking. See Model configuration",kind:"list"},{name:"ANTHROPIC_DEFAULT_MODEL",description:"Model that new sessions start on by default. Requires Claude Code v2.1.236 or later. See Set a default model for new sessions",kind:"string"},{name:"ANTHROPIC_DEFAULT_OPUS_MODEL",description:"Model ID that the opus alias resolves to, and that opusplan uses while Plan Mode is active. See Model configuration",kind:"string"},{name:"ANTHROPIC_DEFAULT_OPUS_MODEL_DESCRIPTION",description:"Display description for the pinned Opus model in the /model picker. When not set, the row shows a default description that begins Custom Opus model. See Model configuration",kind:"string"},{name:"ANTHROPIC_DEFAULT_OPUS_MODEL_NAME",description:"Display name for the pinned Opus model in the /model picker. When not set, the row shows the model's name if Claude Code recognizes the pinned ID, and the pinned ID otherwise. See Model configuration",kind:"string"},{name:"ANTHROPIC_DEFAULT_OPUS_MODEL_SUPPORTED_CAPABILITIES",description:"Comma-separated list of capabilities the pinned Opus model supports, for example effort,thinking. See Model configuration",kind:"list"},{name:"ANTHROPIC_DEFAULT_SONNET_MODEL",description:"Model ID that the sonnet alias resolves to, and that opusplan uses when Plan Mode is not active. See Model configuration",kind:"string"},{name:"ANTHROPIC_DEFAULT_SONNET_MODEL_DESCRIPTION",description:"Display description for the pinned Sonnet model in the /model picker. When not set, the row shows a default description that begins Custom Sonnet model. See Model configuration",kind:"string"},{name:"ANTHROPIC_DEFAULT_SONNET_MODEL_NAME",description:"Display name for the pinned Sonnet model in the /model picker. When not set, the row shows the model's name if Claude Code recognizes the pinned ID, and the pinned ID otherwise. See Model configuration",kind:"string"},{name:"ANTHROPIC_DEFAULT_SONNET_MODEL_SUPPORTED_CAPABILITIES",description:"Comma-separated list of capabilities the pinned Sonnet model supports, for example effort,thinking. See Model configuration",kind:"list"},{name:"ANTHROPIC_FEDERATION_RULE_ID",description:"Federation rule ID for Workload Identity Federation. When you set it together with ANTHROPIC_ORGANIZATION_ID, Claude Code selects federation credentials, which rank above your /login credential. See authentication precedence",kind:"string"},{name:"ANTHROPIC_FOUNDRY_API_KEY",description:"API key for Microsoft Foundry authentication (see Microsoft Foundry)",kind:"string"},{name:"ANTHROPIC_FOUNDRY_AUTH_TOKEN",description:"Bearer token for Microsoft Foundry authentication, such as a Microsoft Entra access token. Claude Code sends it as the Authorization: Bearer header. Takes precedence over ANTHROPIC_FOUNDRY_API_KEY and over the Azure default credential chain. See Microsoft Foundry. Requires Claude Code v2.1.203 or later",kind:"string"},{name:"ANTHROPIC_FOUNDRY_BASE_URL",description:"Full base URL for the Microsoft Foundry resource (for example, https://my-resource.services.ai.azure.com/anthropic). Alternative to ANTHROPIC_FOUNDRY_RESOURCE (see Microsoft Foundry)",kind:"string"},{name:"ANTHROPIC_FOUNDRY_RESOURCE",description:"Microsoft Foundry resource name (for example, my-resource). Claude Code refuses a URL or host name. Required if ANTHROPIC_FOUNDRY_BASE_URL is not set (see Microsoft Foundry)",kind:"string"},{name:"ANTHROPIC_MODEL",description:"Name of the model setting to use (see Model Configuration)",kind:"string"},{name:"ANTHROPIC_ORGANIZATION_ID",description:"Organization ID for Workload Identity Federation. Set it together with ANTHROPIC_FEDERATION_RULE_ID. See authentication precedence",kind:"string"},{name:"ANTHROPIC_PROFILE",description:"Name of the Anthropic profile to authenticate with, such as one created by ant auth login or by signing in to a Console account without an API key. See authentication precedence",kind:"string"},{name:"ANTHROPIC_SMALL_FAST_MODEL",description:"[DEPRECATED] Name of Haiku-class model for background tasks",kind:"string"},{name:"ANTHROPIC_SMALL_FAST_MODEL_AWS_REGION",description:"Override AWS region for the Haiku-class model when using Amazon Bedrock or Amazon Bedrock Mantle. On Amazon Bedrock, this only takes effect when ANTHROPIC_DEFAULT_HAIKU_MODEL or the deprecated ANTHROPIC_SMALL_FAST_MODEL is also set\u2026",kind:"string"},{name:"ANTHROPIC_VERTEX_BASE_URL",description:"Override Google Cloud's Agent Platform endpoint URL. Use for custom Google Cloud's Agent Platform endpoints or when routing through an LLM gateway. See Google Cloud's Agent Platform",kind:"string"},{name:"ANTHROPIC_VERTEX_PROJECT_ID",description:"GCP project ID that Google Cloud's Agent Platform requests are addressed to. See Configure GCP credentials",kind:"string"},{name:"ANTHROPIC_WORKSPACE_ID",description:"Workspace ID for workload identity federation. Set this when your federation rule is scoped to more than one workspace so the token exchange knows which workspace to target",kind:"string"},{name:"API_FORCE_IDLE_TIMEOUT",description:"Override the 5-minute body idle timeout that aborts a streaming model response when no bytes arrive. Set to 0 to turn the timeout off, for example when a slow gateway or local model pauses longer than 5 minutes between chunks, or 1 to keep it on for every provider. When unset\u2026",kind:"boolean"},{name:"API_TIMEOUT_MS",description:"Time in milliseconds that each API request attempt has to receive its response headers. It doesn't limit how long a streaming response runs after that. The default is 600000, or 10 minutes, and the maximum is 2147483647. When you set a positive value, each attempt at a non-streaming request has to finish within it\u2026",kind:"boolean"},{name:"AWS_BEARER_TOKEN_BEDROCK",description:"Amazon Bedrock API key for authentication (see Amazon Bedrock API keys)",kind:"string"},{name:"BASH_DEFAULT_TIMEOUT_MS",description:"Default timeout for a foreground Bash or PowerShell tool command, in milliseconds (default: 120000, or 2 minutes). A value above the default time limit for background commands replaces that default in unattended sessions. The background time limit requires Claude Code v2.1.285 or later",kind:"number"},{name:"BASH_MAX_OUTPUT_LENGTH",description:"Maximum number of characters of bash output that Claude Code reads back into a command's result (default: 30000; maximum: 150000). If you set the bashOutputMaxChars setting, Claude Code ignores this variable. See Output limits",kind:"number"},{name:"BASH_MAX_TIMEOUT_MS",description:"Maximum timeout the model can set for a foreground Bash or PowerShell tool command, in milliseconds (default: 600000, or 10 minutes). The effective ceiling is the larger of this and BASH_DEFAULT_TIMEOUT_MS\u2026",kind:"number"},{name:"BETA_TRACING_ENDPOINT",description:"OTLP/HTTP endpoint for detailed beta tracing: with ENABLE_BETA_TRACING_DETAILED=1, logs and traces go there instead of to the configured exporters. Set it in your shell, user settings, or managed settings. Ignored in project and local settings",kind:"string"},{name:"CCR_FORCE_BUNDLE",description:"Set to 1 to force claude --cloud to bundle and upload your local repository instead of cloning from its remote",kind:"boolean"},{name:"CLAUDECODE",description:"Set to 1 in subprocesses Claude Code spawns (Bash and PowerShell tools, tmux sessions, hook commands, status line commands, stdio MCP server subprocesses). IDE extensions also set this in their integrated terminals. Use to detect when a script is running inside a subprocess spawned by Claude Code\u2026",kind:"boolean"},{name:"CLAUDE_AGENT_SDK_DISABLE_BUILTIN_AGENTS",description:"Set to 1 to disable all built-in subagent types such as Explore and Plan. Only applies in non-interactive mode (the -p flag). Useful for SDK users who want a blank slate. This also removes general-purpose, the subagent Claude Code runs when an Agent tool call omits subagent_type\u2026",kind:"boolean"},{name:"CLAUDE_AGENT_SDK_MCP_NO_PREFIX",description:"Set to 1 to skip the mcp<server> prefix on tool names from SDK-created MCP servers. Tools use their original names. SDK usage only",kind:"boolean"},{name:"CLAUDE_ASYNC_AGENT_STALL_TIMEOUT_MS",description:"Stall timeout in milliseconds for subagents. Also covers workflow agents on Claude Code v2.1.286 or later. Default 600000 (10 minutes); if you raise CLAUDE_STREAM_IDLE_TIMEOUT_MS while the stream watchdog is on, the default rises with it, as Handle slow or stalled API responses describes",kind:"number"},{name:"CLAUDE_AUTOCOMPACT_PCT_OVERRIDE",description:"Set the percentage (1-100) of the auto-compact window at which auto-compaction triggers. Use lower values like 50 to compact earlier; the variable can't raise the threshold, so values above the default percentage are ignored. It applies only in sessions that compact before the model's context limit\u2026",kind:"number"},{name:"CLAUDE_AUTO_BACKGROUND_TASKS",description:"Set to 1 to force-enable automatic backgrounding of long-running agent tasks. When enabled, a subagent moves to the background after running for approximately two minutes. If Claude queued a tool call such as a file edit behind the subagent, the subagent finishes in the foreground before that call starts\u2026",kind:"boolean"},{name:"CLAUDE_AX_PREPARK_MS",description:"In screen reader mode, how many milliseconds Claude Code waits before it writes a new or changed line. Default 0, so Claude Code doesn't wait. Before v2.1.287, the default was 50. Claude Code caps the wait at 5000. Requires Claude Code v2.1.233 or later",kind:"number"},{name:"CLAUDE_AX_SCREEN_READER",description:"Set to 1 to render screen-reader friendly output: flat text without decorative borders or animations. Set to 0 to force screen-reader mode off even when axScreenReader is true. The --ax-screen-reader flag takes precedence. Requires Claude Code v2.1.181 or later",kind:"boolean"},{name:"CLAUDE_AX_STARTUP_QUIET_MS",description:"In screen reader mode, how many milliseconds Claude Code holds the first interface render after the startup confirmation line, so your screen reader can speak the line in full before new output interrupts it. Default 3000. Set 0 to render immediately. Claude Code caps the hold at 600000 (10 minutes)\u2026",kind:"number"},{name:"CLAUDE_BASH_MAINTAIN_PROJECT_WORKING_DIR",description:"Return to the original working directory after each Bash or PowerShell command in the main session",kind:"path"},{name:"CLAUDE_BYTE_STREAM_IDLE_TIMEOUT_MS",description:"Timeout in milliseconds for the byte-level streaming idle watchdog; when set, it takes precedence over CLAUDE_STREAM_IDLE_TIMEOUT_MS for that watchdog and leaves the event-level watchdog unchanged. Claude Code clamps this variable to between 10 seconds and 30 minutes. Requires Claude Code v2.1.210 or later",kind:"number"},{name:"CLAUDE_CLIENT_PRESENCE_FILE",description:"Path to a file that an external tool, such as a screen-lock listener, creates when you unlock your screen and deletes when you lock it. While the file exists, Claude Code skips Remote Control mobile push notifications, so you stop getting pushes while you are actively using the computer\u2026",kind:"path"},{name:"CLAUDE_CODE_ACCESSIBILITY",description:"Set to 1 to keep the native terminal cursor visible and disable the inverted-text cursor indicator. Allows screen magnifiers like macOS Zoom to track cursor position",kind:"boolean"},{name:"CLAUDE_CODE_ADDITIONAL_DIRECTORIES_CLAUDE_MD",description:"Set to 1 to load memory files from directories specified with --add-dir. Loads CLAUDE.md, .claude/CLAUDE.md, .claude/rules/*.md, and CLAUDE.local.md. By default, additional directories do not load memory files",kind:"boolean"},{name:"CLAUDE_CODE_ALT_SCREEN_FULL_REPAINT",description:"Set to 1 to repaint the entire screen on every frame in fullscreen rendering instead of sending incremental updates. Use this if fullscreen mode shows stale or misplaced text fragments. Claude Code enables this automatically for background sessions and agent view on Windows",kind:"boolean"},{name:"CLAUDE_CODE_ALWAYS_ENABLE_EFFORT",description:"Set to 1 to send the effort parameter with every request, even when Claude Code does not recognize the model ID as effort-capable. Use this when routing through an LLM gateway or third-party provider that serves models under custom identifiers. Models that reject the effort parameter at the API\u2026",kind:"boolean"},{name:"CLAUDE_CODE_API_KEY_HELPER_TTL_MS",description:"Interval in milliseconds at which credentials should be refreshed (when using apiKeyHelper)",kind:"number"},{name:"CLAUDE_CODE_ARTIFACT_AUTO_OPEN",description:"Set to 0 to stop Claude Code from opening the browser automatically when a new artifact is published",kind:"boolean"},{name:"CLAUDE_CODE_ARTIFACT_COMMENTS",description:"Set to 0 to stop Claude reading and replying to comments on an artifact. Has no effect when CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC has turned artifacts off. Requires Claude Code v2.1.221 or later",kind:"boolean"},{name:"CLAUDE_CODE_ARTIFACT_COMMENTS_AUTOREACT",description:"Set to 0 to stop Claude replying on its own to comments sent to it. Requires Claude Code v2.1.228 or later",kind:"boolean"},{name:"CLAUDE_CODE_ARTIFACT_PUBLISH_EDITS",description:"Set to 0 to stop Claude from applying small changes to an artifact's file as part of publishing it. Claude then edits the file with its file-editing tools and publishes it as a separate step. Requires Claude Code v2.1.300 or later",kind:"boolean"},{name:"CLAUDE_CODE_ATTRIBUTION_HEADER",description:"Set to 0 to omit the attribution block, which carries the client version and a prompt fingerprint, from the start of the system prompt. Caching on a direct connection to the Anthropic API is unaffected either way. In some direct-connection setups\u2026",kind:"boolean"},{name:"CLAUDE_CODE_AUTO_BACKGROUND_WORKER_CHECKIN_SECONDS",description:"Removed in v2.1.283. Use CLAUDE_CODE_WORKER_CHECKIN_SCHEDULE instead",kind:"string"},{name:"CLAUDE_CODE_AUTO_COMPACT_WINDOW",description:"Set the auto-compact window, how full the context gets before compaction, from 100000 to 1000000 tokens. Suffixed values such as 200k require v2.1.304 or later. For precedence over the other ways to set the window and the effect on the status line's used_percentage, see Set the auto-compact window",kind:"number"},{name:"CLAUDE_CODE_AUTO_CONNECT_IDE",description:"Override automatic IDE connection. By default, Claude Code connects automatically when launched inside a supported IDE's integrated terminal. Set to false to prevent this. Set to true to force a connection attempt when auto-detection fails, such as when tmux obscures the parent terminal\u2026",kind:"string"},{name:"CLAUDE_CODE_AUTO_MODE_MODEL",description:"Sets the model for the classifier requests Claude Code sends in auto mode. Use a full model ID such as claude-sonnet-4-6. For the cases where Claude Code ignores it, see Choose the classifier model. Requires Claude Code v2.1.302 or later",kind:"string"},{name:"CLAUDE_CODE_AUTO_MODE_SERVER",description:"Controls whether Claude Code asks the server to review auto mode actions. Set to 0 to use Claude Code's own classifier requests instead. On a direct connection to the Anthropic API, requires v2.1.281 or later. The linked section lists which sessions ask the server when the variable is unset, and from which version\u2026",kind:"boolean"},{name:"CLAUDE_CODE_AWS_CHAIN_RESOLVE_TIMEOUT_MS",description:"Time in milliseconds Claude Code waits for the AWS default credential provider chain to produce credentials before the request fails with AWS default-chain credential resolve timed out (default: 60000). Raise it when a step in your chain legitimately needs longer\u2026",kind:"number"},{name:"CLAUDE_CODE_BASH_EDIT_DIFF",description:"Set to 0 to turn off the diff of the files that changed while a Bash command ran, or 1 to record it in every permission mode. Takes precedence over the bashEditDiffEnabled setting. Requires Claude Code v2.1.269 or later",kind:"boolean"},{name:"CLAUDE_CODE_BG_TASKS_REPORT_RUNNING",description:"Set to 0 to make a non-interactive session report an idle status to its host at every turn end, even while background work is still running. By default, the session keeps reporting a running status past turn end while background work such as a background agent or a workflow run is still live\u2026",kind:"boolean"},{name:"CLAUDE_CODE_BRIDGE_SESSION_ID",description:"Set automatically in Bash tool and hook command subprocesses while the session has an active Remote Control connection, and removed when the connection ends. The value is the session's ID in session_ form, the same identifier that appears in the session's claude.ai/code URL\u2026",kind:"string"},{name:"CLAUDE_CODE_BS_AS_CTRL_BACKSPACE",description:"Set to 0 to make Claude Code read the 0x08 byte, also written ^H, as plain Backspace, or 1 to read it as Ctrl+Backspace. Either value replaces the platform default. By default, Claude Code reads it as Ctrl+Backspace on Windows, except when TERM_PROGRAM is mintty or TERM is cygwin\u2026",kind:"boolean"},{name:"CLAUDE_CODE_CERT_STORE",description:"Comma-separated list of CA certificate sources for TLS connections. bundled is the Mozilla CA set shipped with Claude Code. system is the operating system trust store, read only on runtimes with tls.getCACertificates: the native binary, or Node 22.15 or later for npm installs. See CA certificate store\u2026",kind:"list"},{name:"CLAUDE_CODE_CHILD_SESSION",description:"Set to 1 in subprocesses Claude Code spawns via the Bash, PowerShell, and Monitor tools, hook commands, and status line commands. Not set for stdio MCP server subprocesses, which are long-lived and outlive the session that spawned them. Unlike CLAUDECODE\u2026",kind:"boolean"},{name:"CLAUDE_CODE_CLIENT_CERT",description:"Path to client certificate file for mTLS authentication",kind:"path"},{name:"CLAUDE_CODE_CLIENT_KEY",description:"Path to client private key file for mTLS authentication",kind:"path"},{name:"CLAUDE_CODE_CLIENT_KEY_PASSPHRASE",description:"Passphrase for encrypted CLAUDE\\_CODE\\_CLIENT\\_KEY (optional)",kind:"string"},{name:"CLAUDE_CODE_CONNECT_TIMEOUT_MS",description:"Removed in v2.1.186 and now a no-op. Previously set a separate timeout for the connect, TLS, and response-header phase of a streaming API request. Use API_TIMEOUT_MS instead. For the response-header phase of a streaming request, see CLAUDE_STREAM_FIRST_BYTE_TIMEOUT_MS",kind:"number"},{name:"CLAUDE_CODE_DEBUG_LOGS_DIR",description:"Override the debug log file path. Despite the name, this is a file path, not a directory. Requires debug mode to be enabled separately via --debug, /debug, or the DEBUG environment variable: setting this variable alone does not enable logging. The --debug-file flag does both at once\u2026",kind:"path"},{name:"CLAUDE_CODE_DEBUG_LOG_LEVEL",description:"Minimum log level written to the debug log file. Values: verbose, debug (default), info, warn, error. Set to verbose to include high-volume diagnostics like full status line command output, or raise to error to reduce noise",kind:"string"},{name:"CLAUDE_CODE_DISABLE_1M_CONTEXT",description:"Set to 1 to turn off 1M context window support. Claude Code removes [1m] model variants from the model picker and holds models that run with the 1M window by default to a 200K window. See Turn off 1M context. Useful for enterprise environments with compliance requirements\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_ADAPTIVE_THINKING",description:"Set to 1 to disable adaptive reasoning on Opus 4.6 and Sonnet 4.6 and fall back to the fixed thinking budget controlled by MAX_THINKING_TOKENS. Has no effect on Fable models, Sonnet 5 and later, Haiku 5.5, or Opus 4.7 and later, which always use adaptive reasoning",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_ADVISOR_TOOL",description:"Set to 1 to disable the advisor tool. The /advisor command becomes unavailable, any configured advisorModel is ignored, and the --advisor flag is accepted but has no effect, so existing scripts that pass it continue to work without errors",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_AGENT_VIEW",description:"Set to 1 to turn off background agents and agent view: claude agents, --bg, /background, and the on-demand supervisor. Equivalent to the disableAgentView setting",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_ALTERNATE_SCREEN",description:"Set to 1 to disable fullscreen rendering and use the classic main-screen renderer. The conversation stays in your terminal's native scrollback so Cmd+f and tmux copy mode work as usual. Takes precedence over CLAUDE_CODE_NO_FLICKER and the tui setting. You can also switch with /tui default\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_ARTIFACT",description:"Set to 1 to turn off the Artifact tool, which publishes session output as a private web page on claude.ai. Once you set it, no settings file turns the tool back on. To turn the tool off from a settings file instead, set enableArtifact to false; the deprecated disableArtifact key also turns it off",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_ATTACHMENTS",description:"Set to 1 to disable attachment processing. File mentions with @ syntax are sent as plain text instead of being expanded into file content. Ignored in project and local settings",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_AUTH_REFRESH_LOCK",description:"Set to 1 to make a Claude Code process run its gcpAuthRefresh or awsAuthRefresh command itself instead of waiting while another process runs it. Requires Claude Code v2.1.286 or later",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_AUTO_MEMORY",description:"Set to 1 to disable auto memory. Set to 0 to force auto memory on even when --bare mode or autoMemoryEnabled: false would otherwise disable it. When disabled, Claude does not create or load auto memory files",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_BACKGROUND_TASKS",description:"Set to 1 to disable all background task functionality, including the run_in_background parameter on Bash and subagent tools, auto-backgrounding, and the Ctrl+B shortcut",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_BEDROCK_CONTENT_TYPE_DEFAULT",description:"Set to 1 to stop Claude Code from treating an Amazon Bedrock streaming response with a missing or empty Content-Type header as Amazon Bedrock's binary event stream. By default, Claude Code assumes a gateway dropped the header from an otherwise unmodified response, so it decodes the body and streaming keeps working\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_BEDROCK_CONTENT_TYPE_GUARD",description:"Set to 1 to skip the check that an Amazon Bedrock streaming response carries the application/vnd.amazon.eventstream content-type. Without this variable, when a response carries a different content-type, Claude Code fails the request with an error naming that type\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_BG_EXIT_HANDOFF",description:"Set to 1 to stop a background session's in-flight work when the supervisor stops, restarts, or updates that session's process, instead of handing it to the session's next process. That work is the session's running background shell commands and dynamic workflows, plus background subagents as of v2.1.198\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_BG_SHELL_PRESSURE_REAP",description:"Set to 1 to stop Claude Code from terminating background shell commands under memory pressure. By default, on macOS and Linux, Claude Code terminates background shells when the operating system reports critical memory pressure and the session has been idle for 30 minutes with no turn or subagent running\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_BUNDLED_SKILLS",description:"Set to 1 to disable the skills and workflows included with Claude Code: bundled skills and workflows are removed entirely, while built-in commands like /init stay typable but are hidden from the model. /doctor stays typable like the built-in commands; hide it with DISABLE_DOCTOR_COMMAND instead. Skills from plugins\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_CFC_PROMPT",description:"Set to 1 to keep the Claude in Chrome browser tools available while omitting the Chrome section of the system prompt and the /claude-in-chrome bundled skill. For hosts that embed Claude Code and supply their own browser guidance. Requires Claude Code v2.1.257 or later",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_CLAUDE_MDS",description:"Set to 1 to prevent loading any CLAUDE.md memory files into context, including user, project, and auto memory files",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_CRON",description:"Set to 1 to disable session-scoped scheduled tasks. The /loop skill and cron tools become unavailable and any already-scheduled tasks stop firing, including tasks that are already running mid-session",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_DANGEROUS_RM_TIMEOUT",description:"Set to 1 to turn off the time limit on critical-path removal prompts. In auto mode Claude Code then sends these removals to the classifier instead, and in bypassPermissions mode the prompt waits for your answer. Set it in the environment that launches Claude Code\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_EXPERIMENTAL_BETAS",description:"Set to 1 to strip pre-release anthropic-beta request headers, the body fields that pair with them, and beta tool-schema fields such as defer_loading and eager_input_streaming from API requests. Use this when a proxy gateway rejects requests with an Unexpected value(s) error for the anthropic-beta header or an Extra inp\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_EXPLORE_PLAN_AGENTS",description:"Set to 1 to disable the built-in Explore and Plan subagents. Claude explores with its search tools or the general-purpose subagent instead, and plan mode reads files directly rather than launching Explore and Plan agents. Custom subagents named Explore or Plan are unaffected\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_FAST_MODE",description:"Set to 1 to disable fast mode",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_FEEDBACK_SURVEY",description:'Set to 1 to disable the "How is Claude doing?" session quality surveys. Surveys are also disabled when DISABLE_TELEMETRY, DO_NOT_TRACK, or CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC is set, unless CLAUDE_CODE_ENABLE_FEEDBACK_SURVEY_FOR_OTEL opts back in. To set a sample rate instead of disabling outright\u2026',kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_FILE_CHECKPOINTING",description:"Set to 1 to disable file checkpointing. The /rewind command will not be able to restore code changes. Overrides the fileCheckpointingEnabled setting",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_FILE_MENTIONS",description:"Set to 1 to stop Claude Code from expanding @ mentions of files and directories. Claude instead gets the mentioned paths with a note to read them using its file tools. Ignored in project and local settings. Requires Claude Code v2.1.299 or later",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_GIT_INSTRUCTIONS",description:"Set to 1 to remove built-in commit and PR workflow instructions and the git status snapshot from Claude's context. Useful when using your own git workflow skills. Takes precedence over the includeGitInstructions setting when set",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_INLINE_SHELL_RM_PROMPT",description:"Set to 1 to stop Claude Code from reading scripts passed to a shell with -c, such as bash -c 'rm -rf ~', for critical-path removals. Claude Code still checks the shell variable and positional parameter targets in those scripts, and the other critical-path checks keep running\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_LEGACY_MODEL_REMAP",description:"Set to 1 to prevent automatic remapping of Opus 4 and Opus 4.1 to the current Opus version on the Anthropic API. Use when you intentionally want to pin an older model. The remap does not run on Amazon Bedrock, Google Cloud's Agent Platform, or Microsoft Foundry",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_MODEL_ACCESS_FALLBACK",description:"Set to 1 to stop Claude Code on Amazon Bedrock and Google Cloud's Agent Platform from switching to an older model when your account loses access to a session's model mid-session; the refused request fails at once instead. A fallback model chain you configure still switches on that refusal\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_MOUNTED_DRIVE_RM_PROMPT",description:"Set to 1 to turn off the mounted drive prompt for paths such as /Volumes/USB. Set it in the environment that launches Claude Code, because Claude Code ignores it in a settings env block. Requires Claude Code v2.1.304 or later",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_MOUSE",description:"Set to 1 to disable mouse tracking in fullscreen rendering. Keyboard scrolling with PgUp and PgDn still works. Use this to keep your terminal's native copy-on-select behavior",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_MOUSE_CLICKS",description:"Set to 1 to disable click, drag, and hover handling in fullscreen rendering while keeping mouse-wheel scrolling. Use this when you want wheel scroll to work inside Claude Code but don't want clicks to position the cursor, expand tool output, or open links. CLAUDE_CODE_DISABLE_MOUSE takes precedence when both are set\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_MTLS_RELOAD_ON_STALE_CONNECTION",description:"Set to 1 to stop Claude Code from re-reading the mTLS client certificate and key when an API request fails with a connection-level error, such as a connection reset or a TLS handshake error. With the reload disabled, Claude Code loads rotated files only when it next applies settings or at the next startup\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC",description:"Set to any non-empty value, such as 1, to disable nonessential network traffic: auto-updates, telemetry, error reporting, the /feedback command, Claude-drafted feedback, release notes, the PR and MR status badge checks, and availability checks such as the fast mode check\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_NONSTREAMING_FALLBACK",description:"Set to 1 to disable the non-streaming fallback when a streaming request fails mid-stream. Streaming errors propagate to the retry layer instead. Useful when a proxy or gateway causes the fallback to produce duplicate tool execution",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_NOTIFICATION_PRESENCE_CHECK",description:"Set to 1 to send the PushNotification tool's desktop notification even while you are typing in or focused on the terminal. By default the tool skips both the desktop notification and the mobile push when it detects recent keyboard activity or terminal focus. This variable disables only that local check\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_OFFICIAL_MARKETPLACE_AUTOINSTALL",description:"Set to 1 to disable automatic registration of the official plugin marketplace. Claude Code reads the variable when it is about to register the marketplace, usually during a machine's first interactive launch. If the variable is set at that point, Claude Code skips the registration permanently\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_PERMISSION_PROMPT_NOTIFY_HOOKS",description:"Set to 1 to stop Claude Code from running your Notification hooks for unanswered permission requests in sessions where Claude Code sends them to the Agent SDK's canUseTool callback, which is how Claude Desktop and the VS Code extension host Claude Code. Has no effect in terminal sessions\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_POLICY_SKILLS",description:"Set to 1 to skip loading skills from the system-wide managed skills directory. Useful for container or CI sessions that should not load operator-provisioned skills",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_POWERSHELL_CMD_RM_DENY",description:"Set to 1 to turn off the PowerShell tool check that denies the cmd built-ins rd, rmdir, del, and erase on a system path, such as a drive root or your home directory. Claude Code ignores this variable in a settings file's env block. Requires Claude Code v2.1.283 or later",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_REFUSAL_FALLBACK",description:"Set to 1 to turn off the automatic model switch when a safety classifier flags a request, the behavior the switchModelsOnFlag setting controls",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_STRUCTURED_OUTPUTS",description:"Set to 1 to stop Claude Code from sending the structured-output output_config.format field and the anthropic-beta value that pairs with it, for an LLM gateway whose upstream rejects them. This leaves on the other pre-release capabilities that CLAUDE_CODE_DISABLE_EXPERIMENTAL_BETAS turns off\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_SUBSTITUTION_RM_PROMPT",description:'Set to 1 to turn off the critical-path check for a recursive rm whose target is entirely the output of a command substitution, such as rm -rf "$(pwd)". The other critical-path checks keep running. Set it in the environment that launches Claude Code\u2026',kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_TERMINAL_TITLE",description:"Set to 1 to disable automatic terminal title updates based on conversation context. This also skips the background small/fast-model request that generates a session title, and turns off status reports to your terminal",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_THINKING",description:"Set to 1 to omit the thinking parameter from API requests entirely. This is a compatibility option for proxies and gateways that reject the parameter. On models that think by default, omitting the parameter means the model may still think. To explicitly disable extended thinking on the Anthropic API\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_UNKNOWN_MODEL_WINDOW_ENFORCEMENT",description:"Set to 1 to skip proactive auto-compaction when Claude Code doesn't recognize the model ID, such as an LLM gateway alias. Without this variable, Claude Code compacts at the context window it assumes for the ID. CLAUDE_CODE_MAX_CONTEXT_TOKENS can correct the assumed window instead\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_VIRTUAL_SCROLL",description:"Set to 1 to disable virtual scrolling in fullscreen rendering and render every message in the transcript. Use this if scrolling in fullscreen mode shows blank regions where messages should appear",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_WEB_FETCH",description:"Set to 1 to turn off the WebFetch tool. The WebSearch tool stays available. Requires Claude Code v2.1.285 or later",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_WINDOWS_SHELL_LAUNCHER",description:"Set to 1 to start PowerShell tool commands on Windows directly instead of through the cmd.exe launcher. By default, the launcher lets a PowerShell command running in the background carry over to the session's next process, such as when you background the session. If you set the variable\u2026",kind:"boolean"},{name:"CLAUDE_CODE_DISABLE_WORKFLOWS",description:"Set to 1 to disable workflows. Equivalent to the disableWorkflows setting",kind:"boolean"},{name:"CLAUDE_CODE_EFFORT_LEVEL",description:"Set the effort level for supported models. Values: low, medium, high, xhigh, max, or auto to use the model default. Available levels depend on the model. Takes precedence over --effort, /effort, and the modelSettings and effortLevel settings. A maxEffortLevel cap still applies. See Adjust effort level",kind:"string"},{name:"CLAUDE_CODE_EMIT_SESSION_STATE_EVENTS",description:"Set to 1 to add session_state_changed messages, which carry the session's state, to the message stream. Requires either the Agent SDK or --print, --output-format stream-json, and --verbose",kind:"boolean"},{name:"CLAUDE_CODE_ENABLE_AUTO_MODE",description:"Accepted for compatibility with older releases and has no effect. Auto mode is available by default on every provider, including Amazon Bedrock, Google Cloud's Agent Platform, Microsoft Foundry, and signed-in Claude apps gateway sessions. In v2.1.158 through v2.1.206\u2026",kind:"string"},{name:"CLAUDE_CODE_ENABLE_AWAY_SUMMARY",description:"Override session recap availability. Set to 0 to force recaps off regardless of the /config toggle. Set to 1 to force recaps on when awaySummaryEnabled is false. Takes precedence over the setting and /config toggle",kind:"boolean"},{name:"CLAUDE_CODE_ENABLE_BACKGROUND_PLUGIN_REFRESH",description:"Set to 1 to refresh plugin state at turn boundaries in non-interactive mode after a background install completes. Off by default because the refresh changes the system prompt mid-session, which invalidates prompt caching for that turn",kind:"boolean"},{name:"CLAUDE_CODE_ENABLE_CFC",description:"Set to 1 to start a CLI session with Chrome integration on, or 0 to start with it off. Takes precedence over the claudeInChromeDefaultEnabled setting. The --chrome and --no-chrome flags take precedence over both. Claude Code ignores 1 in project and local settings",kind:"boolean"},{name:"CLAUDE_CODE_ENABLE_FEEDBACK_SURVEY_FOR_OTEL",description:'Set to 1 to route the "How is Claude doing?" session quality survey to your own OpenTelemetry collector when Anthropic-bound nonessential traffic is blocked. Survey ratings are emitted only as OTEL events to your configured collector. No survey data is sent to Anthropic in this mode\u2026',kind:"boolean"},{name:"CLAUDE_CODE_ENABLE_FINE_GRAINED_TOOL_STREAMING",description:"Controls whether tool call inputs stream from the API as Claude generates them. With this off, a large tool input such as a long file write arrives only after Claude finishes generating it, which can look like it's hanging. Enabled by default on the Anthropic API. On Amazon Bedrock and Google Cloud's Agent Platform\u2026",kind:"boolean"},{name:"CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY",description:"Set to 1 to populate the /model picker from your gateway's /v1/models endpoint when ANTHROPIC_BASE_URL points at an Anthropic-compatible gateway such as LiteLLM, Kong, or an internal proxy. Off by default because gateways backed by a shared API key would otherwise show every user every model the key can access\u2026",kind:"boolean"},{name:"CLAUDE_CODE_ENABLE_OPUS_4_7_FAST_MODE",description:"Removed in v2.1.142, when the fast mode default moved from Opus 4.6 to Opus 4.7",kind:"string"},{name:"CLAUDE_CODE_ENABLE_PROMPT_SUGGESTION",description:"Set to false to turn off prompt suggestions, the grayed-out predictions that appear in your prompt input. Takes precedence over the promptSuggestionEnabled setting, which is what the Prompt suggestions toggle in /config writes. Claude Code also pauses suggestions while your account is close to or at its usage limit\u2026",kind:"string"},{name:"CLAUDE_CODE_ENABLE_TASKS",description:"Selects which task-tracking tools Claude Code provides in sessions that have them. By default, Claude Code provides the Task tools TaskCreate, TaskUpdate, TaskGet, and TaskList. Set to 0 to get the legacy TodoWrite tool instead. See Task list",kind:"boolean"},{name:"CLAUDE_CODE_ENABLE_TELEMETRY",description:"Set to 1 to enable OpenTelemetry data collection for metrics and logging. Required before configuring OTel exporters. Set it in your shell, user settings, or managed settings. Ignored in project and local settings. See Monitoring",kind:"boolean"},{name:"CLAUDE_CODE_ENABLE_TODO_TOOLS",description:"Set to 1 to get the task-tracking tools on every model. Without it, Claude Code provides them by default only on the models listed under Task tool availability. CLAUDE_CODE_ENABLE_TASKS still selects the Task tools or TodoWrite. Requires Claude Code v2.1.233 or later",kind:"boolean"},{name:"CLAUDE_CODE_EXIT_AFTER_STOP_DELAY",description:"Time in milliseconds to wait after the query loop becomes idle before automatically exiting. Useful for automated workflows and scripts using SDK mode",kind:"number"},{name:"CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS",description:"Set to 1 to enable agent teams. Agent teams are experimental and disabled by default",kind:"boolean"},{name:"CLAUDE_CODE_EXTRA_BODY",description:"JSON object to merge into the top level of every API request body. Useful for passing provider-specific parameters that Claude Code doesn't expose directly. A value exported in your shell also applies to the background sessions you dispatch with claude agents or --bg. Before v2.1.206\u2026",kind:"string"},{name:"CLAUDE_CODE_FILE_READ_MAX_OUTPUT_TOKENS",description:"Override the default token limit for file reads, which is 25,000 tokens. Useful when you need to read larger files in full. A read that Claude makes with the allow_large parameter can go past this limit when the context window has room",kind:"string"},{name:"CLAUDE_CODE_FORCE_SESSION_PERSISTENCE",description:"Set to 1 to force transcript persistence, prompt history, and claude agents registration even when this claude was launched from inside another Claude Code session. Use when an inherited CLAUDE_CODE_CHILD_SESSION value\u2026",kind:"boolean"},{name:"CLAUDE_CODE_FORCE_STRIKETHROUGH",description:"Set to 1 to force strikethrough rendering for ~~text~~ in Claude's responses when your terminal supports it but is not auto-detected, such as over SSH without TERM_PROGRAM forwarded. Without this, undetected terminals show the literal ~~ markers instead of rendering the text as strikethrough\u2026",kind:"boolean"},{name:"CLAUDE_CODE_FORCE_SYNC_OUTPUT",description:"Set to 1 to force-enable DEC private mode 2026 synchronized output when your terminal supports it but is not auto-detected. Useful for emulators such as Emacs eat that implement BSU/ESU but do not reply to the capability probe. Has no effect under tmux. Unlike CLAUDE_CODE_NO_FLICKER\u2026",kind:"boolean"},{name:"CLAUDE_CODE_FORCE_TERMINAL_IMAGES",description:"Set to 1 to draw mod Image elements as pictures when your terminal draws kitty graphics protocol images with Unicode placeholders and you still see an Image's dimmed alt text. See which terminals draw an Image and why this variable doesn't help inside tmux or screen",kind:"boolean"},{name:"CLAUDE_CODE_FORK_SUBAGENT",description:"Controls fork mode, which is on by default and lets Claude start forks on its own. While fork mode is on, Claude also can't wait for a subagent in interactive terminal, VS Code, or desktop sessions on your machine. Set to 0 to turn fork mode off. For versions, see Turn fork mode off",kind:"boolean"},{name:"CLAUDE_CODE_FORWARD_SUBAGENT_TEXT",description:"Set to 1 to emit subagent text and thinking blocks in claude -p --output-format stream-json output, the same behavior as the --forward-subagent-text flag. Use the variable when a harness invokes claude and can't pass the flag itself. Unlike the flag\u2026",kind:"boolean"},{name:"CLAUDE_CODE_GATEWAY_HINT_HEADERS",description:"Set to 1 to send the gateway hint headers, such as x-claude-code-request-class and x-claude-code-compaction, on a custom proxy or a third-party provider such as Amazon Bedrock or Claude Platform on AWS. Set to 0 to stop sending them on every connection, including a direct connection to the Anthropic API\u2026",kind:"boolean"},{name:"CLAUDE_CODE_GATEWAY_MODEL_DISCOVERY_TIMEOUT_MS",description:"Timeout in milliseconds for the gateway model discovery request that CLAUDE_CODE_ENABLE_GATEWAY_MODEL_DISCOVERY turns on (default: 3000). Raise it when your gateway needs longer than three seconds to answer /v1/models at startup. Takes plain digits only; 0, negative values, and other spellings keep the default\u2026",kind:"boolean"},{name:"CLAUDE_CODE_GIT_BASH_PATH",description:"Windows only: path to the Git Bash executable (bash.exe). Use when Git Bash is installed but not in your PATH. If the path doesn't exist or the file isn't named bash.exe, sh.exe, bash, or sh, Claude Code ignores the variable and auto-detects Git Bash as if it were unset, logging a warning visible with --debug\u2026",kind:"path"},{name:"CLAUDE_CODE_GLOB_HIDDEN",description:"Set to false to exclude dotfiles from results when Claude invokes the Glob tool. Included by default. Does not affect @ file autocomplete, ls, Grep, or Read",kind:"string"},{name:"CLAUDE_CODE_GLOB_NO_IGNORE",description:"Set to false to make the Glob tool respect .gitignore patterns. By default, Glob returns all matching files including gitignored ones. Does not affect @ file autocomplete, which has its own respectGitignore setting",kind:"string"},{name:"CLAUDE_CODE_GLOB_TIMEOUT_SECONDS",description:"Timeout in seconds for Glob tool file discovery. Defaults to 20 seconds on most platforms and 60 seconds on WSL",kind:"number"},{name:"CLAUDE_CODE_GOAL_CHECKIN_MINUTES",description:"How many minutes background work can keep an active goal waiting before Claude Code asks Claude to check on it. Default 30. Set 0 to turn check-ins off. Give whole minutes in plain digits, at most 10080, which is one week. Claude Code treats any other value as unset and uses the default\u2026",kind:"boolean"},{name:"CLAUDE_CODE_GZIP_REQUEST_BODIES",description:"Set to 0 to turn off gzip compression of Claude API, telemetry, and artifact publish request bodies sent to api.anthropic.com. By default, Claude Code compresses large request bodies on direct connections and skips compression when you send requests through a proxy, configure a client certificate\u2026",kind:"boolean"},{name:"CLAUDE_CODE_HIDE_CWD",description:"Set to 1 to hide the working directory in the startup logo. Useful for screenshares or recordings where the path exposes your OS username",kind:"boolean"},{name:"CLAUDE_CODE_IDE_HOST_OVERRIDE",description:"Override the host address used to connect to the IDE extension. By default Claude Code auto-detects the correct address, including WSL-to-Windows routing",kind:"string"},{name:"CLAUDE_CODE_IDE_SKIP_AUTO_INSTALL",description:"Set to 1 to skip auto-installation of IDE extensions. Equivalent to setting autoInstallIdeExtension to false",kind:"boolean"},{name:"CLAUDE_CODE_IDE_SKIP_VALID_CHECK",description:"Set to 1 to skip validation of IDE lockfile entries during connection. Use when auto-connect fails to find your IDE despite it running",kind:"boolean"},{name:"CLAUDE_CODE_IDLE_COMPACT_MIN_TOKENS",description:"Context size, in tokens, at which idle compaction applies to a conversation (default: 200000). Accepts a positive whole number, and anything else is ignored. Values below 100000 are raised to 100000, the lowest threshold. Idle compaction is on by default for conversations that meet its conditions. To turn it off\u2026",kind:"string"},{name:"CLAUDE_CODE_MAX_CONCURRENT_SUBAGENTS",description:"How many subagents can be running in one session before the Agent tool refuses to spawn another (default: 20). Accepts a positive whole number in plain digits; anything else is ignored, so the variable can adjust the cap but can't disable it. Requires Claude Code v2.1.217 or later",kind:"string"},{name:"CLAUDE_CODE_MAX_CONTEXT_TOKENS",description:"Override the context window size Claude Code assumes for the active model. As of v2.1.193, how it applies depends on how Claude Code resolves the model ID; see Correct the window for a gateway or custom model ID\u2026",kind:"string"},{name:"CLAUDE_CODE_MAX_MCP_DESCRIPTION_LENGTH",description:"Maximum length in characters of MCP tool descriptions and MCP server instructions that Claude Code sends to the model. The value you set replaces both default limits: 4096, and 16384 for the description of a tool that Claude loads through tool search. Accepts a positive whole number in plain digits\u2026",kind:"string"},{name:"CLAUDE_CODE_MAX_OUTPUT_TOKENS",description:"Set the maximum number of output tokens for most requests. Defaults and caps vary by model; see max output tokens. Claude Code lowers a value above a model's cap to the cap. For a model ID Claude Code can't resolve to a model it knows, the default is 32000 and the cap is 128000\u2026",kind:"number"},{name:"CLAUDE_CODE_MAX_RETRIES",description:"Override the number of times to retry failed API requests (default: 10). Retrying can stop earlier on 529 overloaded errors. For example, with an API key on an Opus model, it stops at the third 529 and shows Repeated 529 Overloaded errors. If you set a fallback model\u2026",kind:"number"},{name:"CLAUDE_CODE_MAX_SUBAGENTS_PER_SESSION",description:"Removed in v2.1.224 and now a no-op. Previously capped the total number of subagents Claude could spawn with the Agent tool in one session (default: 200); spawning past the cap failed with Subagent spawn limit reached. The concurrent subagent limit and the depth limit still apply",kind:"number"},{name:"CLAUDE_CODE_MAX_SUBAGENT_SPAWN_DEPTH",description:"Number of subagent layers allowed below the main conversation (default: 3). At the default, subagents can spawn their own subagents, and a subagent at the third layer can't spawn further; set 1 to turn nesting off. In v2.1.217 through v2.1.218, the default was 1\u2026",kind:"boolean"},{name:"CLAUDE_CODE_MAX_TURNS",description:"Cap the number of agentic turns when no explicit limit is passed. Equivalent to passing --max-turns, which takes precedence when both are set. A value that is not a positive integer is rejected at startup with an error rather than treated as no cap",kind:"number"},{name:"CLAUDE_CODE_MAX_WEB_SEARCHES_PER_SESSION",description:"Cap on WebSearch calls (default: 200). When Claude reaches the cap, further WebSearch calls return a notice telling it to continue with the information it already gathered and say so in its answer. Accepts a positive whole number with no upper bound. Anything else is ignored and the default applies\u2026",kind:"string"},{name:"CLAUDE_CODE_MCP_ALLOWLIST_ENV",description:"Set to 1 to spawn stdio MCP servers with only a safe baseline environment plus the server's configured env, instead of inheriting your shell environment",kind:"boolean"},{name:"CLAUDE_CODE_MCP_AUTO_BACKGROUND_MS",description:"Elapsed time in milliseconds before a still-running MCP tool call moves to a background task (default: 120000, or 2 minutes). Set to 0 to turn automatic backgrounding off. Requires Claude Code v2.1.212 or later",kind:"boolean"},{name:"CLAUDE_CODE_MCP_STARTUP_WAIT_MS",description:"How long in milliseconds the first turn of a non-interactive session waits for MCP servers that are still connecting, in place of the default first-turn wait. In a self-hosted environment, it changes only how long the wait lasts. Some servers keep a wait of their own regardless of the value\u2026",kind:"boolean"},{name:"CLAUDE_CODE_MCP_TOOL_IDLE_TIMEOUT",description:"Idle timeout in milliseconds for MCP tool calls. When a stdio, HTTP, SSE, WebSocket, or claude.ai connector MCP server sends no response and no progress notification for this long, the tool call aborts with an error instead of waiting for the overall MCP_TOOL_TIMEOUT\u2026",kind:"boolean"},{name:"CLAUDE_CODE_MESSAGING_SOCKET",description:"Set by Claude Code, not by you: in sessions that bind an inbox socket, Claude Code exports that socket's path to hooks and Bash commands when it binds the socket. In a session that starts with messaging on, Claude Code binds the socket before any hook runs. Other sessions on the machine deliver messages to this path\u2026",kind:"path"},{name:"CLAUDE_CODE_MESSAGING_TOKEN",description:'Set by Claude Code, not by you: in sessions that bind an inbox socket, Claude Code exports this per-session token to hooks and Bash commands alongside CLAUDE_CODE_MESSAGING_SOCKET. A script posting to the socket can send {"type":"auth","token":"<token>"} as its first line to prove it belongs to the session\u2026',kind:"string"},{name:"CLAUDE_CODE_NATIVE_CURSOR",description:"Set to 1 to show the terminal's own cursor at the input caret instead of a drawn block. The cursor respects the terminal's blink, shape, and focus settings. Setting 0 reads the same as leaving the variable unset, so it doesn't bring the drawn block back in a session where the terminal's own cursor is already on",kind:"boolean"},{name:"CLAUDE_CODE_NEW_INIT",description:"Set to 1 to make /init run an interactive setup flow. The flow asks which files to generate, including CLAUDE.md, skills, and hooks, before exploring the codebase and writing them. Without this variable, /init generates a CLAUDE.md automatically without prompting",kind:"boolean"},{name:"CLAUDE_CODE_NONBLOCKING_STDOUT",description:"Set to 1 to write terminal output through a second non-blocking file descriptor, so a terminal that stops reading, such as a paused tmux control-mode pane or a stalled SSH connection, can't freeze Claude Code mid-session. Applies on macOS, Linux, and WSL when stdout is a terminal. Requires Claude Code v2.1.261 or later",kind:"boolean"},{name:"CLAUDE_CODE_NONSTREAMING_TIMEOUT_RETRIES",description:"Limit how many times Claude Code re-sends a non-streaming request that times out. With 0, the request fails on the first timeout. See Tune retry behavior for the timeout. Requires Claude Code v2.1.285 or later",kind:"number"},{name:"CLAUDE_CODE_NO_FLICKER",description:"Set to 1 to enable fullscreen rendering, a research preview that reduces flicker and keeps memory flat in long conversations. Overrides the tui setting; you can also switch with /tui fullscreen",kind:"boolean"},{name:"CLAUDE_CODE_OAUTH_REFRESH_TOKEN",description:"OAuth refresh token for Claude.ai authentication. When set, claude auth login exchanges this token directly instead of opening a browser. Requires CLAUDE_CODE_OAUTH_SCOPES. Useful for provisioning authentication in automated environments",kind:"string"},{name:"CLAUDE_CODE_OAUTH_SCOPES",description:'Space-separated OAuth scopes the refresh token was issued with, such as "user:profile user:inference user:sessions:claude_code". Required when CLAUDE_CODE_OAUTH_REFRESH_TOKEN is set',kind:"string"},{name:"CLAUDE_CODE_OAUTH_TOKEN",description:"OAuth access token for claude.ai authentication. Alternative to /login for SDK and automated environments. Takes precedence over keychain-stored credentials. Generate one with claude setup-token. Unless you run /login, Claude Code uses the token you set for the whole session. To replace an expired token\u2026",kind:"string"},{name:"CLAUDE_CODE_OPUS_4_6_FAST_MODE_OVERRIDE",description:"Removed in v2.1.160 and now a no-op. Previously pinned fast mode to Claude Opus 4.6 instead of the current default. Opus 4.6 no longer supports fast mode",kind:"string"},{name:"CLAUDE_CODE_OTEL_CONTENT_MAX_LENGTH",description:"Maximum length of content-bearing OpenTelemetry attributes (model responses, tool content, system prompts, raw API bodies), truncation marker included, in UTF-16 code units (default: 61440, i.e. 60 KB). Raise it only if your telemetry backend accepts attribute values larger than 64 KB\u2026",kind:"string"},{name:"CLAUDE_CODE_OTEL_DIAG_STDERR",description:"Set to 1 to write OpenTelemetry exporter diagnostic errors to stderr. By default these errors only appear with --debug, so a misconfigured exporter such as a Prometheus port collision otherwise fails silently. Requires Claude Code v2.1.179 or later. See Monitoring",kind:"boolean"},{name:"CLAUDE_CODE_OTEL_FLUSH_TIMEOUT_MS",description:"Timeout in milliseconds for flushing pending OpenTelemetry spans (default: 5000). See Monitoring",kind:"number"},{name:"CLAUDE_CODE_OTEL_HEADERS_HELPER_DEBOUNCE_MS",description:"Interval for refreshing dynamic OpenTelemetry headers in milliseconds (default: 1740000 / 29 minutes). See Dynamic headers",kind:"number"},{name:"CLAUDE_CODE_OTEL_SHUTDOWN_TIMEOUT_MS",description:"Timeout in milliseconds for the OpenTelemetry exporter to finish on shutdown (default: 2000). Increase if metrics are dropped at exit. See Monitoring",kind:"number"},{name:"CLAUDE_CODE_OVERLOADED_RETRY_BASE_DELAY_MS",description:"Starting delay in milliseconds, in place of the default 500, of the exponential backoff between automatic retries of a request that the API rejects with a 529 overloaded error. Raise it to spread the retries over a longer window when the API is at capacity. Give whole milliseconds from 500 to 32000 in plain digits\u2026",kind:"boolean"},{name:"CLAUDE_CODE_OVERLOADED_RETRY_MAX_DELAY_MS",description:"Ceiling in milliseconds, in place of the default 32000, on the exponential backoff between automatic retries of a request that the API rejects with a 529 overloaded error. Raise it so that later retries keep spreading apart when the API is at capacity. Give whole milliseconds from 32000 to 64000 in plain digits\u2026",kind:"boolean"},{name:"CLAUDE_CODE_PACKAGE_MANAGER_AUTO_UPDATE",description:"Set to 1 to let Claude Code run your package manager's upgrade command in the background when a new version is available. Applies to Homebrew and WinGet installations. Other package managers continue to show the upgrade command without running it. See Auto updates",kind:"boolean"},{name:"CLAUDE_CODE_PERFORCE_MODE",description:"Set to 1 to enable Perforce-aware write protection. When set, Edit, Write, and NotebookEdit fail with a p4 edit <file> hint if the target file lacks the owner-write bit, which Perforce clears on synced files until p4 edit opens them. This prevents Claude Code from bypassing Perforce change tracking",kind:"boolean"},{name:"CLAUDE_CODE_PLUGIN_CACHE_DIR",description:"Override the plugins root directory. Despite the name, this sets the parent directory, not the cache itself: marketplaces and the plugin cache live in subdirectories under this path. Defaults to ~/.claude/plugins",kind:"path"},{name:"CLAUDE_CODE_PLUGIN_DIRS",description:"Plugin directories to load for the session, each loaded the way a --plugin-dir flag loads it. Separate multiple paths with : on Unix or ; on Windows. Give each path as an absolute path or start it with ~, because Claude Code skips relative paths. Requires Claude Code v2.1.280 or later. See Load a plugin for one session",kind:"path"},{name:"CLAUDE_CODE_PLUGIN_DIR_WATCH",description:"Controls whether Claude Code reloads a mod when the mod's files change. Reloading applies to a mod you load from a directory with --plugin-dir, and it's on by default in interactive sessions. Set to 1 to turn it on in non-interactive sessions as well, or 0 to turn it off in every session\u2026",kind:"boolean"},{name:"CLAUDE_CODE_PLUGIN_GIT_TIMEOUT_MS",description:"Timeout in milliseconds for cloning or refreshing a plugin marketplace (default: 120000). Increase this value for large repositories or slow network connections. See Git clone timed out",kind:"number"},{name:"CLAUDE_CODE_PLUGIN_KEEP_MARKETPLACE_ON_FAILURE",description:"Set to 1 to skip the re-clone attempt and keep using the existing marketplace checkout when a marketplace refresh can't reach or authenticate to the remote. Useful in offline or airgapped environments where re-cloning would fail the same way. See Marketplace updates fail in offline environments",kind:"boolean"},{name:"CLAUDE_CODE_PLUGIN_PREFER_HTTPS",description:"Set to 1 to clone GitHub owner/repo shorthand sources over HTTPS instead of SSH. Applies to plugin install and update, and to /plugin marketplace add and update. Useful in CI runners, containers, or any environment without a configured SSH key for github.com",kind:"boolean"},{name:"CLAUDE_CODE_PLUGIN_SEED_DIR",description:"Path to one or more read-only plugin seed directories, separated by : on Unix or ; on Windows. Use this to bundle a pre-populated plugins directory into a container image. Claude Code registers marketplaces from these directories at startup and uses pre-cached plugins without re-cloning\u2026",kind:"path"},{name:"CLAUDE_CODE_POWERSHELL_RESPECT_EXECUTION_POLICY",description:"Set to 1 to stop Claude Code from passing -ExecutionPolicy Bypass when spawning PowerShell for tool calls, hooks, and status line commands, and respect the machine's effective execution policy instead\u2026",kind:"boolean"},{name:"CLAUDE_CODE_PRINT_BG_WAIT_CEILING_MS",description:"Ceiling in milliseconds on idle waiting for background work, such as subagents and workflows, after the final turn in non-interactive mode with the -p flag. Idle waiting starts over each time Claude takes a turn to handle a background result. Default: 600000, or 10 minutes. When idle waiting reaches the ceiling\u2026",kind:"boolean"},{name:"CLAUDE_CODE_PROCESS_WRAPPER",description:"Launch the processes Claude Code starts from its own binary, such as the background service that hosts agent view sessions, through a corporate launcher given as an argv prefix like /opt/corp/launcher. Set it in the env block of user or managed settings, not as a shell export\u2026",kind:"string"},{name:"CLAUDE_CODE_PROJECT_DIR_NAME",description:"Set together with CLAUDE_CONFIG_DIR to choose the projects/ directory name Claude Code stores that session's transcripts and auto memory under, in place of one derived from the working directory path. For example\u2026",kind:"path"},{name:"CLAUDE_CODE_PROMPT_CACHE_TTL",description:"Set 5m or 1h, the only values Claude Code accepts, to choose the prompt cache TTL for the main conversation: your interactive, -p, and SDK turns, plus the helpers that run inline with them. Takes precedence over the promptCacheTtl setting and over ENABLE_PROMPT_CACHING_1H, and FORCE_PROMPT_CACHING_5M overrides it\u2026",kind:"string"},{name:"CLAUDE_CODE_PROPAGATE_TRACEPARENT",description:"Set to 1 to propagate W3C trace context when ANTHROPIC_BASE_URL points at a custom proxy. Propagation covers the traceparent header on model and HTTP MCP requests and the TRACEPARENT environment variable for Bash, PowerShell, and hook subprocesses. By default\u2026",kind:"boolean"},{name:"CLAUDE_CODE_PROVIDER_MANAGED_BY_HOST",description:"Set by host platforms that embed Claude Code and manage model provider routing on its behalf. When set, Claude Code ignores provider-selection, endpoint, and authentication variables such as CLAUDE_CODE_USE_BEDROCK, ANTHROPIC_BASE_URL, and ANTHROPIC_API_KEY in settings files\u2026",kind:"string"},{name:"CLAUDE_CODE_PROXY_RESOLVES_HOSTS",description:"Set to 1 to allow the proxy to perform DNS resolution instead of the caller. Opt-in for environments where the proxy should handle hostname resolution",kind:"boolean"},{name:"CLAUDE_CODE_REMOTE",description:"Set automatically to true when Claude Code is running as a cloud session. Read this from a hook or setup script to detect whether you are in a cloud session",kind:"string"},{name:"CLAUDE_CODE_REMOTE_SESSION_ID",description:"Set automatically in cloud sessions to the current session's ID. Read this to construct a link back to the session transcript. See Link output back to the session",kind:"string"},{name:"CLAUDE_CODE_RESTRICTED",description:"Set to 1 to start the session in restricted mode, the same as passing --restricted. Claude Code ignores this variable in a settings file's env block. Requires Claude Code v2.1.248 or later",kind:"boolean"},{name:"CLAUDE_CODE_RESUME_INTERRUPTED_TURN",description:"Set to 1 to automatically resume if the previous session ended mid-turn. Used in SDK mode so the model continues without requiring the SDK to re-send the prompt. To turn this off, unset the variable or set it to 0. For the VS Code chat panel, see Continue conversations after a reload",kind:"boolean"},{name:"CLAUDE_CODE_RESUME_INTERRUPTED_TURN_MAX_AGE_MS",description:"Maximum age in milliseconds of the last transcript message for a session that ended mid-turn to continue automatically on resume. When the last message is older than this bound, Claude Code skips the CLAUDE_CODE_RESUME_INTERRUPTED_TURN automatic resume and its CLAUDE_CODE_RESUME_PROMPT continuation message\u2026",kind:"boolean"},{name:"CLAUDE_CODE_RESUME_PROMPT",description:"Override the continuation message Claude Code sends to Claude when CLAUDE_CODE_RESUME_INTERRUPTED_TURN continues an interrupted turn instead of resending its prompt, or when you resume a deferred tool call with -p. Defaults to Continue from where you left off.. An empty string uses the default",kind:"string"},{name:"CLAUDE_CODE_RETRY_WATCHDOG",description:"Set to 1 for unattended sessions such as eval harnesses, CI jobs, or remote workers. Retries 429 and 529 capacity errors indefinitely instead of failing after CLAUDE_CODE_MAX_RETRIES attempts. Claude Code fails at once when a standard-speed request gets a 429 that reports a spend limit or exhausted usage credits\u2026",kind:"boolean"},{name:"CLAUDE_CODE_RETRY_WATCHDOG_MAX_WAIT_MS",description:"Maximum time in milliseconds that each API request spends waiting out 429 and 529 errors when CLAUDE_CODE_RETRY_WATCHDOG is set. Once that time is spent, the next such error ends the request. Give a positive whole number in plain digits, such as 1800000 for 30 minutes. When unset, the wait has no limit\u2026",kind:"number"},{name:"CLAUDE_CODE_RETRY_WATCHDOG_USAGE_LIMIT_RECHECK_MS",description:"Minimum interval in milliseconds between checks of whether a usage limit was already lifted, while a request waits for that limit to reset with CLAUDE_CODE_RETRY_WATCHDOG set. When a check finds the limit lifted, the request goes out at once. Give a whole number in plain digits from 60000, one minute, to 10800000\u2026",kind:"number"},{name:"CLAUDE_CODE_SAFE_MODE",description:"Set to 1 to start in safe mode: CLAUDE.md, skills, plugins, hooks, MCP servers, custom commands and agents, output styles, workflows, custom themes, custom keybindings, status line and file-suggestion commands, LSP servers, and auto memory do not load, for troubleshooting a broken configuration\u2026",kind:"boolean"},{name:"CLAUDE_CODE_SCRIPT_CAPS",description:'JSON object limiting how many times specific scripts may be invoked per session when CLAUDE_CODE_SUBPROCESS_ENV_SCRUB is set. Keys are substrings matched against the command text; values are integer call limits. For example, {"deploy.sh": 2} allows deploy.sh to be called at most twice\u2026',kind:"string"},{name:"CLAUDE_CODE_SCROLL_SPEED",description:"Set the mouse wheel scroll multiplier in fullscreen rendering. Accepts any positive value up to 20, including fractional values below 1 such as 0.5 to slow accelerated trackpad and wheel scrolling in terminals that already amplify wheel events\u2026",kind:"string"},{name:"CLAUDE_CODE_SEND_FEEDBACK",description:"Set to 0 to turn off Claude-drafted feedback for a session. Set to 1 to turn it on where your account already has access; the variable can't grant access itself, and the other switches that turn feedback off, such as DISABLE_FEEDBACK_COMMAND and the feedbackDrafts setting's off value, still apply",kind:"boolean"},{name:"CLAUDE_CODE_SESSIONEND_HOOKS_TIMEOUT_MS",description:"Override the time budget in milliseconds for SessionEnd hooks. The value is also the timeout for each hook that sets no timeout of its own. Applies to session exit, /clear, and switching sessions via interactive /resume. By default the budget is 1.5 seconds\u2026",kind:"number"},{name:"CLAUDE_CODE_SESSION_ID",description:"Set automatically to the current session ID in Bash and PowerShell tool subprocesses, hook command subprocesses, and stdio MCP server subprocesses. For Bash, PowerShell, and hooks this matches the session_id field in the hook JSON input and is updated on /clear\u2026",kind:"string"},{name:"CLAUDE_CODE_SHELL",description:"Set the shell Claude Code uses to run Bash tool commands. Accepts a path to a bash or zsh binary, for example /opt/homebrew/bin/bash. Other shells such as fish are not supported. If the value is not a working bash or zsh path, Claude Code ignores it and falls back to auto-detection\u2026",kind:"path"},{name:"CLAUDE_CODE_SHELL_PREFIX",description:"Command prefix that wraps shell commands Claude Code spawns: Bash tool calls, hook commands, status line commands, and stdio MCP server startup commands. PowerShell hooks and exec-form hooks run without the prefix. Useful for logging or auditing\u2026",kind:"path"},{name:"CLAUDE_CODE_SIMPLE",description:"Set to 1 to run with a minimal system prompt and only the Bash, file read, and file edit tools. MCP tools from --mcp-config are still available. Disables auto-discovery of hooks, skills, custom commands, subagents, installed plugins, MCP servers, auto memory, and CLAUDE.md\u2026",kind:"boolean"},{name:"CLAUDE_CODE_SIMPLE_SYSTEM_PROMPT",description:"Choose between Claude Code's full system prompt and a shorter one with abbreviated tool descriptions. When unset, Haiku 4.5, Sonnet 5, Opus 4.7, and earlier models in those families use the full prompt by default, and newer models use the shorter one. Set to 1 to use the shorter prompt on any model. Set to 0, false\u2026",kind:"boolean"},{name:"CLAUDE_CODE_SKIP_ANTHROPIC_AWS_AUTH",description:"Skip client-side authentication for Claude Platform on AWS, for gateways that sign requests themselves",kind:"string"},{name:"CLAUDE_CODE_SKIP_AWS_CRED_CACHE",description:"Set to 1 to turn off the in-process cache of credentials resolved from the AWS default credential provider chain, so Claude Code resolves the chain on every API request. With the cache off, an SSO-backed profile requests credentials from IAM Identity Center on every request\u2026",kind:"boolean"},{name:"CLAUDE_CODE_SKIP_BEDROCK_AUTH",description:"Skip AWS authentication for Amazon Bedrock (for example, when using an LLM gateway)",kind:"string"},{name:"CLAUDE_CODE_SKIP_FAST_MODE_NETWORK_ERRORS",description:`Set to 1 to treat a failed fast mode availability check as available, for networks that block the check's direct request to api.anthropic.com. Claude Code still honors a "disabled by your organization" response`,kind:"boolean"},{name:"CLAUDE_CODE_SKIP_FAST_MODE_ORG_CHECK",description:"Set to 1 to skip the client-side fast mode availability check, for proxies that intercept the check's request rather than refuse it. The API still rejects fast mode requests when your organization has fast mode disabled",kind:"boolean"},{name:"CLAUDE_CODE_SKIP_FOUNDRY_AUTH",description:"Skip Azure authentication for Microsoft Foundry, for a proxy or gateway that injects its own Authorization header. Claude Code sends requests without an Azure credential and preserves the Authorization header you supply, for example through ANTHROPIC_CUSTOM_HEADERS\u2026",kind:"string"},{name:"CLAUDE_CODE_SKIP_MANTLE_AUTH",description:"Skip AWS authentication for Amazon Bedrock Mantle (for example, when using an LLM gateway)",kind:"string"},{name:"CLAUDE_CODE_SKIP_MODEL_ACCESS_MEMORY",description:"The startup model checks on Amazon Bedrock and Google Cloud's Agent Platform remember on this machine which models they found your account can't invoke, for up to a day. Set to 1 to turn that memory off. Requires Claude Code v2.1.285 or later",kind:"boolean"},{name:"CLAUDE_CODE_SKIP_PROMPT_HISTORY",description:"Set to 1 to skip writing prompt history and session transcripts to disk. Sessions started with this variable set do not appear in --resume, --continue, or up-arrow history. Useful for ephemeral scripted sessions",kind:"boolean"},{name:"CLAUDE_CODE_SKIP_VERTEX_AUTH",description:"Skip Google authentication for Google Cloud's Agent Platform (for example, when using an LLM gateway)",kind:"string"},{name:"CLAUDE_CODE_STARTUP_FAILURE_RESULTS",description:"Set to 1 to have a session started with --output-format stream-json write a result message naming why Claude Code refused to start for startup failures that otherwise end with stderr alone. Requires Claude Code v2.1.274 or later",kind:"boolean"},{name:"CLAUDE_CODE_STOP_HOOK_BLOCK_CAP",description:"Maximum number of consecutive times a Stop or SubagentStop hook may block the turn from ending before Claude Code overrides it and ends the turn anyway (default: 8). Set to 0 to disable the cap. Raise this if your hook legitimately needs more iterations to resolve",kind:"boolean"},{name:"CLAUDE_CODE_SUBAGENT_MODEL",description:"The default model for subagents, agent team teammates, and workflow agents that aren't assigned a model another way. Accepts an alias such as haiku or a full model name. Two sources take precedence over it: a model Claude passes when it spawns the agent, and a model field in the agent's definition, including inherit\u2026",kind:"string"},{name:"CLAUDE_CODE_SUBAGENT_MODEL_FORCE",description:"Set to 1 to force one model onto subagents, teammates, and workflow agents. Run every subagent on one model says which model that is. Requires Claude Code v2.1.257 or later",kind:"boolean"},{name:"CLAUDE_CODE_SUBAGENT_PROMPT_CACHE_TTL",description:"Set 5m or 1h, the only values Claude Code accepts, to choose the prompt cache TTL for requests outside the main conversation, such as subagents, workflows, and background work. Takes precedence over the subagentPromptCacheTtl setting and over ENABLE_PROMPT_CACHING_1H, and FORCE_PROMPT_CACHING_5M overrides it\u2026",kind:"string"},{name:"CLAUDE_CODE_SUBPROCESS_ENV_SCRUB",description:"Set to 1 to strip credentials from the environments of the subprocesses Claude Code starts, such as Bash commands, hooks, and stdio MCP servers. The scrub recognizes a credential by its variable name or its value, and it leaves GitHub tokens and proxy settings in place\u2026",kind:"boolean"},{name:"CLAUDE_CODE_SYNC_PLUGIN_INSTALL",description:"Set to 1 in non-interactive mode (the -p flag) to wait for plugin installation to complete before the first query. Without this, plugins install in the background and may not be available on the first turn. Combine with CLAUDE_CODE_SYNC_PLUGIN_INSTALL_TIMEOUT_MS to bound the wait",kind:"boolean"},{name:"CLAUDE_CODE_SYNC_PLUGIN_INSTALL_TIMEOUT_MS",description:"Timeout in milliseconds for synchronous plugin installation. When exceeded, Claude Code proceeds without plugins and logs an error. No default: without this variable, synchronous installation waits until complete",kind:"number"},{name:"CLAUDE_CODE_SYNC_SKILLS",description:"Set to 1 in non-interactive mode with the -p flag to make Claude Code download the skills enabled for your claude.ai account in that run and wait for the list of them, up to CLAUDE_CODE_SYNC_SKILLS_WAIT_TIMEOUT_MS, before it runs the first query. Requires claude.ai authentication\u2026",kind:"boolean"},{name:"CLAUDE_CODE_SYNC_SKILLS_INSTALL_TIMEOUT_MS",description:"Timeout in milliseconds for the skills resync that runs mid-session when an app built on the Agent SDK reloads skills (default: 30000). When exceeded, the reload continues with whichever skills have arrived, and the remaining downloads finish in the background",kind:"number"},{name:"CLAUDE_CODE_SYNC_SKILLS_WAIT_TIMEOUT_MS",description:"Timeout in milliseconds for the first query to wait for the initial skill list when CLAUDE_CODE_SYNC_SKILLS is set (default: 5000). When exceeded, the first query runs with whichever skills have arrived. The downloads finish in the background either way\u2026",kind:"number"},{name:"CLAUDE_CODE_SYNTAX_HIGHLIGHT",description:"Set to false to disable syntax highlighting in diff output. Useful when colors interfere with your terminal setup. To also disable highlighting in code blocks and file previews, use the syntaxHighlightingDisabled setting",kind:"string"},{name:"CLAUDE_CODE_TASK_LIST_ID",description:"Share a task list across sessions. Set the same ID in multiple Claude Code instances to coordinate on a shared task list, in sessions that have the Task tools. See Task list",kind:"string"},{name:"CLAUDE_CODE_TMPDIR",description:"Override the temp directory used for internal temp files. Claude Code appends /claude-{uid}/ to this path on Unix, or /claude/ on Windows. Default: /tmp on macOS, os.tmpdir() on Linux and Windows. On macOS and Linux\u2026",kind:"path"},{name:"CLAUDE_CODE_TMUX_TRUECOLOR",description:"Set to any non-empty value, such as 1, to allow 24-bit truecolor output inside tmux. Setting it to 0 or false still allows truecolor, unlike most on/off variables; unset the variable to restore the 256-color clamp. By default\u2026",kind:"boolean"},{name:"CLAUDE_CODE_TOOL_MEMORY_CGROUP_EXCLUDE",description:"On Linux and WSL, set to a comma-separated list of the kinds of processes Claude Code excludes from the tool memory cap, such as mcp or lsp. Set none to cap every kind, or all-new to cap only Bash, PowerShell, and Monitor tool commands. Claude Code keeps Bash, PowerShell\u2026",kind:"list"},{name:"CLAUDE_CODE_TOOL_MEMORY_LIMIT",description:"On Linux and WSL, set to a size such as 4G to cap the memory that Bash and PowerShell tool commands can use, and Monitor tool commands on v2.1.246 or later. Write the size in plain digits, alone for a number of bytes or with a K, M, G, or T suffix. Set 0 or off to turn the cap off\u2026",kind:"boolean"},{name:"CLAUDE_CODE_TRANSCRIPT_LOCAL_GC",description:"Set to 1 to limit how large the transcript file of a long -p or Agent SDK session grows. After each compaction, once the file is larger than 5 MB, Claude Code removes the history from before that compaction. Resuming the session restores the same conversation whether or not the file was trimmed\u2026",kind:"boolean"},{name:"CLAUDE_CODE_USER_DIALOG_TIMEOUT_MS",description:"Deadline in milliseconds before Claude Code cancels a dialog it forwards to a remote client such as a Remote Control or SDK host, or the approval dialog for a held cross-session message; permission prompts and AskUserQuestion questions use their own flows and aren't governed by it. On Claude Code v2.1.236 or later\u2026",kind:"boolean"},{name:"CLAUDE_CODE_USE_ANTHROPIC_AWS",description:"Use Claude Platform on AWS",kind:"string"},{name:"CLAUDE_CODE_USE_BEDROCK",description:"Use Amazon Bedrock",kind:"string"},{name:"CLAUDE_CODE_USE_FOUNDRY",description:"Use Microsoft Foundry",kind:"string"},{name:"CLAUDE_CODE_USE_MANTLE",description:"Use the Amazon Bedrock Mantle endpoint",kind:"string"},{name:"CLAUDE_CODE_USE_POWERSHELL_TOOL",description:"Controls the PowerShell tool. On Windows without Git Bash, the tool is enabled automatically; set to 0 to disable it. On Windows with Git Bash installed, the tool is on by default for claude.ai and Console accounts; set to 1 to enable it in Amazon Bedrock, Google Cloud's Agent Platform, and Microsoft Foundry sessions\u2026",kind:"boolean"},{name:"CLAUDE_CODE_USE_VERTEX",description:"Use Google Cloud's Agent Platform",kind:"string"},{name:"CLAUDE_CODE_WEBFETCH_CACHE_TTL_MS",description:"Set to the number of milliseconds WebFetch keeps each fetched URL's response cached. The default is 900000, which is 15 minutes. Takes plain digits only; 0, a decimal, or any other spelling keeps the default. Claude Code reads the value once per launch\u2026",kind:"boolean"},{name:"CLAUDE_CODE_WEBFETCH_DEADLINE_MS",description:"Upper bound in milliseconds on how long WebFetch waits for a page to download, including any redirects it follows. A download that hasn't completed by then fails with a deadline error. The default is 300000, which is five minutes. Set to 0 to remove the limit. Takes plain digits only\u2026",kind:"boolean"},{name:"CLAUDE_CODE_WEB_SEARCH_REFILLS_PER_HOUR",description:"Rate at which a session's WebSearch limit refills, in calls per hour. The default is 100 in an interactive terminal session. In a non-interactive session the default is 0, which turns refill off. Takes plain digits only; any other spelling reads as unset. Requires Claude Code v2.1.290 or later",kind:"boolean"},{name:"CLAUDE_CODE_WORKER_CHECKIN_SCHEDULE",description:"When CLAUDE_AUTO_BACKGROUND_TASKS is set to 1, how long Claude Code waits before each reminder to Claude to check on background subagents that are still running. Takes one or more comma-separated waits in whole seconds from 1 to 86400, such as 600 or 600,1800,3600. Each value is the wait before the next reminder\u2026",kind:"boolean"},{name:"CLAUDE_CODE_WORKFLOW_MAX_CONCURRENT_AGENTS",description:"How many agents a single workflow run executes at once, from 1 to 256. By default, a run executes up to 16 agents at once, fewer when Claude Code has fewer CPUs available; queued agent() calls wait for a free slot. Each running agent's transcript stays in Claude Code's memory, so higher values raise memory use\u2026",kind:"string"},{name:"CLAUDE_CODE_WORKFLOW_PREFIX_STAGGER_MS",description:"Upper bound in milliseconds on how long a workflow agent waits for a same-prefix sibling's first response to begin before sending its own first request. When a fan-out starts several agents that share a prompt-cache prefix\u2026",kind:"boolean"},{name:"CLAUDE_CODE_YOU_SHOULD_KNOW_DEBUG",description:"Set to 1 to show, above the prompt, a line for each of the last three checks the You should know mod made in this session. Use it to confirm the mod is checking when no notes appear. Requires Claude Code v2.1.287 or later",kind:"boolean"},{name:"CLAUDE_CONFIG_DIR",description:"Override the configuration directory (default: ~/.claude). All settings, session history, and plugins are stored under this path. For credentials, see where Claude Code stores credentials. Useful for running multiple accounts side by side: for example, alias claude-work='CLAUDE_CONFIG_DIR=~/.claude-work claude'\u2026",kind:"path"},{name:"CLAUDE_EFFORT",description:"Set automatically in Bash tool subprocesses and hook commands to the effort level in effect when the subprocess starts: low, medium, high, xhigh, or max. Matches the effort.level field passed to hooks. Only set when the current model supports the effort parameter",kind:"string"},{name:"CLAUDE_ENABLE_BYTE_WATCHDOG",description:"Set to 1 to force-enable the byte-level streaming idle watchdog, or set to 0 to force-disable it. 0 also turns off the first-byte deadline on the connections where that deadline runs. When unset, the watchdog is enabled by default for direct Anthropic API and Claude Platform on AWS connections\u2026",kind:"boolean"},{name:"CLAUDE_ENABLE_BYTE_WATCHDOG_BEDROCK",description:"Set to 1 to enable the byte-level streaming idle watchdog on Amazon Bedrock vnd.amazon.eventstream responses, which also enables the first-byte deadline on Bedrock streaming requests. Off by default. Configure the timeout with CLAUDE_STREAM_IDLE_TIMEOUT_MS",kind:"boolean"},{name:"CLAUDE_ENABLE_STREAM_WATCHDOG",description:"Set to 0 to force-disable the event-level streaming idle watchdog, or set to 1 to force-enable it. When unset, the watchdog is on by default for all providers. Before v2.1.196, the unset default was server-controlled on the direct Anthropic API and off on other providers\u2026",kind:"boolean"},{name:"CLAUDE_ENV_FILE",description:"Path to a shell script whose contents Claude Code runs before each Bash command in the same shell process, so exports in the file are visible to the command. Use to persist virtualenv or conda activation across commands. PowerShell commands receive its variables too, in v2.1.296 or later\u2026",kind:"path"},{name:"CLAUDE_JOB_DIR",description:"Set by Claude Code in each background session to that session's ~/.claude/jobs/<id> directory. Shell commands that the session runs inherit it. Write scratch files to $CLAUDE_JOB_DIR/tmp. Claude's Write and Edit calls there don't prompt for permission, and the directory is removed when the session is deleted",kind:"path"},{name:"CLAUDE_PID",description:"Claude Code sets this to its own process ID in the subprocesses it spawns: Bash and PowerShell tool commands and hook commands. On Linux, the Bash tool's shell integration uses it to refuse a pkill pattern that would match the Claude Code process itself; see the error reference\u2026",kind:"string"},{name:"CLAUDE_REMOTE_CONTROL_SESSION_NAME_PREFIX",description:"Prefix for auto-generated Remote Control session names when no explicit name is provided. Defaults to your machine's hostname, producing names like myhost-graceful-unicorn. The --remote-control-session-name-prefix CLI flag sets the same value for a single invocation",kind:"string"},{name:"CLAUDE_STREAM_FIRST_BYTE_TIMEOUT_MS",description:"Deadline in milliseconds for the first response byte of a streaming request, on the connections where the first-byte deadline runs. For how Claude Code clamps it, the extra time it adds for large request bodies, and how it picks the deadline when you leave this unset, see No response from API\u2026",kind:"number"},{name:"CLAUDE_STREAM_IDLE_TIMEOUT_MS",description:"Timeout in milliseconds before the event- and byte-level streaming idle watchdogs close a stalled connection. When you set this variable explicitly, the minimum is 300000 (5 minutes); lower values are silently clamped to absorb extended thinking pauses and proxy buffering\u2026",kind:"number"},{name:"CLAUDE_SUBAGENT_BG_SHELL_MAX_MS",description:"Removed in v2.1.260 and now a no-op. Previously capped how long a background shell command that a subagent started could run, in milliseconds, with a 60-minute default. See the background command lifetime rules",kind:"number"},{name:"DEBUG",description:"Set to 1 to enable debug mode, equivalent to launching with --debug. Debug logs are written to ~/.claude/debug/<session-id>.txt, or to the path set by CLAUDE_CODE_DEBUG_LOGS_DIR. Only the truthy values 1, true, yes, and on enable debug mode\u2026",kind:"boolean"},{name:"DISABLE_AUTOUPDATER",description:"Set to 1 to disable automatic background updates. Manual claude update still works. Use DISABLE_UPDATES to block both",kind:"boolean"},{name:"DISABLE_AUTO_COMPACT",description:"Set to 1 to disable automatic compaction when approaching the context limit, along with idle compaction. The manual /compact command remains available. Use when you want explicit control over when compaction occurs. Overrides the autoCompactEnabled setting",kind:"boolean"},{name:"DISABLE_COMPACT",description:"Set to 1 to disable all compaction: both automatic compaction and the manual /compact command",kind:"boolean"},{name:"DISABLE_COST_WARNINGS",description:"Set to 1 to disable cost warning messages",kind:"boolean"},{name:"DISABLE_DOCTOR_COMMAND",description:"Set to 1 to hide the /doctor setup checkup skill and its /checkup alias. Useful for managed deployments where users shouldn't run setup diagnostics from a session. Doesn't affect the claude doctor terminal command. Before v2.1.205, this variable hid the /doctor diagnostics screen command",kind:"boolean"},{name:"DISABLE_ERROR_REPORTING",description:"Set to any non-empty value, such as 1, to opt out of error reporting. Setting it to 0 or false still opts out, unlike most on/off variables; unset the variable to turn error reporting back on",kind:"boolean"},{name:"DISABLE_EXTRA_USAGE_COMMAND",description:"Set to 1 to hide the /usage-credits command that lets users purchase additional usage beyond rate limits",kind:"boolean"},{name:"DISABLE_FEEDBACK_COMMAND",description:"Set to 1 to disable the /feedback command and Claude-drafted feedback. Also disables /bug and /share, which report through the same path; before v2.1.212 they were aliases of /feedback, so the command was disabled under every name. The older name DISABLE_BUG_COMMAND is also accepted",kind:"boolean"},{name:"DISABLE_GROWTHBOOK",description:"Set to 1 or true to disable GrowthBook feature-flag fetching and use code defaults for every flag. This makes Remote Control and the other features that need feature-flag fetching unavailable. Setting it to 0 or false leaves fetching on. Telemetry event logging stays on unless DISABLE_TELEMETRY is also set",kind:"boolean"},{name:"DISABLE_INSTALLATION_CHECKS",description:"Set to 1 to disable installation warnings. Use only when manually managing the installation location, as this can mask issues with standard installations",kind:"boolean"},{name:"DISABLE_INSTALL_GITHUB_APP_COMMAND",description:"Set to 1 to hide the /install-github-app command. Already hidden when using third-party providers (Amazon Bedrock, Google Cloud's Agent Platform, or Microsoft Foundry)",kind:"boolean"},{name:"DISABLE_INTERLEAVED_THINKING",description:"Set to 1 to prevent sending the interleaved-thinking beta header. Useful when your LLM gateway or provider does not support interleaved thinking",kind:"boolean"},{name:"DISABLE_LOGIN_COMMAND",description:"Set to 1 to hide the /login command. Useful when authentication is handled externally via API keys or apiKeyHelper",kind:"boolean"},{name:"DISABLE_LOGOUT_COMMAND",description:"Set to 1 to hide the /logout command",kind:"boolean"},{name:"DISABLE_PROMPT_CACHING",description:"Set to 1 to disable prompt caching for all models (takes precedence over per-model settings)",kind:"boolean"},{name:"DISABLE_PROMPT_CACHING_FABLE",description:"Set to 1 to disable prompt caching for Fable models",kind:"boolean"},{name:"DISABLE_PROMPT_CACHING_HAIKU",description:"Set to 1 to disable prompt caching for the default Haiku model, wherever it runs",kind:"boolean"},{name:"DISABLE_PROMPT_CACHING_OPUS",description:"Set to 1 to disable prompt caching for the default Opus model",kind:"boolean"},{name:"DISABLE_PROMPT_CACHING_SONNET",description:"Set to 1 to disable prompt caching for the default Sonnet model",kind:"boolean"},{name:"DISABLE_TELEMETRY",description:"Set to any non-empty value, such as 1, to opt out of telemetry. Setting it to 0 or false still opts out, unlike most on/off variables; unset the variable to turn telemetry back on. Telemetry events don't include user data like code, file paths, or Bash commands. Also disables feature-flag fetching\u2026",kind:"boolean"},{name:"DISABLE_UPDATES",description:"Set to 1 to block all updates including manual claude update and claude install. Stricter than DISABLE_AUTOUPDATER. Use when distributing Claude Code through your own channels and users should not self-update",kind:"boolean"},{name:"DISABLE_UPGRADE_COMMAND",description:"Set to 1 to hide the /upgrade command",kind:"boolean"},{name:"DO_NOT_TRACK",description:"Set to 1 to opt out of telemetry, with the same effect as DISABLE_TELEMETRY, including on feature-flag fetching. Claude Code reads this variable as a standard boolean, so 0 leaves telemetry on, and honors it as the cross-tool convention recognized by many developer CLIs",kind:"boolean"},{name:"ENABLE_BETA_TRACING_DETAILED",description:"Set to 1, and set BETA_TRACING_ENDPOINT to your OTLP/HTTP collector endpoint, to turn on detailed beta tracing, which adds content-bearing span attributes and the claude_code.hook span. Interactive CLI sessions also require your organization to be allowlisted for the beta\u2026",kind:"boolean"},{name:"ENABLE_CLAUDEAI_MCP_SERVERS",description:"Set to false to stop Claude Code from fetching claude.ai MCP servers. Enabled by default for logged-in users. To disable per-project or per-org, set disableClaudeAiConnectors in settings instead",kind:"string"},{name:"ENABLE_PROMPT_CACHING_1H",description:"Set to 1 to request a 1-hour prompt cache TTL instead of the default 5 minutes. Intended for API key, Amazon Bedrock, Google Cloud's Agent Platform, Microsoft Foundry, and Claude Platform on AWS users. For subscription users within included usage\u2026",kind:"boolean"},{name:"ENABLE_PROMPT_CACHING_1H_BEDROCK",description:"Deprecated. Use ENABLE_PROMPT_CACHING_1H instead",kind:"string"},{name:"ENABLE_TOOL_SEARCH",description:"Controls MCP tool search. Unset or true defers MCP tools, except in the cases that keep tool search off. auto loads upfront when tool definitions fit within 10% of context. auto:N sets a custom threshold, such as auto:5 for 5%. false loads all tools upfront. If a gateway rejects tool search\u2026",kind:"string"},{name:"FORCE_AUTOUPDATE_PLUGINS",description:"Set to 1 to force plugin auto-updates even when the main auto-updater is disabled via DISABLE_AUTOUPDATER",kind:"boolean"},{name:"FORCE_HYPERLINK",description:"Set to 1 to enable clickable OSC 8 hyperlinks when your terminal supports them but isn't auto-detected, or 0 to disable them. When unset, Claude Code enables hyperlinks only when it detects terminal support. Claude Code parses this value as a number, not a Boolean, so a value such as false, no\u2026",kind:"boolean"},{name:"FORCE_PROMPT_CACHING_5M",description:"Set to 1 to force the 5-minute prompt cache TTL even when 1-hour TTL would otherwise apply. Overrides CLAUDE_CODE_PROMPT_CACHE_TTL, CLAUDE_CODE_SUBAGENT_PROMPT_CACHE_TTL, ENABLE_PROMPT_CACHING_1H, and the promptCacheTtl and subagentPromptCacheTtl settings",kind:"boolean"},{name:"HTTP_PROXY",description:"Specify HTTP proxy server for network connections",kind:"string"},{name:"HTTPS_PROXY",description:"Specify HTTPS proxy server for network connections",kind:"string"},{name:"IS_DEMO",description:"Set to any non-empty value, such as 1, to enable demo mode: hides your email and organization name from the header and /status output, and skips onboarding. Setting it to 0 or false still enables demo mode, unlike most on/off variables; unset the variable to turn it off. Useful when streaming or recording a session",kind:"boolean"},{name:"MAX_MCP_OUTPUT_TOKENS",description:"Maximum number of tokens allowed in MCP tool responses (default: 25000). Claude Code displays a warning when output exceeds 10,000 tokens. Tools that declare anthropic/maxResultSizeChars use that character limit for text content instead, but image content from those tools is still subject to this variable\u2026",kind:"number"},{name:"MAX_STRUCTURED_OUTPUT_RETRIES",description:"Number of attempts Claude Code allows when the model's response fails validation against the --json-schema in non-interactive mode with the -p flag; after that many failed attempts with no valid output, the run fails. The same cap applies when a workflow subagent's structured output fails validation. Defaults to 5\u2026",kind:"number"},{name:"MAX_THINKING_TOKENS",description:"Fixed token budget for extended thinking. Claude Code caps it at one token below the request's max output tokens and never below 1,024. See CLAUDE_CODE_MAX_OUTPUT_TOKENS for how that limit is set. When unset and thinking is enabled, models with adaptive reasoning choose their own thinking depth\u2026",kind:"boolean"},{name:"MCP_CLIENT_SECRET",description:"OAuth client secret for MCP servers that require pre-configured credentials. Avoids the interactive prompt when adding a server with --client-secret",kind:"string"},{name:"MCP_CONNECTION_NONBLOCKING",description:"Controls whether startup waits for MCP servers to connect before the first query. MCP startup is non-blocking by default: servers connect in the background and their tools become available as they finish. Set to 0 to make Claude Code wait for servers to connect before the first query\u2026",kind:"boolean"},{name:"MCP_CONNECT_TIMEOUT_MS",description:"How long blocking MCP startup waits, in milliseconds, for the connection batch before snapshotting the tool list (default: 5000). Applies when MCP_CONNECTION_NONBLOCKING=0 or for servers marked alwaysLoad: true. Servers still pending at the deadline keep connecting in the background. Distinct from MCP_TIMEOUT\u2026",kind:"number"},{name:"MCP_DISCOVERY_CACHE",description:"Turns the MCP discovery cache on or off. With the cache on, a remote HTTP or SSE server you've used before can show the cached status, and Claude Code connects it on its first tool call instead of at startup. The cache is off by default unless a gradual rollout has enabled it for your account. Set to 1 to turn it on\u2026",kind:"boolean"},{name:"MCP_DISCOVERY_CACHE_MAX_STALE_S",description:"Maximum age, in seconds, of a discovery-cache entry (default: 14400, or 4 hours). At a start where the entry is older than that, Claude Code discards it and connects the server at startup, as it does with the cache off. Claude Code caps the value at 7 days. Before v2.1.238, the default was 86400, or 24 hours\u2026",kind:"string"},{name:"MCP_DISCOVERY_CACHE_STRIKES",description:"At a start where a discovery-cache entry is older than MCP_DISCOVERY_CACHE_TTL_S, Claude Code refreshes it in the background. This variable sets how many refreshes in a row can fail before Claude Code discards the entry and connects the server at the next start instead (default: 1)\u2026",kind:"string"},{name:"MCP_DISCOVERY_CACHE_TTL_S",description:"Seconds for which Claude Code uses a discovery-cache entry without refreshing it (default: 900). At a start where the entry is older than that, Claude Code still uses it but refreshes it in the background. Once the entry is older than MCP_DISCOVERY_CACHE_MAX_STALE_S, Claude Code discards it instead\u2026",kind:"string"},{name:"MCP_OAUTH_CALLBACK_PORT",description:"Fixed port for the OAuth redirect callback, as an alternative to --callback-port when adding an MCP server with pre-configured credentials",kind:"string"},{name:"MCP_PROTOCOL_NEGOTIATION",description:"On the v2 MCP client runtime only, whether Claude Code probes servers for MCP protocol revision 2026-07-28. Set auto to probe HTTP, claude.ai connector, and stdio servers, or legacy to probe none. With the variable unset, Claude Code probes the servers described under MCP client runtimes\u2026",kind:"string"},{name:"MCP_REMOTE_SERVER_CONNECTION_BATCH_SIZE",description:"Maximum number of remote MCP servers (HTTP/SSE) to connect in parallel during startup (default: 20)",kind:"number"},{name:"MCP_SDK_GENERATION",description:"Pin which MCP client runtime this process connects to MCP servers with: v1, built on MCP TypeScript SDK 1.x, or v2, built on MCP TypeScript SDK 2.0. Without the variable, Claude Code uses v2, starting with the versions listed in that section. On Claude Code v2.1.221 or later\u2026",kind:"string"},{name:"MCP_SERVER_CONNECTION_BATCH_SIZE",description:"Maximum number of local MCP servers (stdio) to connect in parallel during startup (default: 3)",kind:"number"},{name:"MCP_TIMEOUT",description:"Timeout in milliseconds for MCP server startup (default: 30000, or 30 seconds)",kind:"number"},{name:"MCP_TOOL_TIMEOUT",description:"Timeout in milliseconds for MCP tool execution (default: 100000000, about 28 hours). For an HTTP, SSE, or claude.ai connector server, each request also times out after 60 seconds by default; set this variable, or the per-server timeout, above 60000 to raise that per-request limit\u2026",kind:"number"},{name:"NO_PROXY",description:"List of domains and IPs to which requests will be directly issued, bypassing proxy",kind:"string"},{name:"OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT",description:"Standard OpenTelemetry SDK limit on attribute value length. Claude Code caps content-bearing telemetry attributes at the smaller of this and CLAUDE_CODE_OTEL_CONTENT_MAX_LENGTH, so the truncation marker stays within the SDK limit\u2026",kind:"string"},{name:"OTEL_LOG_ASSISTANT_RESPONSES",description:"Set to 1 to include the model's response text on assistant_response OpenTelemetry log events. When unset, Claude Code uses the value of OTEL_LOG_USER_PROMPTS instead. Set to 0 to keep responses redacted even when OTEL_LOG_USER_PROMPTS is set. Set it in your shell, user settings, or managed settings\u2026",kind:"boolean"},{name:"OTEL_LOG_MANAGED_SETTINGS",description:"Set to 1 to add the redacted managed settings, and a SHA-256 digest of the settings before redaction, to managed_settings_resolved OpenTelemetry log events. Disabled by default. Set it in your shell, user settings, or managed settings; a value in project or local settings doesn't turn it on\u2026",kind:"boolean"},{name:"OTEL_LOG_RAW_API_BODIES",description:"Emit Anthropic Messages API request and response JSON as api_request_body / api_response_body log events. Set to 1 for inline bodies truncated at the content limit, or file:<dir> to write untruncated bodies to disk and emit a body_ref path instead. CLAUDE_CODE_OTEL_CONTENT_MAX_LENGTH configures the content limit\u2026",kind:"boolean"},{name:"OTEL_LOG_TOOL_CONTENT",description:"Set to 1 to include tool content in the tool.output OpenTelemetry span event. Span attributes carry tool content under their own gates. Requires tracing. Disabled by default to protect sensitive data. Set it in your shell, user settings, or managed settings. Ignored in project and local settings\u2026",kind:"boolean"},{name:"OTEL_LOG_TOOL_DETAILS",description:"Set to 1 to include tool input arguments; MCP server names; user-authored workflow names; raw error strings on tool failures; the refusal category on api_refusal events; real agent, skill, plugin, and MCP server names on cost and token metrics; and other tool details in OpenTelemetry metrics, traces, and logs\u2026",kind:"boolean"},{name:"OTEL_LOG_USER_PROMPTS",description:"Set to 1 to include user prompt text in OpenTelemetry traces and logs. Disabled by default (prompts are redacted). Set it in your shell, user settings, or managed settings. Ignored in project and local settings, apart from the off values that section describes. See Monitoring",kind:"boolean"},{name:"OTEL_METRICS_INCLUDE_ACCOUNT_UUID",description:"Set to false to exclude account UUID from metrics attributes (default: included). See Monitoring",kind:"string"},{name:"OTEL_METRICS_INCLUDE_ENTRYPOINT",description:"Set to true to include the session entrypoint in metrics attributes (default: excluded). Added in v2.1.152. See Monitoring",kind:"string"},{name:"OTEL_METRICS_INCLUDE_REPOSITORY",description:"Set to true to tag OpenTelemetry metrics and events with vcs.* attributes identifying the session's repository (default: excluded). Requires Claude Code v2.1.269 or later. See Repository attributes",kind:"string"},{name:"OTEL_METRICS_INCLUDE_RESOURCE_ATTRIBUTES",description:"As of v2.1.161, Claude Code attaches OTEL_RESOURCE_ATTRIBUTES keys to metric datapoint labels. Set to false to exclude them (default: included). See Monitoring",kind:"string"},{name:"OTEL_METRICS_INCLUDE_SESSION_ID",description:"Set to false to exclude session ID from metrics attributes (default: included). See Monitoring",kind:"string"},{name:"OTEL_METRICS_INCLUDE_VERSION",description:"Set to true to include Claude Code version in metrics attributes (default: excluded). See Monitoring",kind:"string"},{name:"SLASH_COMMAND_TOOL_CHAR_BUDGET",description:"Override the character budget for skill metadata shown to the Skill tool. The budget scales dynamically at 1% of the context window, with a fallback of 8,000 characters. Legacy name kept for backwards compatibility",kind:"string"},{name:"TASK_MAX_OUTPUT_LENGTH",description:"Removed in v2.1.277 and now a no-op, together with the TaskOutput tool it sized. Previously set the maximum number of characters of a background task's output that the TaskOutput tool kept. Claude reads a background task's output file with Read instead",kind:"number"},{name:"USE_BUILTIN_RIPGREP",description:"Set to 0 to use system-installed rg instead of rg included with Claude Code",kind:"boolean"},{name:"VERTEX_REGION_CLAUDE_3_5_HAIKU",description:"Override region for Claude 3.5 Haiku when using Google Cloud's Agent Platform",kind:"string"},{name:"VERTEX_REGION_CLAUDE_3_5_SONNET",description:"Override region for Claude 3.5 Sonnet when using Google Cloud's Agent Platform",kind:"string"},{name:"VERTEX_REGION_CLAUDE_3_7_SONNET",description:"Override region for Claude 3.7 Sonnet when using Google Cloud's Agent Platform",kind:"string"},{name:"VERTEX_REGION_CLAUDE_4_0_OPUS",description:"Override region for Claude Opus 4 when using Google Cloud's Agent Platform",kind:"string"},{name:"VERTEX_REGION_CLAUDE_4_0_SONNET",description:"Override region for Claude Sonnet 4 when using Google Cloud's Agent Platform",kind:"string"},{name:"VERTEX_REGION_CLAUDE_4_1_OPUS",description:"Override region for Claude Opus 4.1 when using Google Cloud's Agent Platform",kind:"string"},{name:"VERTEX_REGION_CLAUDE_4_5_OPUS",description:"Override region for Claude Opus 4.5 when using Google Cloud's Agent Platform",kind:"string"},{name:"VERTEX_REGION_CLAUDE_4_5_SONNET",description:"Override region for Claude Sonnet 4.5 when using Google Cloud's Agent Platform",kind:"string"},{name:"VERTEX_REGION_CLAUDE_4_6_OPUS",description:"Override region for Claude Opus 4.6 when using Google Cloud's Agent Platform",kind:"string"},{name:"VERTEX_REGION_CLAUDE_4_6_SONNET",description:"Override region for Claude Sonnet 4.6 when using Google Cloud's Agent Platform",kind:"string"},{name:"VERTEX_REGION_CLAUDE_4_7_OPUS",description:"Override region for Claude Opus 4.7 when using Google Cloud's Agent Platform",kind:"string"},{name:"VERTEX_REGION_CLAUDE_4_8_OPUS",description:"Override region for Claude Opus 4.8 when using Google Cloud's Agent Platform",kind:"string"},{name:"VERTEX_REGION_CLAUDE_5_5_OPUS",description:"Override region for Claude Opus 5.5 when using Google Cloud's Agent Platform. Added in v2.1.280",kind:"string"},{name:"VERTEX_REGION_CLAUDE_5_5_SONNET",description:"Override region for Claude Sonnet 5.5 when using Google Cloud's Agent Platform. Added in v2.1.284",kind:"string"},{name:"VERTEX_REGION_CLAUDE_5_OPUS",description:"Override region for Claude Opus 5 when using Google Cloud's Agent Platform. Added in v2.1.219",kind:"string"},{name:"VERTEX_REGION_CLAUDE_5_SONNET",description:"Override region for Claude Sonnet 5 when using Google Cloud's Agent Platform. Added in v2.1.197",kind:"string"},{name:"VERTEX_REGION_CLAUDE_FABLE_5",description:"Override region for Claude Fable 5 when using Google Cloud's Agent Platform. Added in v2.1.170",kind:"string"},{name:"VERTEX_REGION_CLAUDE_FABLE_5_1",description:"Override region for Claude Fable 5.1 when using Google Cloud's Agent Platform. Added in v2.1.257",kind:"string"},{name:"VERTEX_REGION_CLAUDE_HAIKU_4_5",description:"Override region for Claude Haiku 4.5 when using Google Cloud's Agent Platform",kind:"string"},{name:"VERTEX_REGION_CLAUDE_HAIKU_5_5",description:"Override region for Claude Haiku 5.5 when using Google Cloud's Agent Platform. Added in v2.1.293",kind:"string"}];