frontmatter PAR AVION

Settings

Settings .claude/settings.json Vendor docs

config

name type required meaning concept
$schema string
JSON Schema reference for Claude Code settings
docs ↗
advisorModel string
Pick which model answers when Claude asks the advisor tool
docs ↗
agent string
Start every session as a named subagent with its prompt, tools, and model
docs ↗
agentPushNotifEnabled boolean
Let Claude send a push notification to your phone when it decides to
docs ↗
allowAllClaudeAiMcps boolean
Load the claude.ai connectors Claude Code fetches itself alongside a deployed `managed-mcp.json`
docs ↗
allowManagedHooksOnly boolean
Run only the hooks your organization deploys
docs ↗
allowManagedMcpServersOnly boolean
Make the managed MCP allowlist the only one that applies
docs ↗
allowManagedPermissionRulesOnly boolean
Make managed settings the only settings source of permission rules
docs ↗
allowedChannelPlugins array
Replace the default allowlist of channel plugins that can push messages
docs ↗
allowedHttpHookUrls array
Limit which URLs HTTP hooks can target
docs ↗
allowedMcpServers array
Allowlist which MCP servers people can use
docs ↗
alwaysThinkingEnabled boolean
Turn extended thinking off for every session
docs ↗
apiKeyHelper string
Generate the API credential with your own command
docs ↗
askUserQuestionTimeout string
Let an unanswered question auto-continue after idle time
docs ↗
attribution object
Customize the attribution Claude Code adds to commits and pull requests
docs ↗
attribution.commit string
Change or hide the trailer Claude Code adds to commits
docs ↗
attribution.pr string
Change or hide the attribution line in pull request descriptions
docs ↗
attribution.sessionUrl string
Omit the claude.ai session link from cloud and Remote Control commits
docs ↗
autoCompactEnabled boolean
Turn automatic compaction off or on
docs ↗
autoCompactWindow string
Set how full the context gets before Claude Code compacts
docs ↗
autoConnectIde boolean
Connect to a running VS Code or JetBrains IDE automatically from an external terminal
docs ↗
autoContinueAtUsageLimit string
Wait in the open session and continue the task automatically after a claude.ai usage limit resets
docs ↗
autoInstallIdeExtension boolean
Turn off automatic install of the IDE extension from a VS Code terminal
docs ↗
autoMemoryDirectory string
Store auto memory in a directory you choose
docs ↗
autoMemoryEnabled boolean
Turn auto memory off or on
docs ↗
autoMode object
Add your own allow and deny rules to the auto mode classifier
docs ↗
autoMode.classifyAllShell string
Send every shell command through the auto mode classifier, even ones a narrow allow rule matches
docs ↗
autoScrollEnabled boolean
Follow new output to the bottom in fullscreen rendering
docs ↗
autoUpdatesChannel string
Follow the stable release channel instead of latest
docs ↗
availableModels array
Restrict which models people can pick
docs ↗
awaySummaryEnabled boolean
Turn off the session recap shown when you come back to the terminal
docs ↗
awsAuthRefresh string
Refresh expired Bedrock credentials in `.aws` with your own command
docs ↗
awsCredentialExport string
Supply Bedrock credentials as JSON from your own command
docs ↗
axScreenReader boolean
Render screen-reader friendly output
docs ↗
blockedMarketplaces array
Block plugin marketplace sources for your organization
docs ↗
browserExternalPageTools string
Keep Claude's tools off external pages in the desktop Browser pane
docs ↗
channelsEnabled boolean
Allow channels for your organization
docs ↗
claudeMd string
Inject organization-wide CLAUDE.md instructions from managed settings
docs ↗
claudeMdExcludes array
Skip specific CLAUDE.md files when memory loads
docs ↗
cleanupPeriodDays number
Choose how many days Claude Code keeps transcripts before deleting them
docs ↗
companyAnnouncements array
Show your organization's announcements at startup
docs ↗
crossSessionInbound string
Choose whether Claude Code delivers messages from your other sessions, shows a notice without delivering them, or refuses them
docs ↗
defaultShell string
Choose whether Bash or PowerShell runs the shell commands you type with the `!` prefix
docs ↗
deniedMcpServers array
Block specific MCP servers by URL, command, or name
docs ↗
desktopSessionCleanupPeriodDays string
Set an age limit in days for Claude Desktop and Cowork transcripts
docs ↗
dialogExpiry string
Set how long Claude Code waits for Remote Control or an SDK host to answer a forwarded dialog before it cancels the dialog
docs ↗
diffTool string
Choose whether Claude's proposed file changes open in the VS Code or JetBrains diff viewer or stay in the terminal
docs ↗
disableAgentView boolean
Turn off background agents and agent view
docs ↗
disableAllHooks boolean
Turn off hooks, a custom status line, and a custom `@` file suggestion command at once
docs ↗
disableArtifact boolean
Deprecated; use `enableArtifact` to turn the Artifact tool off
docs ↗
disableAutoMode string
Remove auto mode from the permission mode cycle
docs ↗
disableBrowserExternalNavigation boolean
Limit the desktop Browser pane to localhost for people and Claude
docs ↗
disableBundledSkills boolean
Turn off the skills and workflows included with Claude Code
docs ↗
disableClaudeAiConnectors boolean
Turn off claude.ai connectors so Claude Code doesn't fetch them
docs ↗
disableCommandPluginSources string
Block plugins that install by running a marketplace-declared command
docs ↗
disableDeepLinkRegistration string
Stop Claude Code from registering the `claude-cli://` handler
docs ↗
disableDesktopLocalSessions string
Turn off Desktop Code sessions that run on the device, leaving SSH to other hosts and cloud
docs ↗
disableMobileSimulatorTools boolean
Block Claude's tools in the desktop iOS Simulator pane
docs ↗
disableRemoteControl boolean
Turn off Remote Control everywhere it can start
docs ↗
disableSideloadFlags boolean
Reject the CLI flags that sideload plugins, subagents, and MCP servers
docs ↗
disableSkillShellExecution boolean
Stop skills and custom commands from running inline shell
docs ↗
disableWorkflows boolean
Turn dynamic workflows off for everyone; use `enableWorkflows` for yourself
docs ↗
disabledMcpjsonServers array
Reject specific servers from a project's `.mcp.json`
docs ↗
editorMode string
Use vim key bindings in the input prompt
docs ↗
effortLevel string
Set a default effort level for models without a saved level of their own
docs ↗
emojiCompletionEnabled boolean
Turn off `:shortcode:` emoji suggestions and replacement in the prompt input
docs ↗
enableAllProjectMcpServers boolean
Approve every server in project `.mcp.json` files without a prompt
docs ↗
enableArtifact boolean
Turn the Artifact tool off with a `false` in any file; no file can turn it back on
docs ↗
enableWorkflows string
Turn dynamic workflows on or off against your plan's default
docs ↗
enabledMcpjsonServers array
Approve specific servers from a project's `.mcp.json`
docs ↗
enabledPlugins object
Turn individual plugins on or off per scope
docs ↗
enforceAvailableModels boolean
Keep the `/model` Default choice inside your `availableModels` allowlist
docs ↗
env object
Set environment variables for every session and its subprocesses
docs ↗
externalEditorContext boolean
Show Claude's last response as comments when you press Ctrl+G to edit
docs ↗
extraKnownMarketplaces object
Register marketplaces for a repository or an organization
docs ↗
extraKnownMarketplaces.<name>.autoUpdate boolean
Whether to automatically update this marketplace on Claude Code startup. Written automatically by Claude Code when you toggle auto-update for a marketplace
docs ↗
extraKnownMarketplaces.<name>.installLocation string
Local cache path where marketplace manifest is stored (auto-generated if not provided)
docs ↗
extraKnownMarketplaces.<name>.lastUpdated string
ISO 8601 timestamp of the last marketplace refresh. Written automatically by Claude Code
docs ↗
extraKnownMarketplaces.<name>.source object yes
Where to fetch the marketplace from
docs ↗
fallbackModel array
Name backup models for when the primary is overloaded
docs ↗
fastMode boolean
Turn fast mode on for sessions where it's available
docs ↗
fastModePerSessionOptIn boolean
Require people to turn fast mode on each session
docs ↗
feedbackDrafts string
Control whether Claude queues feedback drafts for you to review
docs ↗
feedbackSurveyRate number
Change how often the session quality survey appears
docs ↗
fileCheckpointingEnabled boolean
Turn off or on the file snapshots that `/rewind` restores
docs ↗
fileSuggestion object
Supply `@` file autocomplete from your own command
docs ↗
footerLinksRegexes array
Make issue or review IDs in output into clickable links below the input box
docs ↗
forceLoginGatewayUrl string
Set the gateway URL the login screen connects to
docs ↗
forceLoginMethod string
Restrict login to claude.ai, Claude Console, or a cloud gateway
docs ↗
forceLoginOrgUUID object
Pin claude.ai logins to your organization; only a managed source enforces it
docs ↗
forceRemoteSettingsRefresh boolean
Block startup until server-managed settings are freshly fetched
docs ↗
gcpAuthRefresh string
Refresh Google Cloud credentials with your own command
docs ↗
hooks object
Run your own commands as hooks at points in Claude Code's lifecycle
docs ↗
httpHookAllowedEnvVars array
Limit which env vars HTTP hooks can put in headers
docs ↗
includeCoAuthoredBy boolean
Deprecated; use `attribution` to hide or change commit and PR attribution
docs ↗
includeGitInstructions boolean
Remove the built-in commit and PR instructions from the system prompt
docs ↗
inputNeededNotifEnabled boolean
Get a push notification when Claude is waiting on you
docs ↗
isolatePeerMachines string
Ask you before Claude messages one of your sessions on another machine
docs ↗
keybindingFlavor string
Make `Ctrl+W` delete back to the previous whitespace, as Bash does
docs ↗
language string
Have Claude respond in a language other than English
docs ↗
managedMcpServers array
(Managed settings, third-party Desktop deployments only) MCP server configurations pushed to all users. Each entry specifies the transport and connection details, plus an optional toolPolicy map. Delivered through the managed settings file or MDM. See https://code.claude.com/docs/en/desktop#enterprise-configuration
docs ↗
managedSourcesBehavior string
Compose every managed source you deploy instead of using the highest-priority one alone
docs ↗
minimumVersion string
Keep auto-updates from installing anything below a version
docs ↗
model string
Change the model Claude Code starts with
docs ↗
modelOverrides object
Map model IDs to your provider's IDs, such as Bedrock ARNs
docs ↗
modelPicker string
Choose which models the `/model` picker lists, in your own order and with your own labels
docs ↗
modelPricing string
Report spend at your organization's contracted rates instead of list price
docs ↗
modelSettings string
Keep a saved effort level per model, which Claude Code writes when you run `/effort`
docs ↗
otelHeadersHelper string
Generate rotating OpenTelemetry headers with your own command
docs ↗
outputStyle string
Change Claude's role, tone, and output format with an output style
docs ↗
parentSettingsBehavior string
Apply or drop restrictions an SDK or IDE host passes when you deploy managed settings
docs ↗
permissionExplainerEnabled boolean
Removed in v2.1.257, together with the `Ctrl+E` command explanation on shell permission prompts
docs ↗
permissions object
Set allow, ask, and deny rules and the starting permission mode
docs ↗
permissions.additionalDirectories string
Give Claude file access to directories outside the current one
docs ↗
permissions.allow string
Approve listed tool uses without a prompt
docs ↗
permissions.ask string
Always prompt before listed tool uses
docs ↗
permissions.blockReadsOutsideWorkingDirectories string
Make the file tools refuse reads outside the working directories in every permission mode
docs ↗
permissions.defaultMode string
Set the permission mode new sessions start in
docs ↗
permissions.deny string
Block listed tool uses, including reads of files that hold secrets
docs ↗
permissions.disableBypassPermissionsMode string
Prevent anyone from entering bypassPermissions mode
docs ↗
plansDirectory string
Choose where plan mode writes plan files
docs ↗
pluginConfigs object
Store the answers you gave a plugin's configuration dialog
docs ↗
pluginConfigs.<name>.mcpServers object
User configuration values for MCP servers keyed by server name
docs ↗
pluginConfigs.<name>.options object
Non-sensitive option values from the plugin manifest's userConfig, keyed by option name. Sensitive values go to secure storage instead. See https://code.claude.com/docs/en/plugins-reference
docs ↗
pluginSuggestionMarketplaces array
Choose which marketplaces can surface plugin install suggestions in `/plugin`
docs ↗
pluginTrustMessage string
Add your own text to the plugin trust warning
docs ↗
policyHelper object
Run an executable that computes managed settings at startup
docs ↗
policyHelper.path string
Name the helper executable Claude Code runs
docs ↗
policyHelper.refreshIntervalMs string
Re-run the helper in the background on an interval
docs ↗
policyHelper.timeoutMs string
Set how long Claude Code waits for the helper
docs ↗
prUrlTemplate string
Point PR links at an internal code-review tool instead of github.com
docs ↗
preferredNotifChannel string
Choose a terminal bell or desktop notification for task completion
docs ↗
prefersReducedMotion boolean
Reduce or turn off spinner, shimmer, and flash animations
docs ↗
processWrapper string
Run Claude Code's background processes through a corporate launcher on macOS and Linux
docs ↗
promptCacheTtl string
Choose the prompt cache lifetime for the main conversation
docs ↗
promptSuggestionEnabled string
Hide the grayed-out prompt suggestions in the input box
docs ↗
remote.defaultEnvironmentId string
Pick the default cloud environment for `claude --cloud`; a self-hosted `ccpool_` ID is read only from user and managed settings and `--settings`
docs ↗
remoteControlAtStartup boolean
Connect Remote Control automatically when a session starts
docs ↗
requireCoworkFullVmSandbox boolean
(Managed settings only) Run Claude's tools inside an isolated virtual machine instead of on your Mac. Disables the desktop app's iOS Simulator pane and Claude's simulator tools entirely, so the pane cannot attach a device while it is set. See https://code.claude.com/docs/en/desktop-ios-simulator#turn-off-simulator-access
docs ↗
requiredMaximumVersion string
Refuse to start on a version newer than your organization allows
docs ↗
requiredMinimumVersion string
Refuse to start on a version older than your organization requires
docs ↗
respectGitignore boolean
Keep gitignored files out of the `@` file picker
docs ↗
respondToBashCommands boolean
Stop Claude from responding after a `!` shell command runs
docs ↗
sandbox object
Isolate Bash commands from your filesystem and network on macOS, Linux, and WSL2
docs ↗
sandbox.allowAppleEvents string
Let sandboxed commands send Apple Events on macOS
docs ↗
sandbox.allowUnsandboxedCommands string
Let Claude retry a blocked command outside the sandbox, or forbid it
docs ↗
sandbox.autoAllowBashIfSandboxed string
Run sandboxed commands without a permission prompt
docs ↗
sandbox.bwrapPath string
Point the sandbox at a bubblewrap binary outside `PATH`
docs ↗
sandbox.credentials string
Hide or mask credential files and variables inside the sandbox
docs ↗
sandbox.credentials.allowPlaintextInject string
Let masked credentials reach plain HTTP services on trusted test networks
docs ↗
sandbox.credentials.awsPairs string
Link custom-named AWS key variables into one credential for re-signing
docs ↗
sandbox.credentials.envVars string
Unset or mask an environment variable inside the sandbox
docs ↗
sandbox.credentials.files string
Block or mask reads of a credential file inside the sandbox
docs ↗
sandbox.credentials.sigv4 string
Choose whether streaming, presigned, or SigV4A AWS requests fail or pass through
docs ↗
sandbox.enableWeakerNestedSandbox string
Run the Linux sandbox inside an unprivileged container
docs ↗
sandbox.enableWeakerNetworkIsolation string
Let `gh`, `gcloud`, and `terraform` verify TLS behind a MITM proxy inside the sandbox on macOS
docs ↗
sandbox.enabled string
Turn on Bash sandboxing on macOS, Linux, and WSL2
docs ↗
sandbox.excludedCommands string
Name commands that always run outside the sandbox
docs ↗
sandbox.failIfUnavailable string
Refuse to start when the sandbox can't, instead of running unsandboxed
docs ↗
sandbox.filesystem string
Control which paths sandboxed commands can read and write
docs ↗
sandbox.filesystem.allowManagedReadPathsOnly string
Stop developers from re-opening read paths your organization blocked
docs ↗
sandbox.filesystem.allowRead string
Re-open reading inside a region `denyRead` blocks
docs ↗
sandbox.filesystem.allowWrite string
Add paths sandboxed commands can write to
docs ↗
sandbox.filesystem.denyRead string
Block sandboxed commands from reading specific paths
docs ↗
sandbox.filesystem.denyWrite string
Block sandboxed commands from writing to specific paths
docs ↗
sandbox.filesystem.disabled string
Turn off filesystem isolation while keeping network isolation
docs ↗
sandbox.ignoreViolations string
Silence violation reports for paths a command is expected to probe
docs ↗
sandbox.network string
Control which hosts, ports, and sockets sandboxed commands reach
docs ↗
sandbox.network.allowAllUnixSockets string
Let sandboxed commands connect to every Unix socket
docs ↗
sandbox.network.allowLocalBinding string
Let sandboxed commands bind to localhost ports on macOS
docs ↗
sandbox.network.allowMachLookup string
Let macOS sandboxed tools like the iOS Simulator or Playwright reach their XPC services
docs ↗
sandbox.network.allowManagedDomainsOnly string
Lock the network allowlist to managed settings
docs ↗
sandbox.network.allowUnixSockets string
List Unix socket paths sandboxed commands can use on macOS
docs ↗
sandbox.network.allowedDomains string
Pre-allow domains so sandboxed commands don't prompt for them
docs ↗
sandbox.network.deniedDomains string
Block domains for sandboxed commands, even inside an allowed wildcard
docs ↗
sandbox.network.httpProxyPort string
Route sandbox HTTP traffic through your own proxy
docs ↗
sandbox.network.socksProxyPort string
Route sandbox SOCKS traffic through your own proxy
docs ↗
sandbox.network.strictAllowlist string
Deny hosts outside the allowlist instead of prompting
docs ↗
sandbox.network.tlsTerminate string
Have the sandbox proxy terminate TLS so it can read HTTPS requests
docs ↗
sandbox.ripgrep string
Use your own ripgrep binary inside the sandbox
docs ↗
sandbox.socatPath string
Point the sandbox proxy at a `socat` binary outside `PATH`
docs ↗
showClearContextOnPlanAccept boolean
Show a "clear context" option on the plan accept screen
docs ↗
showThinkingSummaries boolean
See summaries of Claude's thinking instead of a collapsed stub
docs ↗
showTurnDuration boolean
Hide the "Cooked for" duration after each response
docs ↗
skillListingBudgetFraction number
Reserve more or less context for the skill listing
docs ↗
skillListingMaxDescChars number
Cap each skill's description length in the skill listing
docs ↗
skillOverrides object
Hide or collapse a skill without editing its SKILL.md
docs ↗
skipAutoPermissionPrompt string
Skip the one-time notice Claude Code shows when you first enter auto mode yourself rather than through the built-in default
docs ↗
skipDangerousModePermissionPrompt boolean
Skip the confirmation dialog before bypassPermissions mode
docs ↗
skipWebFetchPreflight boolean
Skip the WebFetch hostname check when Anthropic is unreachable
docs ↗
skippedMarketplaces array
List of marketplace names the user has chosen not to install when prompted. See https://code.claude.com/docs/en/discover-plugins
docs ↗
skippedPlugins array
List of plugin IDs (plugin@marketplace format) the user has chosen not to install when prompted. See https://code.claude.com/docs/en/discover-plugins
docs ↗
spellcheck string
Underline misspelled words in the prompt input with a spell checker you install
docs ↗
spinnerTipsEnabled boolean
Hide tips in the spinner while Claude works
docs ↗
spinnerTipsOverride object
Add your own tips to the spinner rotation, or replace the built-in tips
docs ↗
spinnerVerbs object
Add or replace the verbs shown while a turn runs
docs ↗
sshConfigs array
Add SSH connections to the Desktop environment dropdown
docs ↗
sshHostAllowlist array
Limit which hosts Desktop SSH sessions can reach
docs ↗
statusLine object
Run your own command to render a status line below the prompt
docs ↗
strictKnownMarketplaces array
Allowlist the marketplace sources users can add and install from
docs ↗
strictPluginOnlyCustomization object
Block skills, agents, hooks, and MCP servers from user and project sources
docs ↗
strictPluginOnlyCustomization.agents string
Lock agents to plugin and managed sources
docs ↗
strictPluginOnlyCustomization.hooks string
Lock hooks to plugin and managed sources
docs ↗
strictPluginOnlyCustomization.mcp string
Lock MCP servers to plugin and managed sources
docs ↗
strictPluginOnlyCustomization.skills string
Lock skills to plugin and managed sources
docs ↗
subagentPromptCacheTtl string
Choose the prompt cache lifetime for subagents and other requests outside the main conversation
docs ↗
subagentStatusLine object
Rewrite rows in the subagent task display with your own command
docs ↗
switchModelsOnFlag string
Switch models automatically or pause when a safety classifier flags a request
docs ↗
syncClaudeAiSkills string
Stop downloading the skills enabled on your claude.ai account and hide the ones already synced
docs ↗
syntaxHighlightingDisabled boolean
Turn off syntax highlighting in diffs and code blocks
docs ↗
teammateDefaultModel string
Removed in v2.1.234; see Specify teammates and models for how Claude Code picks a teammate's model
docs ↗
teammateMode string
Choose how agent team teammates display
docs ↗
terminalProgressBarEnabled boolean
Hide the terminal progress bar in terminals that support it
docs ↗
terminalTitleFromRename string
Stop `/rename` and `--name` from changing the terminal tab title
docs ↗
theme object
Pick the interface color theme, built-in or custom
docs ↗
timeFormat string
Show the times in the interface on a 12-hour or 24-hour clock, in UTC, or with a strftime pattern
docs ↗
timeZone string
Show the times in the interface in a time zone other than your system's
docs ↗
tui string
Choose the fullscreen or classic terminal renderer
docs ↗
ultracode string
Have Claude plan a workflow for each substantive task without being asked
docs ↗
useAutoModeDuringPlan boolean
Let the auto mode classifier review shell commands in plan mode; set `false` to get prompts instead
docs ↗
verbose boolean
Show full tool output instead of truncated summaries; `viewMode` takes precedence when both are set
docs ↗
viewMode string
Start every session in default, verbose, or focus view
docs ↗
vimInsertModeRemaps object
Map a two-key INSERT-mode sequence such as `jj` to Escape
docs ↗
voice object
Turn on voice dictation and pick hold or tap mode
docs ↗
voiceEnabled boolean
Turn on voice dictation with the older single-key form
docs ↗
wheelScrollAccelerationEnabled boolean
Turn off mouse-wheel acceleration in fullscreen rendering
docs ↗
workflowKeywordTriggerEnabled boolean
Let the word `ultracode` in a prompt start a workflow; set `false` to type it without starting one
docs ↗
workflowSizeGuideline string
Set the agent count Claude aims for in dynamic workflows
docs ↗
worktree object
Configure how Claude Code creates git worktrees
docs ↗
worktree.baseRef string
Branch new worktrees from the remote default branch or your local HEAD
docs ↗
worktree.bgIsolation string
Let background sessions edit the working copy without a worktree
docs ↗
worktree.sparsePaths string
Check out only the directories you need in each worktree
docs ↗
worktree.symlinkDirectories string
Symlink large directories into each worktree instead of duplicating them
docs ↗
wslInheritsWindowsSettings boolean
Have WSL read managed settings from the Windows policy chain
docs ↗