Settings

export type Settings = {
  // optional
  bridge?: "herdr"
  harness?: "claude-code"
  notifications?: boolean
  permissionMode?: "acceptEdits" | "auto" | "bypassPermissions" | "default" | "dontAsk" | "plan"
  theme?: "dark" | "light" | "system"
}

type Config = {
  $schema?: string
  agents?: {
    readonly [x: string]: {
      readonly model?:
        | string
        | {
            readonly providerID: string
            readonly model: string
            readonly variant?: string | undefined
          }
        | undefined
      readonly request?:
        | {
            readonly headers?: { readonly [x: string]: string } | undefined
            readonly body?: { readonly [x: string]: Json } | undefined
          }
        | undefined
      readonly system?: string | undefined
      readonly description?: string | undefined
      readonly mode?: "all" | "primary" | "subagent" | undefined
      readonly hidden?: boolean | undefined
      readonly color?: string | undefined
      readonly steps?: number | undefined
      readonly disabled?: boolean | undefined
      readonly permissions?:
        | readonly {
            readonly action: string
            readonly resource: string
            readonly effect: "allow" | "ask" | "deny"
          }[]
        | undefined
    }
  }
  commands?: {
    readonly [x: string]: {
      readonly template: string
      readonly description?: string | undefined
      readonly agent?: string | undefined
      readonly model?:
        | string
        | {
            readonly providerID: string
            readonly model: string
            readonly variant?: string | undefined
          }
        | undefined
      readonly subagent?: boolean | undefined
      readonly subtask?: boolean | undefined
    }
  }
  compaction?: {
    readonly auto?: boolean | undefined
    readonly keep?: { readonly tokens?: number | undefined } | undefined
    readonly buffer?: number | undefined
  }
  default_agent?: string
  enterprise?: { readonly url?: string | undefined }
  experimental?: {
    readonly portable_shell_scanner?: boolean | undefined
    readonly todo?: boolean | undefined
    readonly subagent_depth?: number | undefined
    readonly location_idle_timeout?: string | false | undefined
    readonly policies?:
      | readonly {
          readonly action: "integration.use" | "provider.use" | "tool.use"
          readonly resource: string
          readonly effect: "allow" | "deny"
        }[]
      | undefined
  }
  formatter?:
    | boolean
    | {
        readonly [x: string]: {
          readonly disabled?: boolean | undefined
          readonly command?: readonly string[] | undefined
          readonly environment?: { readonly [x: string]: string } | undefined
          readonly extensions?: readonly string[] | undefined
        }
      }
  instructions?: readonly string[]
  lsp?:
    | boolean
    | {
        readonly [x: string]:
          | {
              readonly command: readonly string[]
              readonly extensions?: readonly string[] | undefined
              readonly disabled?: boolean | undefined
              readonly env?: { readonly [x: string]: string } | undefined
              readonly initialization?: { readonly [x: string]: unknown } | undefined
            }
          | { readonly disabled: true }
      }
  mcp?: {
    readonly timeout?:
      | {
          readonly startup?: number | undefined
          readonly catalog?: number | undefined
          readonly execution?: number | undefined
        }
      | undefined
    readonly servers?:
      | {
          readonly [x: string]:
            | {
                readonly type: "local"
                readonly command: readonly string[]
                readonly cwd?: string | undefined
                readonly environment?: { readonly [x: string]: string } | undefined
                readonly disabled?: boolean | undefined
                readonly codemode?: boolean | undefined
                readonly timeout?:
                  | {
                      readonly startup?: number | undefined
                      readonly catalog?: number | undefined
                      readonly execution?: number | undefined
                    }
                  | undefined
                readonly protocol?: "2026-07-28" | "auto" | "legacy" | undefined
              }
            | {
                readonly type: "remote"
                readonly url: string
                readonly headers?: { readonly [x: string]: string } | undefined
                readonly oauth?:
                  | false
                  | {
                      readonly client_id?: string | undefined
                      readonly client_secret?: string | undefined
                      readonly scope?: string | undefined
                      readonly callback_port?: number | undefined
                      readonly redirect_uri?: string | undefined
                      readonly auth_server_metadata_url?: string | undefined
                    }
                  | undefined
                readonly disabled?: boolean | undefined
                readonly codemode?: boolean | undefined
                readonly timeout?:
                  | {
                      readonly startup?: number | undefined
                      readonly catalog?: number | undefined
                      readonly execution?: number | undefined
                    }
                  | undefined
                readonly protocol?: "2026-07-28" | "auto" | "legacy" | undefined
              }
        }
      | undefined
  }
  media?: {
    readonly image?:
      | {
          readonly auto_resize?: boolean | undefined
          readonly max_width?: number | undefined
          readonly max_height?: number | undefined
          readonly max_base64_bytes?: number | undefined
        }
      | undefined
  }
  model?:
    | string
    | { readonly providerID: string; readonly model: string; readonly variant?: string | undefined }
  permissions?: readonly {
    readonly action: string
    readonly resource: string
    readonly effect: "allow" | "ask" | "deny"
  }[]
  plugins?: readonly (
    | string
    | { readonly package: string; readonly options?: { readonly [x: string]: unknown } | undefined }
  )[]
  policies?: readonly {
    readonly action: "integration.use" | "provider.use" | "tool.use"
    readonly resource: string
    readonly effect: "allow" | "deny"
  }[]
  providers?: {
    readonly [x: string]: {
      readonly settings?:
        | {
            readonly [x: string]: Json | undefined
            readonly timeout?: number | false | undefined
            readonly headerTimeout?: number | false | undefined
            readonly chunkTimeout?: number | false | undefined
            readonly compaction?:
              { readonly type: "summary" } | { readonly type: "native" } | undefined
            readonly transport?: "http" | "websocket" | undefined
            readonly encoding?: "gzip" | "none" | "zstd" | undefined
          }
        | undefined
      readonly headers?: { readonly [x: string]: string } | undefined
      readonly body?: { readonly [x: string]: Json } | undefined
      readonly canonical?: string | undefined
      readonly name?: string | undefined
      readonly env?: readonly string[] | undefined
      readonly package?: string | undefined
      readonly compatibility?:
        | {
            readonly reasoningField?: ReasoningField | undefined
            readonly requireReasoning?: boolean | undefined
            readonly maxTokensField?: "max_completion_tokens" | "max_tokens" | undefined
            readonly requireFinishReason?: boolean | undefined
            readonly requireAssistantAfterTool?: boolean | undefined
            readonly supportsPromptCacheKey?: boolean | undefined
            readonly streamUsage?: boolean | undefined
            readonly cacheFormat?: "alibaba" | "anthropic" | undefined
          }
        | undefined
      readonly models?:
        | {
            readonly [x: string]: {
              readonly settings?:
                | {
                    readonly [x: string]: Json | undefined
                    readonly compaction?:
                      { readonly type: "summary" } | { readonly type: "native" } | undefined
                    readonly encoding?: "gzip" | "none" | "zstd" | undefined
                  }
                | undefined
              readonly headers?: { readonly [x: string]: string } | undefined
              readonly body?: { readonly [x: string]: Json } | undefined
              readonly modelID?: string | undefined
              readonly family?: string | undefined
              readonly name?: string | undefined
              readonly releaseDate?: string | undefined
              readonly compatibility?:
                | {
                    readonly reasoningField?: ReasoningField | undefined
                    readonly requireReasoning?: boolean | undefined
                    readonly maxTokensField?: "max_completion_tokens" | "max_tokens" | undefined
                    readonly requireFinishReason?: boolean | undefined
                    readonly requireAssistantAfterTool?: boolean | undefined
                    readonly supportsPromptCacheKey?: boolean | undefined
                    readonly streamUsage?: boolean | undefined
                    readonly cacheFormat?: "alibaba" | "anthropic" | undefined
                    readonly supportsThinkingBlockBinding?: boolean | undefined
                    readonly supportsEffortUpdates?: boolean | undefined
                  }
                | undefined
              readonly package?: string | undefined
              readonly capabilities?:
                | {
                    readonly tools?: boolean | undefined
                    readonly input?: readonly string[] | undefined
                    readonly output?: readonly string[] | undefined
                    readonly temperature?: boolean | undefined
                    readonly reasoning?:
                      | { readonly supported: false }
                      | {
                          readonly supported: true
                          readonly toggle?: boolean | undefined
                          readonly effort?: readonly string[] | undefined
                          readonly budget?:
                            | {
                                readonly min?: number | undefined
                                readonly max?: number | undefined
                              }
                            | undefined
                        }
                      | undefined
                  }
                | undefined
              readonly variants?:
                | readonly {
                    readonly settings?:
                      | {
                          readonly [x: string]: Json | undefined
                          readonly compaction?:
                            { readonly type: "summary" } | { readonly type: "native" } | undefined
                          readonly encoding?: "gzip" | "none" | "zstd" | undefined
                        }
                      | undefined
                    readonly headers?: { readonly [x: string]: string } | undefined
                    readonly body?: { readonly [x: string]: Json } | undefined
                    readonly id: string
                  }[]
                | undefined
              readonly cost?:
                | readonly {
                    readonly tier?: { readonly type: "context"; readonly size: number } | undefined
                    readonly input: number
                    readonly output: number
                    readonly cache?:
                      | { readonly read?: number | undefined; readonly write?: number | undefined }
                      | undefined
                  }[]
                | {
                    readonly tier?: { readonly type: "context"; readonly size: number } | undefined
                    readonly input: number
                    readonly output: number
                    readonly cache?:
                      | { readonly read?: number | undefined; readonly write?: number | undefined }
                      | undefined
                  }
                | undefined
              readonly disabled?: boolean | undefined
              readonly limit?:
                | {
                    readonly context?: number | undefined
                    readonly input?: number | undefined
                    readonly output?: number | undefined
                  }
                | undefined
            }
          }
        | undefined
    }
  }
  references?: {
    readonly [x: string]:
      | string
      | {
          readonly repository: string
          readonly branch?: string | undefined
          readonly description?: string | undefined
          readonly hidden?: boolean | undefined
        }
      | {
          readonly path: string
          readonly description?: string | undefined
          readonly hidden?: boolean | undefined
        }
  }
  share?: "auto" | "disabled" | "manual"
  shell?: string
  skills?: readonly string[]
  snapshots?: boolean
  tool_output?: { readonly max_lines?: number | undefined; readonly max_bytes?: number | undefined }
  update?: "auto" | "disable" | "notify"
  username?: string
  warming?:
    | boolean
    | {
        readonly prompt?: string | undefined
        readonly interval?: string | undefined
        readonly duration?: string | undefined
      }
  watcher?: { readonly ignore?: readonly string[] | undefined }
  websearch?: false | { readonly provider: string }
  worktree?: { readonly directory: string }
}

