@runloop/agent-axon-client
    Preparing search index...

    Interface Settings

    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

    interface Settings {
        $schema?: "https://json.schemastore.org/claude-code-settings.json";
        advisorModel?: string;
        agent?: string;
        allowedChannelPlugins?: { marketplace: string; plugin: string }[];
        allowedHttpHookUrls?: string[];
        allowedMcpServers?: {
            serverCommand?: [string, ...string[]];
            serverName?: string;
            serverUrl?: string;
        }[];
        allowManagedHooksOnly?: boolean;
        allowManagedMcpServersOnly?: boolean;
        allowManagedPermissionRulesOnly?: boolean;
        alwaysThinkingEnabled?: boolean;
        apiKeyHelper?: string;
        attribution?: { commit?: string; pr?: string };
        autoCompactWindow?: number;
        autoDreamEnabled?: boolean;
        autoMemoryDirectory?: string;
        autoMemoryEnabled?: boolean;
        autoUpdatesChannel?: "latest" | "stable";
        availableModels?: string[];
        awsAuthRefresh?: string;
        awsCredentialExport?: string;
        blockedMarketplaces?: (
            | { headers?: { [k: string]: string }; source: "url"; url: string }
            | {
                path?: string;
                ref?: string;
                repo: string;
                source: "github";
                sparsePaths?: string[];
            }
            | {
                path?: string;
                ref?: string;
                source: "git";
                sparsePaths?: string[];
                url: string;
            }
            | { package: string; source: "npm" }
            | { path: string; source: "file" }
            | { path: string; source: "directory" }
            | { hostPattern: string; source: "hostPattern" }
            | { pathPattern: string; source: "pathPattern" }
            | {
                name: string;
                owner?: { email?: string; name: string; url?: string };
                plugins: {
                    description?: string;
                    name: string;
                    source:
                        | string
                        | {
                            package: string;
                            registry?: string;
                            source: "npm";
                            version?: string;
                        }
                        | {
                            package: string;
                            registry?: string;
                            source: "pip";
                            version?: string;
                        }
                        | { ref?: string; sha?: string; source: "url"; url: string }
                        | { ref?: string; repo: string; sha?: string; source: "github" }
                        | {
                            path: string;
                            ref?: string;
                            sha?: string;
                            source: "git-subdir";
                            url: string;
                        };
                    strict?: boolean;
                    version?: string;
                }[];
                source: "settings";
            }
        )[];
        channelsEnabled?: boolean;
        claudeMdExcludes?: string[];
        cleanupPeriodDays?: number;
        companyAnnouncements?: string[];
        defaultShell?: "bash"
        | "powershell";
        deniedMcpServers?: {
            serverCommand?: [string, ...string[]];
            serverName?: string;
            serverUrl?: string;
        }[];
        disableAllHooks?: boolean;
        disableAutoMode?: "disable";
        disabledMcpjsonServers?: string[];
        disableSkillShellExecution?: boolean;
        effortLevel?: "high"
        | "medium"
        | "low";
        enableAllProjectMcpServers?: boolean;
        enabledMcpjsonServers?: string[];
        enabledPlugins?: {
            [k: string]: boolean | string[] | { [k: string]: unknown };
        };
        env?: { [k: string]: string };
        extraKnownMarketplaces?: {
            [k: string]: {
                autoUpdate?: boolean;
                installLocation?: string;
                source:
                    | { headers?: { [k: string]: string }; source: "url"; url: string }
                    | {
                        path?: string;
                        ref?: string;
                        repo: string;
                        source: "github";
                        sparsePaths?: string[];
                    }
                    | {
                        path?: string;
                        ref?: string;
                        source: "git";
                        sparsePaths?: string[];
                        url: string;
                    }
                    | { package: string; source: "npm" }
                    | { path: string; source: "file" }
                    | { path: string; source: "directory" }
                    | { hostPattern: string; source: "hostPattern" }
                    | { pathPattern: string; source: "pathPattern" }
                    | {
                        name: string;
                        owner?: { email?: string; name: string; url?: string };
                        plugins: {
                            description?: string;
                            name: string;
                            source:
                                | string
                                | {
                                    package: string;
                                    registry?: string;
                                    source: "npm";
                                    version?: string;
                                }
                                | {
                                    package: string;
                                    registry?: string;
                                    source: "pip";
                                    version?: string;
                                }
                                | { ref?: string; sha?: string; source: "url"; url: string }
                                | { ref?: string; repo: string; sha?: string; source: "github" }
                                | {
                                    path: string;
                                    ref?: string;
                                    sha?: string;
                                    source: "git-subdir";
                                    url: string;
                                };
                            strict?: boolean;
                            version?: string;
                        }[];
                        source: "settings";
                    };
            };
        };
        fastMode?: boolean;
        fastModePerSessionOptIn?: boolean;
        feedbackSurveyRate?: number;
        fileSuggestion?: { command: string; type: "command" };
        forceLoginMethod?: "claudeai" | "console";
        forceLoginOrgUUID?: string | string[];
        gcpAuthRefresh?: string;
        hooks?: {
            [k: string]: {
                hooks: (
                    | {
                        async?: boolean;
                        asyncRewake?: boolean;
                        command: string;
                        if?: string;
                        once?: boolean;
                        shell?: "bash"
                        | "powershell";
                        statusMessage?: string;
                        timeout?: number;
                        type: "command";
                    }
                    | {
                        if?: string;
                        model?: string;
                        once?: boolean;
                        prompt: string;
                        statusMessage?: string;
                        timeout?: number;
                        type: "prompt";
                    }
                    | {
                        if?: string;
                        model?: string;
                        once?: boolean;
                        prompt: string;
                        statusMessage?: string;
                        timeout?: number;
                        type: "agent";
                    }
                    | {
                        allowedEnvVars?: string[];
                        headers?: { [k: string]: string };
                        if?: string;
                        once?: boolean;
                        statusMessage?: string;
                        timeout?: number;
                        type: "http";
                        url: string;
                    }
                )[];
                matcher?: string;
            }[];
        };
        httpHookAllowedEnvVars?: string[];
        includeCoAuthoredBy?: boolean;
        includeGitInstructions?: boolean;
        language?: string;
        minimumVersion?: string;
        model?: string;
        modelOverrides?: { [k: string]: string };
        otelHeadersHelper?: string;
        outputStyle?: string;
        permissions?: {
            additionalDirectories?: string[];
            allow?: string[];
            ask?: string[];
            defaultMode?:
                | "plan"
                | "default"
                | "acceptEdits"
                | "bypassPermissions"
                | "dontAsk"
                | "auto";
            deny?: string[];
            disableBypassPermissionsMode?: "disable";
            [k: string]: unknown;
        };
        plansDirectory?: string;
        pluginConfigs?: {
            [k: string]: {
                mcpServers?: {
                    [k: string]: { [k: string]: string
                    | number
                    | boolean
                    | string[] };
                };
                options?: { [k: string]: string
                | number
                | boolean
                | string[] };
            };
        };
        pluginTrustMessage?: string;
        prefersReducedMotion?: boolean;
        promptSuggestionEnabled?: boolean;
        remote?: { defaultEnvironmentId?: string };
        respectGitignore?: boolean;
        sandbox?: {
            allowUnsandboxedCommands?: boolean;
            autoAllowBashIfSandboxed?: boolean;
            enabled?: boolean;
            enableWeakerNestedSandbox?: boolean;
            enableWeakerNetworkIsolation?: boolean;
            excludedCommands?: string[];
            failIfUnavailable?: boolean;
            filesystem?: {
                allowManagedReadPathsOnly?: boolean;
                allowRead?: string[];
                allowWrite?: string[];
                denyRead?: string[];
                denyWrite?: string[];
            };
            ignoreViolations?: { [k: string]: string[] };
            network?: {
                allowAllUnixSockets?: boolean;
                allowedDomains?: string[];
                allowLocalBinding?: boolean;
                allowManagedDomainsOnly?: boolean;
                allowUnixSockets?: string[];
                httpProxyPort?: number;
                socksProxyPort?: number;
            };
            ripgrep?: { args?: string[]; command: string };
            [k: string]: unknown;
        };
        showClearContextOnPlanAccept?: boolean;
        showThinkingSummaries?: boolean;
        skipDangerousModePermissionPrompt?: boolean;
        skipWebFetchPreflight?: boolean;
        spinnerTipsEnabled?: boolean;
        spinnerTipsOverride?: { excludeDefault?: boolean; tips: string[] };
        spinnerVerbs?: { mode: "append" | "replace"; verbs: string[] };
        sshConfigs?: {
            id: string;
            name: string;
            sshHost: string;
            sshIdentityFile?: string;
            sshPort?: number;
            startDirectory?: string;
        }[];
        statusLine?: { command: string; padding?: number; type: "command" };
        strictKnownMarketplaces?: (
            | { headers?: { [k: string]: string }; source: "url"; url: string }
            | {
                path?: string;
                ref?: string;
                repo: string;
                source: "github";
                sparsePaths?: string[];
            }
            | {
                path?: string;
                ref?: string;
                source: "git";
                sparsePaths?: string[];
                url: string;
            }
            | { package: string; source: "npm" }
            | { path: string; source: "file" }
            | { path: string; source: "directory" }
            | { hostPattern: string; source: "hostPattern" }
            | { pathPattern: string; source: "pathPattern" }
            | {
                name: string;
                owner?: { email?: string; name: string; url?: string };
                plugins: {
                    description?: string;
                    name: string;
                    source:
                        | string
                        | {
                            package: string;
                            registry?: string;
                            source: "npm";
                            version?: string;
                        }
                        | {
                            package: string;
                            registry?: string;
                            source: "pip";
                            version?: string;
                        }
                        | { ref?: string; sha?: string; source: "url"; url: string }
                        | { ref?: string; repo: string; sha?: string; source: "github" }
                        | {
                            path: string;
                            ref?: string;
                            sha?: string;
                            source: "git-subdir";
                            url: string;
                        };
                    strict?: boolean;
                    version?: string;
                }[];
                source: "settings";
            }
        )[];
        strictPluginOnlyCustomization?: | boolean
        | ("hooks" | "skills" | "agents" | "mcp")[];
        syntaxHighlightingDisabled?: boolean;
        terminalTitleFromRename?: boolean;
        worktree?: { sparsePaths?: string[]; symlinkDirectories?: string[] };
        [k: string]: unknown;
    }

    Indexable

    • [k: string]: unknown
    Index

    Claude SDK

    $schema?: "https://json.schemastore.org/claude-code-settings.json"

    JSON Schema reference for Claude Code settings

    advisorModel?: string

    Advisor model for the server-side advisor tool.

    agent?: string

    Name of an agent (built-in or custom) to use for the main thread. Applies the agent's system prompt, tool restrictions, and model.

    allowedChannelPlugins?: { marketplace: string; plugin: string }[]

    Teams/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.

    allowedHttpHookUrls?: string[]

    Allowlist 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).

    allowedMcpServers?: {
        serverCommand?: [string, ...string[]];
        serverName?: string;
        serverUrl?: string;
    }[]

    Enterprise 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.

    Type Declaration

    • OptionalserverCommand?: [string, ...string[]]

      Command array [command, ...args] to match exactly for allowed stdio servers

      @minItems 1

    • OptionalserverName?: string

      Name of the MCP server that users are allowed to configure

    • OptionalserverUrl?: string

      URL pattern with wildcard support (e.g., "https://.example.com/") for allowed remote MCP servers

    allowManagedHooksOnly?: boolean

    When true (and set in managed settings), only hooks from managed settings run. User, project, and local hooks are ignored.

    allowManagedMcpServersOnly?: boolean

    When 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.

    allowManagedPermissionRulesOnly?: boolean

    When 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.

    alwaysThinkingEnabled?: boolean

    When false, thinking is disabled. When absent or true, thinking is enabled automatically for supported models.

    apiKeyHelper?: string

    Path to a script that outputs authentication values

    attribution?: { commit?: string; pr?: string }

    Customize attribution text for commits and PRs. Each field defaults to the standard Claude Code attribution if not set.

    Type Declaration

    • Optionalcommit?: string

      Attribution text for git commits, including any trailers. Empty string hides attribution.

    • Optionalpr?: string

      Attribution text for pull request descriptions. Empty string hides attribution.

    autoCompactWindow?: number

    Auto-compact window size

    autoDreamEnabled?: boolean

    Enable background memory consolidation (auto-dream). When set, overrides the server-side default.

    autoMemoryDirectory?: string

    Custom 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//memory/.

    autoMemoryEnabled?: boolean

    Enable auto-memory for this project. When false, Claude will not read from or write to the auto-memory directory.

    autoUpdatesChannel?: "latest" | "stable"

    Release channel for auto-updates (latest or stable)

    availableModels?: string[]

    Allowlist 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.

    awsAuthRefresh?: string

    Path to a script that refreshes AWS authentication

    awsCredentialExport?: string

    Path to a script that exports AWS credentials

    blockedMarketplaces?: (
        | { headers?: { [k: string]: string }; source: "url"; url: string }
        | {
            path?: string;
            ref?: string;
            repo: string;
            source: "github";
            sparsePaths?: string[];
        }
        | {
            path?: string;
            ref?: string;
            source: "git";
            sparsePaths?: string[];
            url: string;
        }
        | { package: string; source: "npm" }
        | { path: string; source: "file" }
        | { path: string; source: "directory" }
        | { hostPattern: string; source: "hostPattern" }
        | { pathPattern: string; source: "pathPattern" }
        | {
            name: string;
            owner?: { email?: string; name: string; url?: string };
            plugins: {
                description?: string;
                name: string;
                source:
                    | string
                    | {
                        package: string;
                        registry?: string;
                        source: "npm";
                        version?: string;
                    }
                    | {
                        package: string;
                        registry?: string;
                        source: "pip";
                        version?: string;
                    }
                    | { ref?: string; sha?: string; source: "url"; url: string }
                    | { ref?: string; repo: string; sha?: string; source: "github" }
                    | {
                        path: string;
                        ref?: string;
                        sha?: string;
                        source: "git-subdir";
                        url: string;
                    };
                strict?: boolean;
                version?: string;
            }[];
            source: "settings";
        }
    )[]

    Enterprise 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.

    Type Declaration

    • { headers?: { [k: string]: string }; source: "url"; url: string }
      • Optionalheaders?: { [k: string]: string }

        Custom HTTP headers (e.g., for authentication)

      • source: "url"
      • url: string

        Direct URL to marketplace.json file

    • {
          path?: string;
          ref?: string;
          repo: string;
          source: "github";
          sparsePaths?: string[];
      }
      • Optionalpath?: string

        Path to marketplace.json within repo (defaults to .claude-plugin/marketplace.json)

      • Optionalref?: string

        Git branch or tag to use (e.g., "main", "v1.0.0"). Defaults to repository default branch.

      • repo: string

        GitHub repository in owner/repo format

      • source: "github"
      • 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.

    • {
          path?: string;
          ref?: string;
          source: "git";
          sparsePaths?: string[];
          url: string;
      }
      • Optionalpath?: string

        Path to marketplace.json within repo (defaults to .claude-plugin/marketplace.json)

      • Optionalref?: string

        Git branch or tag to use (e.g., "main", "v1.0.0"). Defaults to repository default branch.

      • source: "git"
      • 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.

      • url: string

        Full git repository URL

    • { package: string; source: "npm" }
      • package: string

        NPM package containing marketplace.json

      • source: "npm"
    • { path: string; source: "file" }
      • path: string

        Local file path to marketplace.json

      • source: "file"
    • { path: string; source: "directory" }
      • path: string

        Local directory containing .claude-plugin/marketplace.json

      • source: "directory"
    • { hostPattern: string; source: "hostPattern" }
      • hostPattern: string

        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$").

      • source: "hostPattern"
    • { pathPattern: string; source: "pathPattern" }
      • pathPattern: string

        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.

      • source: "pathPattern"
    • {
          name: string;
          owner?: { email?: string; name: string; url?: string };
          plugins: {
              description?: string;
              name: string;
              source:
                  | string
                  | { package: string; registry?: string; source: "npm"; version?: string }
                  | { package: string; registry?: string; source: "pip"; version?: string }
                  | { ref?: string; sha?: string; source: "url"; url: string }
                  | { ref?: string; repo: string; sha?: string; source: "github" }
                  | {
                      path: string;
                      ref?: string;
                      sha?: string;
                      source: "git-subdir";
                      url: string;
                  };
              strict?: boolean;
              version?: string;
          }[];
          source: "settings";
      }
      • name: string

        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?: string

          Contact email for support or feedback

        • name: string

          Display name of the plugin author or organization

        • Optionalurl?: string

          Website, GitHub profile, or organization URL

      • plugins: {
            description?: string;
            name: string;
            source:
                | string
                | { package: string; registry?: string; source: "npm"; version?: string }
                | { package: string; registry?: string; source: "pip"; version?: string }
                | { ref?: string; sha?: string; source: "url"; url: string }
                | { ref?: string; repo: string; sha?: string; source: "github" }
                | {
                    path: string;
                    ref?: string;
                    sha?: string;
                    source: "git-subdir";
                    url: string;
                };
            strict?: boolean;
            version?: string;
        }[]

        Plugin entries declared inline in settings.json

      • source: "settings"
    channelsEnabled?: boolean

    Teams/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.

    claudeMdExcludes?: string[]

    Glob 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/**"

    cleanupPeriodDays?: number

    Number 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.

    companyAnnouncements?: string[]

    Company announcements to display at startup (one will be randomly selected if multiple are provided)

    defaultShell?: "bash" | "powershell"

    Default shell for input-box ! commands. Defaults to 'bash' on all platforms (no Windows auto-flip).

    deniedMcpServers?: {
        serverCommand?: [string, ...string[]];
        serverName?: string;
        serverUrl?: string;
    }[]

    Enterprise 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.

    Type Declaration

    • OptionalserverCommand?: [string, ...string[]]

      Command array [command, ...args] to match exactly for blocked stdio servers

      @minItems 1

    • OptionalserverName?: string

      Name of the MCP server that is explicitly blocked

    • OptionalserverUrl?: string

      URL pattern with wildcard support (e.g., "https://.example.com/") for blocked remote MCP servers

    disableAllHooks?: boolean

    Disable all hooks and statusLine execution

    disableAutoMode?: "disable"

    Disable auto mode

    disabledMcpjsonServers?: string[]

    List of rejected MCP servers from .mcp.json

    disableSkillShellExecution?: boolean

    Disable 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.

    effortLevel?: "high" | "medium" | "low"

    Persisted effort level for supported models.

    enableAllProjectMcpServers?: boolean

    Whether to automatically approve all MCP servers in the project

    enabledMcpjsonServers?: string[]

    List of approved MCP servers from .mcp.json

    enabledPlugins?: { [k: string]: boolean | string[] | { [k: string]: unknown } }

    Enabled plugins using plugin-id@marketplace-id format. Example: { "formatter@anthropic-tools": true }. Also supports extended format with version constraints.

    env?: { [k: string]: string }

    Environment variables to set for Claude Code sessions

    extraKnownMarketplaces?: {
        [k: string]: {
            autoUpdate?: boolean;
            installLocation?: string;
            source:
                | { headers?: { [k: string]: string }; source: "url"; url: string }
                | {
                    path?: string;
                    ref?: string;
                    repo: string;
                    source: "github";
                    sparsePaths?: string[];
                }
                | {
                    path?: string;
                    ref?: string;
                    source: "git";
                    sparsePaths?: string[];
                    url: string;
                }
                | { package: string; source: "npm" }
                | { path: string; source: "file" }
                | { path: string; source: "directory" }
                | { hostPattern: string; source: "hostPattern" }
                | { pathPattern: string; source: "pathPattern" }
                | {
                    name: string;
                    owner?: { email?: string; name: string; url?: string };
                    plugins: {
                        description?: string;
                        name: string;
                        source:
                            | string
                            | {
                                package: string;
                                registry?: string;
                                source: "npm";
                                version?: string;
                            }
                            | {
                                package: string;
                                registry?: string;
                                source: "pip";
                                version?: string;
                            }
                            | { ref?: string; sha?: string; source: "url"; url: string }
                            | { ref?: string; repo: string; sha?: string; source: "github" }
                            | {
                                path: string;
                                ref?: string;
                                sha?: string;
                                source: "git-subdir";
                                url: string;
                            };
                        strict?: boolean;
                        version?: string;
                    }[];
                    source: "settings";
                };
        };
    }

    Additional marketplaces to make available for this repository. Typically used in repository .claude/settings.json to ensure team members have required plugin sources.

    fastMode?: boolean

    When true, fast mode is enabled. When absent or false, fast mode is off.

    fastModePerSessionOptIn?: boolean

    When true, fast mode does not persist across sessions. Each session starts with fast mode off.

    feedbackSurveyRate?: number

    Probability (0–1) that the session quality survey appears when eligible. 0.05 is a reasonable starting point.

    fileSuggestion?: { command: string; type: "command" }

    Custom file suggestion configuration for @ mentions

    forceLoginMethod?: "claudeai" | "console"

    Force a specific login method: "claudeai" for Claude Pro/Max, "console" for Console billing

    forceLoginOrgUUID?: string | string[]

    Organization 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.

    gcpAuthRefresh?: string

    Command to refresh GCP authentication (e.g., gcloud auth application-default login)

    hooks?: {
        [k: string]: {
            hooks: (
                | {
                    async?: boolean;
                    asyncRewake?: boolean;
                    command: string;
                    if?: string;
                    once?: boolean;
                    shell?: "bash"
                    | "powershell";
                    statusMessage?: string;
                    timeout?: number;
                    type: "command";
                }
                | {
                    if?: string;
                    model?: string;
                    once?: boolean;
                    prompt: string;
                    statusMessage?: string;
                    timeout?: number;
                    type: "prompt";
                }
                | {
                    if?: string;
                    model?: string;
                    once?: boolean;
                    prompt: string;
                    statusMessage?: string;
                    timeout?: number;
                    type: "agent";
                }
                | {
                    allowedEnvVars?: string[];
                    headers?: { [k: string]: string };
                    if?: string;
                    once?: boolean;
                    statusMessage?: string;
                    timeout?: number;
                    type: "http";
                    url: string;
                }
            )[];
            matcher?: string;
        }[];
    }

    Custom commands to run before/after tool executions

    httpHookAllowedEnvVars?: string[]

    Allowlist 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).

    includeCoAuthoredBy?: boolean

    Deprecated: Use attribution instead. Whether to include Claude's co-authored by attribution in commits and PRs (defaults to true)

    includeGitInstructions?: boolean

    Include built-in commit and PR workflow instructions in Claude's system prompt (default: true)

    language?: string

    Preferred language for Claude responses and voice dictation (e.g., "japanese", "spanish")

    minimumVersion?: string

    Minimum version to stay on - prevents downgrades when switching to stable channel

    model?: string

    Override the default model used by Claude Code

    modelOverrides?: { [k: string]: string }

    Override 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.

    otelHeadersHelper?: string

    Path to a script that outputs OpenTelemetry headers

    outputStyle?: string

    Controls the output style for assistant responses

    permissions?: {
        additionalDirectories?: string[];
        allow?: string[];
        ask?: string[];
        defaultMode?:
            | "plan"
            | "default"
            | "acceptEdits"
            | "bypassPermissions"
            | "dontAsk"
            | "auto";
        deny?: string[];
        disableBypassPermissionsMode?: "disable";
        [k: string]: unknown;
    }

    Tool usage permissions configuration

    Type Declaration

    • [k: string]: unknown
    • 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

    plansDirectory?: string

    Custom directory for plan files, relative to project root. If not set, defaults to ~/.claude/plans/

    pluginConfigs?: {
        [k: string]: {
            mcpServers?: {
                [k: string]: { [k: string]: string | number | boolean | string[] };
            };
            options?: { [k: string]: string
            | number
            | boolean
            | string[] };
        };
    }

    Per-plugin configuration including MCP server user configs, keyed by plugin ID (plugin@marketplace format)

    pluginTrustMessage?: string

    Custom 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.").

    prefersReducedMotion?: boolean

    Reduce or disable animations for accessibility (spinner shimmer, flash effects, etc.)

    promptSuggestionEnabled?: boolean

    When false, prompt suggestions are disabled. When absent or true, prompt suggestions are enabled.

    remote?: { defaultEnvironmentId?: string }

    Remote session configuration

    Type Declaration

    • OptionaldefaultEnvironmentId?: string

      Default environment ID to use for remote sessions

    respectGitignore?: boolean

    Whether file picker should respect .gitignore files (default: true). Note: .ignore files are always respected.

    sandbox?: {
        allowUnsandboxedCommands?: boolean;
        autoAllowBashIfSandboxed?: boolean;
        enabled?: boolean;
        enableWeakerNestedSandbox?: boolean;
        enableWeakerNetworkIsolation?: boolean;
        excludedCommands?: string[];
        failIfUnavailable?: boolean;
        filesystem?: {
            allowManagedReadPathsOnly?: boolean;
            allowRead?: string[];
            allowWrite?: string[];
            denyRead?: string[];
            denyWrite?: string[];
        };
        ignoreViolations?: { [k: string]: string[] };
        network?: {
            allowAllUnixSockets?: boolean;
            allowedDomains?: string[];
            allowLocalBinding?: boolean;
            allowManagedDomainsOnly?: boolean;
            allowUnixSockets?: string[];
            httpProxyPort?: number;
            socksProxyPort?: number;
        };
        ripgrep?: { args?: string[]; command: string };
        [k: string]: unknown;
    }

    Type Declaration

    • [k: string]: unknown
    • OptionalallowUnsandboxedCommands?: boolean

      Allow 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?: boolean
    • Optionalenabled?: boolean
    • OptionalenableWeakerNestedSandbox?: boolean
    • OptionalenableWeakerNetworkIsolation?: boolean

      macOS 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?: boolean

      Exit 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?: {
          allowManagedReadPathsOnly?: boolean;
          allowRead?: string[];
          allowWrite?: string[];
          denyRead?: string[];
          denyWrite?: string[];
      }
      • OptionalallowManagedReadPathsOnly?: boolean

        When 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?: {
          allowAllUnixSockets?: boolean;
          allowedDomains?: string[];
          allowLocalBinding?: boolean;
          allowManagedDomainsOnly?: boolean;
          allowUnixSockets?: string[];
          httpProxyPort?: number;
          socksProxyPort?: number;
      }
      • OptionalallowAllUnixSockets?: boolean

        If true, allow all Unix sockets (disables blocking on both platforms).

      • OptionalallowedDomains?: string[]
      • OptionalallowLocalBinding?: boolean
      • OptionalallowManagedDomainsOnly?: boolean

        When 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?: number
      • OptionalsocksProxyPort?: number
    • Optionalripgrep?: { args?: string[]; command: string }

      Custom ripgrep configuration for bundled ripgrep support

    showClearContextOnPlanAccept?: boolean

    When true, the plan-approval dialog offers a "clear context" option. Defaults to false.

    showThinkingSummaries?: boolean

    Show thinking summaries in the transcript view (ctrl+o). Default: false.

    skipDangerousModePermissionPrompt?: boolean

    Whether the user has accepted the bypass permissions mode dialog

    skipWebFetchPreflight?: boolean

    Skip the WebFetch blocklist check for enterprise environments with restrictive security policies

    spinnerTipsEnabled?: boolean

    Whether to show tips in the spinner

    spinnerTipsOverride?: { excludeDefault?: boolean; tips: string[] }

    Override spinner tips. tips: array of tip strings. excludeDefault: if true, only show custom tips (default: false).

    spinnerVerbs?: { mode: "append" | "replace"; verbs: string[] }

    Customize spinner verbs. mode: "append" adds verbs to defaults, "replace" uses only your verbs.

    sshConfigs?: {
        id: string;
        name: string;
        sshHost: string;
        sshIdentityFile?: string;
        sshPort?: number;
        startDirectory?: string;
    }[]

    SSH connection configurations for remote environments. Typically set in managed settings by enterprise administrators to pre-configure SSH connections for team members.

    Type Declaration

    • id: string

      Unique identifier for this SSH config. Used to match configs across settings sources.

    • name: string

      Display name for the SSH connection

    • sshHost: string

      SSH host in format "user@hostname" or "hostname", or a host alias from ~/.ssh/config

    • OptionalsshIdentityFile?: string

      Path to SSH identity file (private key)

    • OptionalsshPort?: number

      SSH port (default: 22)

    • OptionalstartDirectory?: string

      Default 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].

    statusLine?: { command: string; padding?: number; type: "command" }

    Custom status line display configuration

    strictKnownMarketplaces?: (
        | { headers?: { [k: string]: string }; source: "url"; url: string }
        | {
            path?: string;
            ref?: string;
            repo: string;
            source: "github";
            sparsePaths?: string[];
        }
        | {
            path?: string;
            ref?: string;
            source: "git";
            sparsePaths?: string[];
            url: string;
        }
        | { package: string; source: "npm" }
        | { path: string; source: "file" }
        | { path: string; source: "directory" }
        | { hostPattern: string; source: "hostPattern" }
        | { pathPattern: string; source: "pathPattern" }
        | {
            name: string;
            owner?: { email?: string; name: string; url?: string };
            plugins: {
                description?: string;
                name: string;
                source:
                    | string
                    | {
                        package: string;
                        registry?: string;
                        source: "npm";
                        version?: string;
                    }
                    | {
                        package: string;
                        registry?: string;
                        source: "pip";
                        version?: string;
                    }
                    | { ref?: string; sha?: string; source: "url"; url: string }
                    | { ref?: string; repo: string; sha?: string; source: "github" }
                    | {
                        path: string;
                        ref?: string;
                        sha?: string;
                        source: "git-subdir";
                        url: string;
                    };
                strict?: boolean;
                version?: string;
            }[];
            source: "settings";
        }
    )[]

    Enterprise 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.

    Type Declaration

    • { headers?: { [k: string]: string }; source: "url"; url: string }
      • Optionalheaders?: { [k: string]: string }

        Custom HTTP headers (e.g., for authentication)

      • source: "url"
      • url: string

        Direct URL to marketplace.json file

    • {
          path?: string;
          ref?: string;
          repo: string;
          source: "github";
          sparsePaths?: string[];
      }
      • Optionalpath?: string

        Path to marketplace.json within repo (defaults to .claude-plugin/marketplace.json)

      • Optionalref?: string

        Git branch or tag to use (e.g., "main", "v1.0.0"). Defaults to repository default branch.

      • repo: string

        GitHub repository in owner/repo format

      • source: "github"
      • 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.

    • {
          path?: string;
          ref?: string;
          source: "git";
          sparsePaths?: string[];
          url: string;
      }
      • Optionalpath?: string

        Path to marketplace.json within repo (defaults to .claude-plugin/marketplace.json)

      • Optionalref?: string

        Git branch or tag to use (e.g., "main", "v1.0.0"). Defaults to repository default branch.

      • source: "git"
      • 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.

      • url: string

        Full git repository URL

    • { package: string; source: "npm" }
      • package: string

        NPM package containing marketplace.json

      • source: "npm"
    • { path: string; source: "file" }
      • path: string

        Local file path to marketplace.json

      • source: "file"
    • { path: string; source: "directory" }
      • path: string

        Local directory containing .claude-plugin/marketplace.json

      • source: "directory"
    • { hostPattern: string; source: "hostPattern" }
      • hostPattern: string

        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$").

      • source: "hostPattern"
    • { pathPattern: string; source: "pathPattern" }
      • pathPattern: string

        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.

      • source: "pathPattern"
    • {
          name: string;
          owner?: { email?: string; name: string; url?: string };
          plugins: {
              description?: string;
              name: string;
              source:
                  | string
                  | { package: string; registry?: string; source: "npm"; version?: string }
                  | { package: string; registry?: string; source: "pip"; version?: string }
                  | { ref?: string; sha?: string; source: "url"; url: string }
                  | { ref?: string; repo: string; sha?: string; source: "github" }
                  | {
                      path: string;
                      ref?: string;
                      sha?: string;
                      source: "git-subdir";
                      url: string;
                  };
              strict?: boolean;
              version?: string;
          }[];
          source: "settings";
      }
      • name: string

        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?: string

          Contact email for support or feedback

        • name: string

          Display name of the plugin author or organization

        • Optionalurl?: string

          Website, GitHub profile, or organization URL

      • plugins: {
            description?: string;
            name: string;
            source:
                | string
                | { package: string; registry?: string; source: "npm"; version?: string }
                | { package: string; registry?: string; source: "pip"; version?: string }
                | { ref?: string; sha?: string; source: "url"; url: string }
                | { ref?: string; repo: string; sha?: string; source: "github" }
                | {
                    path: string;
                    ref?: string;
                    sha?: string;
                    source: "git-subdir";
                    url: string;
                };
            strict?: boolean;
            version?: string;
        }[]

        Plugin entries declared inline in settings.json

      • source: "settings"
    strictPluginOnlyCustomization?:
        | boolean
        | ("hooks" | "skills" | "agents" | "mcp")[]

    When 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.

    syntaxHighlightingDisabled?: boolean

    Whether to disable syntax highlighting in diffs

    terminalTitleFromRename?: boolean

    Whether /rename updates the terminal tab title (defaults to true). Set to false to keep auto-generated topic titles.

    worktree?: { sparsePaths?: string[]; symlinkDirectories?: string[] }

    Git worktree configuration for --worktree flag.

    Type Declaration

    • 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"