Optional$schemaJSON Schema reference for Claude Code settings
OptionaladvisorAdvisor model for the server-side advisor tool.
OptionalagentName of an agent (built-in or custom) to use for the main thread. Applies the agent's system prompt, tool restrictions, and model.
OptionalallowedTeams/Enterprise allowlist of channel plugins. When set, replaces the default Anthropic allowlist — admins decide which plugins may push inbound messages. Undefined falls back to the default. Requires channelsEnabled: true.
OptionalallowedAllowlist of URL patterns that HTTP hooks may target. Supports * as a wildcard (e.g. "https://hooks.example.com/*"). When set, HTTP hooks with non-matching URLs are blocked. If undefined, all URLs are allowed. If empty array, no HTTP hooks are allowed. Arrays merge across settings sources (same semantics as allowedMcpServers).
OptionalallowedEnterprise allowlist of MCP servers that can be used. Applies to all scopes including enterprise servers from managed-mcp.json. If undefined, all servers are allowed. If empty array, no servers are allowed. Denylist takes precedence - if a server is on both lists, it is denied.
OptionalserverCommand?: [string, ...string[]]Command array [command, ...args] to match exactly for allowed stdio servers
@minItems 1
OptionalserverName?: stringName of the MCP server that users are allowed to configure
OptionalserverUrl?: stringURL pattern with wildcard support (e.g., "https://.example.com/") for allowed remote MCP servers
OptionalallowWhen true (and set in managed settings), only hooks from managed settings run. User, project, and local hooks are ignored.
OptionalallowWhen true (and set in managed settings), allowedMcpServers is only read from managed settings. deniedMcpServers still merges from all sources, so users can deny servers for themselves. Users can still add their own MCP servers, but only the admin-defined allowlist applies.
OptionalallowWhen true (and set in managed settings), only permission rules (allow/deny/ask) from managed settings are respected. User, project, local, and CLI argument permission rules are ignored.
OptionalalwaysWhen false, thinking is disabled. When absent or true, thinking is enabled automatically for supported models.
OptionalapiPath to a script that outputs authentication values
OptionalattributionCustomize attribution text for commits and PRs. Each field defaults to the standard Claude Code attribution if not set.
Optionalcommit?: stringAttribution text for git commits, including any trailers. Empty string hides attribution.
Optionalpr?: stringAttribution text for pull request descriptions. Empty string hides attribution.
OptionalautoAuto-compact window size
OptionalautoEnable background memory consolidation (auto-dream). When set, overrides the server-side default.
OptionalautoCustom directory path for auto-memory storage. Supports ~/ prefix for home directory expansion. Ignored if set in projectSettings (checked-in .claude/settings.json) for security. When unset, defaults to ~/.claude/projects/
OptionalautoEnable auto-memory for this project. When false, Claude will not read from or write to the auto-memory directory.
OptionalautoRelease channel for auto-updates (latest or stable)
OptionalavailableAllowlist of models that users can select. Accepts family aliases ("opus" allows any opus version), version prefixes ("opus-4-5" allows only that version), and full model IDs. If undefined, all models are available. If empty array, only the default model is available. Typically set in managed settings by enterprise administrators.
OptionalawsPath to a script that refreshes AWS authentication
OptionalawsPath to a script that exports AWS credentials
OptionalblockedEnterprise blocklist of marketplace sources. When set in managed settings, these exact sources are blocked from being added as marketplaces. The check happens BEFORE downloading, so blocked sources never touch the filesystem.
Optionalheaders?: { [k: string]: string }Custom HTTP headers (e.g., for authentication)
Direct URL to marketplace.json file
Optionalpath?: stringPath to marketplace.json within repo (defaults to .claude-plugin/marketplace.json)
Optionalref?: stringGit branch or tag to use (e.g., "main", "v1.0.0"). Defaults to repository default branch.
GitHub repository in owner/repo format
OptionalsparsePaths?: string[]Directories to include via git sparse-checkout (cone mode). Use for monorepos where the marketplace lives in a subdirectory. Example: [".claude-plugin", "plugins"]. If omitted, the full repository is cloned.
Optionalpath?: stringPath to marketplace.json within repo (defaults to .claude-plugin/marketplace.json)
Optionalref?: stringGit branch or tag to use (e.g., "main", "v1.0.0"). Defaults to repository default branch.
OptionalsparsePaths?: string[]Directories to include via git sparse-checkout (cone mode). Use for monorepos where the marketplace lives in a subdirectory. Example: [".claude-plugin", "plugins"]. If omitted, the full repository is cloned.
Full git repository URL
NPM package containing marketplace.json
Local file path to marketplace.json
Local directory containing .claude-plugin/marketplace.json
Regex pattern to match the host/domain extracted from any marketplace source type. For github sources, matches against "github.com". For git sources (SSH or HTTPS), extracts the hostname from the URL. Use in strictKnownMarketplaces to allow all marketplaces from a specific host (e.g., "^github.mycompany.com$").
Regex pattern matched against the .path field of file and directory sources. Use in strictKnownMarketplaces to allow filesystem-based marketplaces alongside hostPattern restrictions for network sources. Use ".*" to allow all filesystem paths, or a narrower pattern (e.g., "^/opt/approved/") to restrict to specific directories.
Marketplace name. Must match the extraKnownMarketplaces key (enforced); the synthetic manifest is written under this name. Same validation as PluginMarketplaceSchema plus reserved-name rejection — validateOfficialNameSource runs after the disk write, too late to clean up.
Optionalowner?: { email?: string; name: string; url?: string }Optionalemail?: stringContact email for support or feedback
Display name of the plugin author or organization
Optionalurl?: stringWebsite, GitHub profile, or organization URL
Plugin entries declared inline in settings.json
OptionalchannelsTeams/Enterprise opt-in for channel notifications (MCP servers with the claude/channel capability pushing inbound messages). Default off. Set true to allow; users then select servers via --channels.
OptionalclaudeGlob patterns or absolute paths of CLAUDE.md files to exclude from loading. Patterns are matched against absolute file paths using picomatch. Only applies to User, Project, and Local memory types (Managed/policy files cannot be excluded). Examples: "/home/user/monorepo/CLAUDE.md", "** /code/CLAUDE.md", "** /some-dir/.claude/rules/**"
OptionalcleanupNumber of days to retain chat transcripts before automatic cleanup (default: 30). Minimum 1. Use a large value for long retention; use --no-session-persistence to disable transcript writes entirely.
OptionalcompanyCompany announcements to display at startup (one will be randomly selected if multiple are provided)
OptionaldefaultDefault shell for input-box ! commands. Defaults to 'bash' on all platforms (no Windows auto-flip).
OptionaldeniedEnterprise denylist of MCP servers that are explicitly blocked. If a server is on the denylist, it will be blocked across all scopes including enterprise. Denylist takes precedence over allowlist - if a server is on both lists, it is denied.
OptionalserverCommand?: [string, ...string[]]Command array [command, ...args] to match exactly for blocked stdio servers
@minItems 1
OptionalserverName?: stringName of the MCP server that is explicitly blocked
OptionalserverUrl?: stringURL pattern with wildcard support (e.g., "https://.example.com/") for blocked remote MCP servers
OptionaldisableDisable all hooks and statusLine execution
OptionaldisableDisable auto mode
OptionaldisabledList of rejected MCP servers from .mcp.json
OptionaldisableDisable inline shell execution in skills and custom slash commands from user, project, or plugin sources. Commands are replaced with a placeholder instead of being run.
OptionaleffortPersisted effort level for supported models.
OptionalenableWhether to automatically approve all MCP servers in the project
OptionalenabledList of approved MCP servers from .mcp.json
OptionalenabledEnabled plugins using plugin-id@marketplace-id format. Example: { "formatter@anthropic-tools": true }. Also supports extended format with version constraints.
OptionalenvEnvironment variables to set for Claude Code sessions
OptionalextraAdditional marketplaces to make available for this repository. Typically used in repository .claude/settings.json to ensure team members have required plugin sources.
OptionalfastWhen true, fast mode is enabled. When absent or false, fast mode is off.
OptionalfastWhen true, fast mode does not persist across sessions. Each session starts with fast mode off.
OptionalfeedbackProbability (0–1) that the session quality survey appears when eligible. 0.05 is a reasonable starting point.
OptionalfileCustom file suggestion configuration for @ mentions
OptionalforceForce a specific login method: "claudeai" for Claude Pro/Max, "console" for Console billing
OptionalforceOrganization UUID to require for OAuth login. Accepts a single UUID string or an array of UUIDs (any one is permitted). When set in managed settings, login fails if the authenticated account does not belong to a listed organization.
OptionalgcpCommand to refresh GCP authentication (e.g., gcloud auth application-default login)
OptionalhooksCustom commands to run before/after tool executions
OptionalhttpAllowlist of environment variable names HTTP hooks may interpolate into headers. When set, each hook's effective allowedEnvVars is the intersection with this list. If undefined, no restriction is applied. Arrays merge across settings sources (same semantics as allowedMcpServers).
OptionalincludeDeprecated: Use attribution instead. Whether to include Claude's co-authored by attribution in commits and PRs (defaults to true)
OptionalincludeInclude built-in commit and PR workflow instructions in Claude's system prompt (default: true)
OptionallanguagePreferred language for Claude responses and voice dictation (e.g., "japanese", "spanish")
OptionalminimumMinimum version to stay on - prevents downgrades when switching to stable channel
OptionalmodelOverride the default model used by Claude Code
OptionalmodelOverride mapping from Anthropic model ID (e.g. "claude-opus-4-6") to provider-specific model ID (e.g. a Bedrock inference profile ARN). Typically set in managed settings by enterprise administrators.
OptionalotelPath to a script that outputs OpenTelemetry headers
OptionaloutputControls the output style for assistant responses
OptionalpermissionsTool usage permissions configuration
OptionaladditionalDirectories?: string[]Additional directories to include in the permission scope
Optionalallow?: string[]List of permission rules for allowed operations
Optionalask?: string[]List of permission rules that should always prompt for confirmation
OptionaldefaultMode?: "plan" | "default" | "acceptEdits" | "bypassPermissions" | "dontAsk" | "auto"Default permission mode when Claude Code needs access
Optionaldeny?: string[]List of permission rules for denied operations
OptionaldisableBypassPermissionsMode?: "disable"Disable the ability to bypass permission prompts
OptionalplansCustom directory for plan files, relative to project root. If not set, defaults to ~/.claude/plans/
OptionalpluginPer-plugin configuration including MCP server user configs, keyed by plugin ID (plugin@marketplace format)
OptionalpluginCustom message to append to the plugin trust warning shown before installation. Only read from policy settings (managed-settings.json / MDM). Useful for enterprise administrators to add organization-specific context (e.g., "All plugins from our internal marketplace are vetted and approved.").
OptionalprefersReduce or disable animations for accessibility (spinner shimmer, flash effects, etc.)
OptionalpromptWhen false, prompt suggestions are disabled. When absent or true, prompt suggestions are enabled.
OptionalremoteRemote session configuration
OptionaldefaultEnvironmentId?: stringDefault environment ID to use for remote sessions
OptionalrespectWhether file picker should respect .gitignore files (default: true). Note: .ignore files are always respected.
OptionalsandboxOptionalallowUnsandboxedCommands?: booleanAllow commands to run outside the sandbox via the dangerouslyDisableSandbox parameter. When false, the dangerouslyDisableSandbox parameter is completely ignored and all commands must run sandboxed. Default: true.
OptionalautoAllowBashIfSandboxed?: booleanOptionalenabled?: booleanOptionalenableWeakerNestedSandbox?: booleanOptionalenableWeakerNetworkIsolation?: booleanmacOS only: Allow access to com.apple.trustd.agent in the sandbox. Needed for Go-based CLI tools (gh, gcloud, terraform, etc.) to verify TLS certificates when using httpProxyPort with a MITM proxy and custom CA. Reduces security — opens a potential data exfiltration vector through the trustd service. Default: false
OptionalexcludedCommands?: string[]OptionalfailIfUnavailable?: booleanExit with an error at startup if sandbox.enabled is true but the sandbox cannot start (missing dependencies, unsupported platform, or platform not in enabledPlatforms). When false (default), a warning is shown and commands run unsandboxed. Intended for managed-settings deployments that require sandboxing as a hard gate.
Optionalfilesystem?: {OptionalallowManagedReadPathsOnly?: booleanWhen true (set in managed settings), only allowRead paths from policySettings are used.
OptionalallowRead?: string[]Paths to re-allow reading within denyRead regions. Takes precedence over denyRead for matching paths.
OptionalallowWrite?: string[]Additional paths to allow writing within the sandbox. Merged with paths from Edit(...) allow permission rules.
OptionaldenyRead?: string[]Additional paths to deny reading within the sandbox. Merged with paths from Read(...) deny permission rules.
OptionaldenyWrite?: string[]Additional paths to deny writing within the sandbox. Merged with paths from Edit(...) deny permission rules.
OptionalignoreViolations?: { [k: string]: string[] }Optionalnetwork?: {OptionalallowAllUnixSockets?: booleanIf true, allow all Unix sockets (disables blocking on both platforms).
OptionalallowedDomains?: string[]OptionalallowLocalBinding?: booleanOptionalallowManagedDomainsOnly?: booleanWhen true (and set in managed settings), only allowedDomains and WebFetch(domain:...) allow rules from managed settings are respected. User, project, local, and flag settings domains are ignored. Denied domains are still respected from all sources.
OptionalallowUnixSockets?: string[]macOS only: Unix socket paths to allow. Ignored on Linux (seccomp cannot filter by path).
OptionalhttpProxyPort?: numberOptionalsocksProxyPort?: numberOptionalripgrep?: { args?: string[]; command: string }Custom ripgrep configuration for bundled ripgrep support
OptionalshowWhen true, the plan-approval dialog offers a "clear context" option. Defaults to false.
OptionalshowShow thinking summaries in the transcript view (ctrl+o). Default: false.
OptionalskipWhether the user has accepted the bypass permissions mode dialog
OptionalskipSkip the WebFetch blocklist check for enterprise environments with restrictive security policies
OptionalspinnerWhether to show tips in the spinner
OptionalspinnerOverride spinner tips. tips: array of tip strings. excludeDefault: if true, only show custom tips (default: false).
OptionalspinnerCustomize spinner verbs. mode: "append" adds verbs to defaults, "replace" uses only your verbs.
OptionalsshSSH connection configurations for remote environments. Typically set in managed settings by enterprise administrators to pre-configure SSH connections for team members.
Unique identifier for this SSH config. Used to match configs across settings sources.
Display name for the SSH connection
SSH host in format "user@hostname" or "hostname", or a host alias from ~/.ssh/config
OptionalsshIdentityFile?: stringPath to SSH identity file (private key)
OptionalsshPort?: numberSSH port (default: 22)
OptionalstartDirectory?: stringDefault working directory on the remote host. Supports tilde expansion (e.g. ~/projects). If not specified, defaults to the remote user home directory. Can be overridden by the [dir] positional argument in claude ssh <config> [dir].
OptionalstatusCustom status line display configuration
OptionalstrictEnterprise strict list of allowed marketplace sources. When set in managed settings, ONLY these exact sources can be added as marketplaces. The check happens BEFORE downloading, so blocked sources never touch the filesystem. Note: this is a policy gate only — it does NOT register marketplaces. To pre-register allowed marketplaces for users, also set extraKnownMarketplaces.
Optionalheaders?: { [k: string]: string }Custom HTTP headers (e.g., for authentication)
Direct URL to marketplace.json file
Optionalpath?: stringPath to marketplace.json within repo (defaults to .claude-plugin/marketplace.json)
Optionalref?: stringGit branch or tag to use (e.g., "main", "v1.0.0"). Defaults to repository default branch.
GitHub repository in owner/repo format
OptionalsparsePaths?: string[]Directories to include via git sparse-checkout (cone mode). Use for monorepos where the marketplace lives in a subdirectory. Example: [".claude-plugin", "plugins"]. If omitted, the full repository is cloned.
Optionalpath?: stringPath to marketplace.json within repo (defaults to .claude-plugin/marketplace.json)
Optionalref?: stringGit branch or tag to use (e.g., "main", "v1.0.0"). Defaults to repository default branch.
OptionalsparsePaths?: string[]Directories to include via git sparse-checkout (cone mode). Use for monorepos where the marketplace lives in a subdirectory. Example: [".claude-plugin", "plugins"]. If omitted, the full repository is cloned.
Full git repository URL
NPM package containing marketplace.json
Local file path to marketplace.json
Local directory containing .claude-plugin/marketplace.json
Regex pattern to match the host/domain extracted from any marketplace source type. For github sources, matches against "github.com". For git sources (SSH or HTTPS), extracts the hostname from the URL. Use in strictKnownMarketplaces to allow all marketplaces from a specific host (e.g., "^github.mycompany.com$").
Regex pattern matched against the .path field of file and directory sources. Use in strictKnownMarketplaces to allow filesystem-based marketplaces alongside hostPattern restrictions for network sources. Use ".*" to allow all filesystem paths, or a narrower pattern (e.g., "^/opt/approved/") to restrict to specific directories.
Marketplace name. Must match the extraKnownMarketplaces key (enforced); the synthetic manifest is written under this name. Same validation as PluginMarketplaceSchema plus reserved-name rejection — validateOfficialNameSource runs after the disk write, too late to clean up.
Optionalowner?: { email?: string; name: string; url?: string }Optionalemail?: stringContact email for support or feedback
Display name of the plugin author or organization
Optionalurl?: stringWebsite, GitHub profile, or organization URL
Plugin entries declared inline in settings.json
OptionalstrictWhen set in managed settings, blocks non-plugin customization sources for the listed surfaces. Array form locks specific surfaces (e.g. ["skills", "hooks"]); true locks all four; false is an explicit no-op. Blocked: ~/.claude/{surface}/, .claude/{surface}/ (project), settings.json hooks, .mcp.json. NOT blocked: managed (policySettings) sources, plugin-provided customizations. Composes with strictKnownMarketplaces for end-to-end admin control — plugins gated by marketplace allowlist, everything else blocked here.
OptionalsyntaxWhether to disable syntax highlighting in diffs
OptionalterminalWhether /rename updates the terminal tab title (defaults to true). Set to false to keep auto-generated topic titles.
OptionalworktreeGit worktree configuration for --worktree flag.
OptionalsparsePaths?: string[]Directories to include when creating worktrees, via git sparse-checkout (cone mode). Dramatically faster in large monorepos — only the listed paths are written to disk.
OptionalsymlinkDirectories?: string[]Directories to symlink from main repository to worktrees to avoid disk bloat. Must be explicitly configured - no directories are symlinked by default. Common examples: "node_modules", ".cache", ".bin"
AUTO-GENERATED - DO NOT EDIT
This file is auto-generated from the settings JSON schema. To modify these types, edit SettingsSchema in src/utils/settings/types.ts and run:
bun scripts/generate-sdk-types.ts