type Settings = {
  inputNeededNotifEnabled?: boolean
  permissions?: {
    [k: string]: unknown
    allow?: string[] | undefined
    deny?: string[] | undefined
    ask?: string[] | undefined
    defaultMode?:
      "acceptEdits" | "auto" | "bypassPermissions" | "default" | "dontAsk" | "plan" | undefined
    disableBypassPermissionsMode?: "disable" | undefined
    blockReadsOutsideWorkingDirectories?: boolean | undefined
    additionalDirectories?: string[] | undefined
  }
  teammateMode?: "auto" | "in-process" | "iterm2" | "tmux"
  theme?: string
}

type Config = {
  analytics: AnalyticsConfig | null
  approval_policy: AskForApproval | null
  approvals_reviewer: ApprovalsReviewer | null
  browser_use: BrowserUseConfig | null
  compact_prompt: string | null
  computer_use: ComputerUseConfig | null
  desktop: { [x: string]: JsonValue | undefined } | null
  developer_instructions: string | null
  forced_chatgpt_workspace_id: ForcedChatgptWorkspaceIds | null
  forced_login_method: ForcedLoginMethod | null
  instructions: string | null
  model: string | null
  model_auto_compact_token_limit: bigint | null
  model_auto_compact_token_limit_scope: AutoCompactTokenLimitScope | null
  model_context_window: bigint | null
  model_provider: string | null
  model_reasoning_effort: string | null
  model_reasoning_summary: ReasoningSummary | null
  model_verbosity: Verbosity | null
  review_model: string | null
  sandbox_mode: SandboxMode | null
  sandbox_workspace_write: SandboxWorkspaceWrite | null
  service_tier: string | null
  tools: ToolsV2 | null
  web_search: WebSearchMode | null
}