1101 lines
43 KiB
TypeScript
1101 lines
43 KiB
TypeScript
import { Log } from "../util"
|
|
import path from "path"
|
|
import { pathToFileURL } from "url"
|
|
import os from "os"
|
|
import z from "zod"
|
|
import { mergeDeep, pipe } from "remeda"
|
|
import { Global } from "../global"
|
|
import fsNode from "fs/promises"
|
|
import { NamedError } from "@opencode-ai/shared/util/error"
|
|
import { Flag } from "../flag/flag"
|
|
import { Auth } from "../auth"
|
|
import { Env } from "../env"
|
|
import {
|
|
type ParseError as JsoncParseError,
|
|
applyEdits,
|
|
modify,
|
|
parse as parseJsonc,
|
|
printParseErrorCode,
|
|
} from "jsonc-parser"
|
|
import { Instance, type InstanceContext } from "../project/instance"
|
|
import * as LSPServer from "../lsp/server"
|
|
import { InstallationLocal, InstallationVersion } from "@/installation/version"
|
|
import { existsSync } from "fs"
|
|
import { GlobalBus } from "@/bus/global"
|
|
import { Event } from "../server/event"
|
|
import { Account } from "@/account"
|
|
import { isRecord } from "@/util/record"
|
|
import * as ConfigPaths from "./paths"
|
|
import type { ConsoleState } from "./console-state"
|
|
import { AppFileSystem } from "@opencode-ai/shared/filesystem"
|
|
import { InstanceState } from "@/effect"
|
|
import { Context, Duration, Effect, Exit, Fiber, Layer, Option } from "effect"
|
|
import { EffectFlock } from "@opencode-ai/shared/util/effect-flock"
|
|
import { InstanceRef } from "@/effect/instance-ref"
|
|
import { Npm } from "@opencode-ai/shared/npm"
|
|
import { ConfigAgent } from "./agent"
|
|
import { ConfigMCP } from "./mcp"
|
|
import { ConfigModelID } from "./model-id"
|
|
import { ConfigPlugin } from "./plugin"
|
|
import { ConfigManaged } from "./managed"
|
|
import { ConfigCommand } from "./command"
|
|
import { ConfigPermission } from "./permission"
|
|
|
|
const log = Log.create({ service: "config" })
|
|
|
|
// Custom merge function that concatenates array fields instead of replacing them
|
|
function mergeConfigConcatArrays(target: Info, source: Info): Info {
|
|
const merged = mergeDeep(target, source)
|
|
if (target.instructions && source.instructions) {
|
|
merged.instructions = Array.from(new Set([...target.instructions, ...source.instructions]))
|
|
}
|
|
return merged
|
|
}
|
|
|
|
export const Skills = z.object({
|
|
paths: z.array(z.string()).optional().describe("Additional paths to skill folders"),
|
|
urls: z
|
|
.array(z.string())
|
|
.optional()
|
|
.describe("URLs to fetch skills from (e.g., https://example.com/.well-known/skills/)"),
|
|
})
|
|
export type Skills = z.infer<typeof Skills>
|
|
|
|
export const Keybinds = z
|
|
.object({
|
|
leader: z.string().optional().default("ctrl+x").describe("Leader key for keybind combinations"),
|
|
app_exit: z.string().optional().default("ctrl+c,ctrl+d,<leader>q").describe("Exit the application"),
|
|
editor_open: z.string().optional().default("<leader>e").describe("Open external editor"),
|
|
theme_list: z.string().optional().default("<leader>t").describe("List available themes"),
|
|
sidebar_toggle: z.string().optional().default("<leader>b").describe("Toggle sidebar"),
|
|
scrollbar_toggle: z.string().optional().default("none").describe("Toggle session scrollbar"),
|
|
username_toggle: z.string().optional().default("none").describe("Toggle username visibility"),
|
|
status_view: z.string().optional().default("<leader>s").describe("View status"),
|
|
session_export: z.string().optional().default("<leader>x").describe("Export session to editor"),
|
|
session_new: z.string().optional().default("<leader>n").describe("Create a new session"),
|
|
session_list: z.string().optional().default("<leader>l").describe("List all sessions"),
|
|
session_timeline: z.string().optional().default("<leader>g").describe("Show session timeline"),
|
|
session_fork: z.string().optional().default("none").describe("Fork session from message"),
|
|
session_rename: z.string().optional().default("ctrl+r").describe("Rename session"),
|
|
session_delete: z.string().optional().default("ctrl+d").describe("Delete session"),
|
|
stash_delete: z.string().optional().default("ctrl+d").describe("Delete stash entry"),
|
|
model_provider_list: z.string().optional().default("ctrl+a").describe("Open provider list from model dialog"),
|
|
model_favorite_toggle: z.string().optional().default("ctrl+f").describe("Toggle model favorite status"),
|
|
session_share: z.string().optional().default("none").describe("Share current session"),
|
|
session_unshare: z.string().optional().default("none").describe("Unshare current session"),
|
|
session_interrupt: z.string().optional().default("escape").describe("Interrupt current session"),
|
|
session_compact: z.string().optional().default("<leader>c").describe("Compact the session"),
|
|
messages_page_up: z.string().optional().default("pageup,ctrl+alt+b").describe("Scroll messages up by one page"),
|
|
messages_page_down: z
|
|
.string()
|
|
.optional()
|
|
.default("pagedown,ctrl+alt+f")
|
|
.describe("Scroll messages down by one page"),
|
|
messages_line_up: z.string().optional().default("ctrl+alt+y").describe("Scroll messages up by one line"),
|
|
messages_line_down: z.string().optional().default("ctrl+alt+e").describe("Scroll messages down by one line"),
|
|
messages_half_page_up: z.string().optional().default("ctrl+alt+u").describe("Scroll messages up by half page"),
|
|
messages_half_page_down: z.string().optional().default("ctrl+alt+d").describe("Scroll messages down by half page"),
|
|
messages_first: z.string().optional().default("ctrl+g,home").describe("Navigate to first message"),
|
|
messages_last: z.string().optional().default("ctrl+alt+g,end").describe("Navigate to last message"),
|
|
messages_next: z.string().optional().default("none").describe("Navigate to next message"),
|
|
messages_previous: z.string().optional().default("none").describe("Navigate to previous message"),
|
|
messages_last_user: z.string().optional().default("none").describe("Navigate to last user message"),
|
|
messages_copy: z.string().optional().default("<leader>y").describe("Copy message"),
|
|
messages_undo: z.string().optional().default("<leader>u").describe("Undo message"),
|
|
messages_redo: z.string().optional().default("<leader>r").describe("Redo message"),
|
|
messages_toggle_conceal: z
|
|
.string()
|
|
.optional()
|
|
.default("<leader>h")
|
|
.describe("Toggle code block concealment in messages"),
|
|
tool_details: z.string().optional().default("none").describe("Toggle tool details visibility"),
|
|
model_list: z.string().optional().default("<leader>m").describe("List available models"),
|
|
model_cycle_recent: z.string().optional().default("f2").describe("Next recently used model"),
|
|
model_cycle_recent_reverse: z.string().optional().default("shift+f2").describe("Previous recently used model"),
|
|
model_cycle_favorite: z.string().optional().default("none").describe("Next favorite model"),
|
|
model_cycle_favorite_reverse: z.string().optional().default("none").describe("Previous favorite model"),
|
|
command_list: z.string().optional().default("ctrl+p").describe("List available commands"),
|
|
agent_list: z.string().optional().default("<leader>a").describe("List agents"),
|
|
agent_cycle: z.string().optional().default("tab").describe("Next agent"),
|
|
agent_cycle_reverse: z.string().optional().default("shift+tab").describe("Previous agent"),
|
|
variant_cycle: z.string().optional().default("ctrl+t").describe("Cycle model variants"),
|
|
variant_list: z.string().optional().default("none").describe("List model variants"),
|
|
input_clear: z.string().optional().default("ctrl+c").describe("Clear input field"),
|
|
input_paste: z.string().optional().default("ctrl+v").describe("Paste from clipboard"),
|
|
input_submit: z.string().optional().default("return").describe("Submit input"),
|
|
input_newline: z
|
|
.string()
|
|
.optional()
|
|
.default("shift+return,ctrl+return,alt+return,ctrl+j")
|
|
.describe("Insert newline in input"),
|
|
input_move_left: z.string().optional().default("left,ctrl+b").describe("Move cursor left in input"),
|
|
input_move_right: z.string().optional().default("right,ctrl+f").describe("Move cursor right in input"),
|
|
input_move_up: z.string().optional().default("up").describe("Move cursor up in input"),
|
|
input_move_down: z.string().optional().default("down").describe("Move cursor down in input"),
|
|
input_select_left: z.string().optional().default("shift+left").describe("Select left in input"),
|
|
input_select_right: z.string().optional().default("shift+right").describe("Select right in input"),
|
|
input_select_up: z.string().optional().default("shift+up").describe("Select up in input"),
|
|
input_select_down: z.string().optional().default("shift+down").describe("Select down in input"),
|
|
input_line_home: z.string().optional().default("ctrl+a").describe("Move to start of line in input"),
|
|
input_line_end: z.string().optional().default("ctrl+e").describe("Move to end of line in input"),
|
|
input_select_line_home: z.string().optional().default("ctrl+shift+a").describe("Select to start of line in input"),
|
|
input_select_line_end: z.string().optional().default("ctrl+shift+e").describe("Select to end of line in input"),
|
|
input_visual_line_home: z.string().optional().default("alt+a").describe("Move to start of visual line in input"),
|
|
input_visual_line_end: z.string().optional().default("alt+e").describe("Move to end of visual line in input"),
|
|
input_select_visual_line_home: z
|
|
.string()
|
|
.optional()
|
|
.default("alt+shift+a")
|
|
.describe("Select to start of visual line in input"),
|
|
input_select_visual_line_end: z
|
|
.string()
|
|
.optional()
|
|
.default("alt+shift+e")
|
|
.describe("Select to end of visual line in input"),
|
|
input_buffer_home: z.string().optional().default("home").describe("Move to start of buffer in input"),
|
|
input_buffer_end: z.string().optional().default("end").describe("Move to end of buffer in input"),
|
|
input_select_buffer_home: z
|
|
.string()
|
|
.optional()
|
|
.default("shift+home")
|
|
.describe("Select to start of buffer in input"),
|
|
input_select_buffer_end: z.string().optional().default("shift+end").describe("Select to end of buffer in input"),
|
|
input_delete_line: z.string().optional().default("ctrl+shift+d").describe("Delete line in input"),
|
|
input_delete_to_line_end: z.string().optional().default("ctrl+k").describe("Delete to end of line in input"),
|
|
input_delete_to_line_start: z.string().optional().default("ctrl+u").describe("Delete to start of line in input"),
|
|
input_backspace: z.string().optional().default("backspace,shift+backspace").describe("Backspace in input"),
|
|
input_delete: z.string().optional().default("ctrl+d,delete,shift+delete").describe("Delete character in input"),
|
|
input_undo: z.string().optional().default("ctrl+-,super+z").describe("Undo in input"),
|
|
input_redo: z.string().optional().default("ctrl+.,super+shift+z").describe("Redo in input"),
|
|
input_word_forward: z
|
|
.string()
|
|
.optional()
|
|
.default("alt+f,alt+right,ctrl+right")
|
|
.describe("Move word forward in input"),
|
|
input_word_backward: z
|
|
.string()
|
|
.optional()
|
|
.default("alt+b,alt+left,ctrl+left")
|
|
.describe("Move word backward in input"),
|
|
input_select_word_forward: z
|
|
.string()
|
|
.optional()
|
|
.default("alt+shift+f,alt+shift+right")
|
|
.describe("Select word forward in input"),
|
|
input_select_word_backward: z
|
|
.string()
|
|
.optional()
|
|
.default("alt+shift+b,alt+shift+left")
|
|
.describe("Select word backward in input"),
|
|
input_delete_word_forward: z
|
|
.string()
|
|
.optional()
|
|
.default("alt+d,alt+delete,ctrl+delete")
|
|
.describe("Delete word forward in input"),
|
|
input_delete_word_backward: z
|
|
.string()
|
|
.optional()
|
|
.default("ctrl+w,ctrl+backspace,alt+backspace")
|
|
.describe("Delete word backward in input"),
|
|
history_previous: z.string().optional().default("up").describe("Previous history item"),
|
|
history_next: z.string().optional().default("down").describe("Next history item"),
|
|
session_child_first: z.string().optional().default("<leader>down").describe("Go to first child session"),
|
|
session_child_cycle: z.string().optional().default("right").describe("Go to next child session"),
|
|
session_child_cycle_reverse: z.string().optional().default("left").describe("Go to previous child session"),
|
|
session_parent: z.string().optional().default("up").describe("Go to parent session"),
|
|
terminal_suspend: z.string().optional().default("ctrl+z").describe("Suspend terminal"),
|
|
terminal_title_toggle: z.string().optional().default("none").describe("Toggle terminal title"),
|
|
tips_toggle: z.string().optional().default("<leader>h").describe("Toggle tips on home screen"),
|
|
plugin_manager: z.string().optional().default("none").describe("Open plugin manager dialog"),
|
|
display_thinking: z.string().optional().default("none").describe("Toggle thinking blocks visibility"),
|
|
})
|
|
.strict()
|
|
.meta({
|
|
ref: "KeybindsConfig",
|
|
})
|
|
|
|
export const Server = z
|
|
.object({
|
|
port: z.number().int().positive().optional().describe("Port to listen on"),
|
|
hostname: z.string().optional().describe("Hostname to listen on"),
|
|
mdns: z.boolean().optional().describe("Enable mDNS service discovery"),
|
|
mdnsDomain: z.string().optional().describe("Custom domain name for mDNS service (default: opencode.local)"),
|
|
cors: z.array(z.string()).optional().describe("Additional domains to allow for CORS"),
|
|
})
|
|
.strict()
|
|
.meta({
|
|
ref: "ServerConfig",
|
|
})
|
|
|
|
export const Layout = z.enum(["auto", "stretch"]).meta({
|
|
ref: "LayoutConfig",
|
|
})
|
|
export type Layout = z.infer<typeof Layout>
|
|
|
|
export const Model = z
|
|
.object({
|
|
id: z.string(),
|
|
name: z.string(),
|
|
family: z.string().optional(),
|
|
release_date: z.string(),
|
|
attachment: z.boolean(),
|
|
reasoning: z.boolean(),
|
|
temperature: z.boolean(),
|
|
tool_call: z.boolean(),
|
|
interleaved: z
|
|
.union([
|
|
z.literal(true),
|
|
z
|
|
.object({
|
|
field: z.enum(["reasoning_content", "reasoning_details"]),
|
|
})
|
|
.strict(),
|
|
])
|
|
.optional(),
|
|
cost: z
|
|
.object({
|
|
input: z.number(),
|
|
output: z.number(),
|
|
cache_read: z.number().optional(),
|
|
cache_write: z.number().optional(),
|
|
context_over_200k: z
|
|
.object({
|
|
input: z.number(),
|
|
output: z.number(),
|
|
cache_read: z.number().optional(),
|
|
cache_write: z.number().optional(),
|
|
})
|
|
.optional(),
|
|
})
|
|
.optional(),
|
|
limit: z.object({
|
|
context: z.number(),
|
|
input: z.number().optional(),
|
|
output: z.number(),
|
|
}),
|
|
modalities: z
|
|
.object({
|
|
input: z.array(z.enum(["text", "audio", "image", "video", "pdf"])),
|
|
output: z.array(z.enum(["text", "audio", "image", "video", "pdf"])),
|
|
})
|
|
.optional(),
|
|
experimental: z.boolean().optional(),
|
|
status: z.enum(["alpha", "beta", "deprecated"]).optional(),
|
|
provider: z.object({ npm: z.string().optional(), api: z.string().optional() }).optional(),
|
|
options: z.record(z.string(), z.any()),
|
|
headers: z.record(z.string(), z.string()).optional(),
|
|
variants: z
|
|
.record(
|
|
z.string(),
|
|
z
|
|
.object({
|
|
disabled: z.boolean().optional().describe("Disable this variant for the model"),
|
|
})
|
|
.catchall(z.any()),
|
|
)
|
|
.optional()
|
|
.describe("Variant-specific configuration"),
|
|
})
|
|
.partial()
|
|
|
|
export const Provider = z
|
|
.object({
|
|
api: z.string().optional(),
|
|
name: z.string(),
|
|
env: z.array(z.string()),
|
|
id: z.string(),
|
|
npm: z.string().optional(),
|
|
whitelist: z.array(z.string()).optional(),
|
|
blacklist: z.array(z.string()).optional(),
|
|
options: z
|
|
.object({
|
|
apiKey: z.string().optional(),
|
|
baseURL: z.string().optional(),
|
|
enterpriseUrl: z.string().optional().describe("GitHub Enterprise URL for copilot authentication"),
|
|
setCacheKey: z.boolean().optional().describe("Enable promptCacheKey for this provider (default false)"),
|
|
timeout: z
|
|
.union([
|
|
z
|
|
.number()
|
|
.int()
|
|
.positive()
|
|
.describe(
|
|
"Timeout in milliseconds for requests to this provider. Default is 300000 (5 minutes). Set to false to disable timeout.",
|
|
),
|
|
z.literal(false).describe("Disable timeout for this provider entirely."),
|
|
])
|
|
.optional()
|
|
.describe(
|
|
"Timeout in milliseconds for requests to this provider. Default is 300000 (5 minutes). Set to false to disable timeout.",
|
|
),
|
|
chunkTimeout: z
|
|
.number()
|
|
.int()
|
|
.positive()
|
|
.optional()
|
|
.describe(
|
|
"Timeout in milliseconds between streamed SSE chunks for this provider. If no chunk arrives within this window, the request is aborted.",
|
|
),
|
|
})
|
|
.catchall(z.any())
|
|
.optional(),
|
|
models: z.record(z.string(), Model).optional(),
|
|
})
|
|
.partial()
|
|
.strict()
|
|
.meta({
|
|
ref: "ProviderConfig",
|
|
})
|
|
|
|
export type Provider = z.infer<typeof Provider>
|
|
|
|
export const Info = z
|
|
.object({
|
|
$schema: z.string().optional().describe("JSON schema reference for configuration validation"),
|
|
logLevel: Log.Level.optional().describe("Log level"),
|
|
server: Server.optional().describe("Server configuration for opencode serve and web commands"),
|
|
command: z
|
|
.record(z.string(), ConfigCommand.Info)
|
|
.optional()
|
|
.describe("Command configuration, see https://opencode.ai/docs/commands"),
|
|
skills: Skills.optional().describe("Additional skill folder paths"),
|
|
watcher: z
|
|
.object({
|
|
ignore: z.array(z.string()).optional(),
|
|
})
|
|
.optional(),
|
|
snapshot: z
|
|
.boolean()
|
|
.optional()
|
|
.describe(
|
|
"Enable or disable snapshot tracking. When false, filesystem snapshots are not recorded and undoing or reverting will not undo/redo file changes. Defaults to true.",
|
|
),
|
|
plugin: ConfigPlugin.Spec.array().optional(),
|
|
share: z
|
|
.enum(["manual", "auto", "disabled"])
|
|
.optional()
|
|
.describe(
|
|
"Control sharing behavior:'manual' allows manual sharing via commands, 'auto' enables automatic sharing, 'disabled' disables all sharing",
|
|
),
|
|
autoshare: z
|
|
.boolean()
|
|
.optional()
|
|
.describe("@deprecated Use 'share' field instead. Share newly created sessions automatically"),
|
|
autoupdate: z
|
|
.union([z.boolean(), z.literal("notify")])
|
|
.optional()
|
|
.describe(
|
|
"Automatically update to the latest version. Set to true to auto-update, false to disable, or 'notify' to show update notifications",
|
|
),
|
|
disabled_providers: z.array(z.string()).optional().describe("Disable providers that are loaded automatically"),
|
|
enabled_providers: z
|
|
.array(z.string())
|
|
.optional()
|
|
.describe("When set, ONLY these providers will be enabled. All other providers will be ignored"),
|
|
model: ConfigModelID.describe("Model to use in the format of provider/model, eg anthropic/claude-2").optional(),
|
|
small_model: ConfigModelID.describe(
|
|
"Small model to use for tasks like title generation in the format of provider/model",
|
|
).optional(),
|
|
default_agent: z
|
|
.string()
|
|
.optional()
|
|
.describe(
|
|
"Default agent to use when none is specified. Must be a primary agent. Falls back to 'build' if not set or if the specified agent is invalid.",
|
|
),
|
|
username: z.string().optional().describe("Custom username to display in conversations instead of system username"),
|
|
mode: z
|
|
.object({
|
|
build: ConfigAgent.Info.optional(),
|
|
plan: ConfigAgent.Info.optional(),
|
|
})
|
|
.catchall(ConfigAgent.Info)
|
|
.optional()
|
|
.describe("@deprecated Use `agent` field instead."),
|
|
agent: z
|
|
.object({
|
|
// primary
|
|
plan: ConfigAgent.Info.optional(),
|
|
build: ConfigAgent.Info.optional(),
|
|
// subagent
|
|
general: ConfigAgent.Info.optional(),
|
|
explore: ConfigAgent.Info.optional(),
|
|
// specialized
|
|
title: ConfigAgent.Info.optional(),
|
|
summary: ConfigAgent.Info.optional(),
|
|
compaction: ConfigAgent.Info.optional(),
|
|
})
|
|
.catchall(ConfigAgent.Info)
|
|
.optional()
|
|
.describe("Agent configuration, see https://opencode.ai/docs/agents"),
|
|
provider: z.record(z.string(), Provider).optional().describe("Custom provider configurations and model overrides"),
|
|
mcp: z
|
|
.record(
|
|
z.string(),
|
|
z.union([
|
|
ConfigMCP.Info,
|
|
z
|
|
.object({
|
|
enabled: z.boolean(),
|
|
})
|
|
.strict(),
|
|
]),
|
|
)
|
|
.optional()
|
|
.describe("MCP (Model Context Protocol) server configurations"),
|
|
formatter: z
|
|
.union([
|
|
z.literal(false),
|
|
z.record(
|
|
z.string(),
|
|
z.object({
|
|
disabled: z.boolean().optional(),
|
|
command: z.array(z.string()).optional(),
|
|
environment: z.record(z.string(), z.string()).optional(),
|
|
extensions: z.array(z.string()).optional(),
|
|
}),
|
|
),
|
|
])
|
|
.optional(),
|
|
lsp: z
|
|
.union([
|
|
z.literal(false),
|
|
z.record(
|
|
z.string(),
|
|
z.union([
|
|
z.object({
|
|
disabled: z.literal(true),
|
|
}),
|
|
z.object({
|
|
command: z.array(z.string()),
|
|
extensions: z.array(z.string()).optional(),
|
|
disabled: z.boolean().optional(),
|
|
env: z.record(z.string(), z.string()).optional(),
|
|
initialization: z.record(z.string(), z.any()).optional(),
|
|
}),
|
|
]),
|
|
),
|
|
])
|
|
.optional()
|
|
.refine(
|
|
(data) => {
|
|
if (!data) return true
|
|
if (typeof data === "boolean") return true
|
|
const serverIds = new Set(Object.values(LSPServer).map((s) => s.id))
|
|
|
|
return Object.entries(data).every(([id, config]) => {
|
|
if (config.disabled) return true
|
|
if (serverIds.has(id)) return true
|
|
return Boolean(config.extensions)
|
|
})
|
|
},
|
|
{
|
|
error: "For custom LSP servers, 'extensions' array is required.",
|
|
},
|
|
),
|
|
instructions: z.array(z.string()).optional().describe("Additional instruction files or patterns to include"),
|
|
layout: Layout.optional().describe("@deprecated Always uses stretch layout."),
|
|
permission: ConfigPermission.Info.optional(),
|
|
tools: z.record(z.string(), z.boolean()).optional(),
|
|
enterprise: z
|
|
.object({
|
|
url: z.string().optional().describe("Enterprise URL"),
|
|
})
|
|
.optional(),
|
|
compaction: z
|
|
.object({
|
|
auto: z.boolean().optional().describe("Enable automatic compaction when context is full (default: true)"),
|
|
prune: z.boolean().optional().describe("Enable pruning of old tool outputs (default: true)"),
|
|
reserved: z
|
|
.number()
|
|
.int()
|
|
.min(0)
|
|
.optional()
|
|
.describe("Token buffer for compaction. Leaves enough window to avoid overflow during compaction."),
|
|
})
|
|
.optional(),
|
|
experimental: z
|
|
.object({
|
|
disable_paste_summary: z.boolean().optional(),
|
|
batch_tool: z.boolean().optional().describe("Enable the batch tool"),
|
|
openTelemetry: z
|
|
.boolean()
|
|
.optional()
|
|
.describe("Enable OpenTelemetry spans for AI SDK calls (using the 'experimental_telemetry' flag)"),
|
|
primary_tools: z
|
|
.array(z.string())
|
|
.optional()
|
|
.describe("Tools that should only be available to primary agents."),
|
|
continue_loop_on_deny: z.boolean().optional().describe("Continue the agent loop when a tool call is denied"),
|
|
mcp_timeout: z
|
|
.number()
|
|
.int()
|
|
.positive()
|
|
.optional()
|
|
.describe("Timeout in milliseconds for model context protocol (MCP) requests"),
|
|
})
|
|
.optional(),
|
|
})
|
|
.strict()
|
|
.meta({
|
|
ref: "Config",
|
|
})
|
|
|
|
export type Info = z.output<typeof Info> & {
|
|
plugin_origins?: ConfigPlugin.Origin[]
|
|
}
|
|
|
|
type State = {
|
|
config: Info
|
|
directories: string[]
|
|
deps: Fiber.Fiber<void, never>[]
|
|
consoleState: ConsoleState
|
|
}
|
|
|
|
export interface Interface {
|
|
readonly get: () => Effect.Effect<Info>
|
|
readonly getGlobal: () => Effect.Effect<Info>
|
|
readonly getConsoleState: () => Effect.Effect<ConsoleState>
|
|
readonly update: (config: Info) => Effect.Effect<void>
|
|
readonly updateGlobal: (config: Info) => Effect.Effect<Info>
|
|
readonly invalidate: (wait?: boolean) => Effect.Effect<void>
|
|
readonly directories: () => Effect.Effect<string[]>
|
|
readonly waitForDependencies: () => Effect.Effect<void>
|
|
}
|
|
|
|
export class Service extends Context.Service<Service, Interface>()("@opencode/Config") {}
|
|
|
|
function globalConfigFile() {
|
|
const candidates = ["opencode.jsonc", "opencode.json", "config.json"].map((file) =>
|
|
path.join(Global.Path.config, file),
|
|
)
|
|
for (const file of candidates) {
|
|
if (existsSync(file)) return file
|
|
}
|
|
return candidates[0]
|
|
}
|
|
|
|
function patchJsonc(input: string, patch: unknown, path: string[] = []): string {
|
|
if (!isRecord(patch)) {
|
|
const edits = modify(input, path, patch, {
|
|
formattingOptions: {
|
|
insertSpaces: true,
|
|
tabSize: 2,
|
|
},
|
|
})
|
|
return applyEdits(input, edits)
|
|
}
|
|
|
|
return Object.entries(patch).reduce((result, [key, value]) => {
|
|
if (value === undefined) return result
|
|
return patchJsonc(result, value, [...path, key])
|
|
}, input)
|
|
}
|
|
|
|
function writable(info: Info) {
|
|
const { plugin_origins: _plugin_origins, ...next } = info
|
|
return next
|
|
}
|
|
|
|
export function parseConfig(text: string, filepath: string): Info {
|
|
const errors: JsoncParseError[] = []
|
|
const data = parseJsonc(text, errors, { allowTrailingComma: true })
|
|
if (errors.length) {
|
|
const lines = text.split("\n")
|
|
const errorDetails = errors
|
|
.map((e) => {
|
|
const beforeOffset = text.substring(0, e.offset).split("\n")
|
|
const line = beforeOffset.length
|
|
const column = beforeOffset[beforeOffset.length - 1].length + 1
|
|
const problemLine = lines[line - 1]
|
|
|
|
const error = `${printParseErrorCode(e.error)} at line ${line}, column ${column}`
|
|
if (!problemLine) return error
|
|
|
|
return `${error}\n Line ${line}: ${problemLine}\n${"".padStart(column + 9)}^`
|
|
})
|
|
.join("\n")
|
|
|
|
throw new JsonError({
|
|
path: filepath,
|
|
message: `\n--- JSONC Input ---\n${text}\n--- Errors ---\n${errorDetails}\n--- End ---`,
|
|
})
|
|
}
|
|
|
|
const parsed = Info.safeParse(data)
|
|
if (parsed.success) return parsed.data
|
|
|
|
throw new InvalidError({
|
|
path: filepath,
|
|
issues: parsed.error.issues,
|
|
})
|
|
}
|
|
|
|
export const { JsonError, InvalidError } = ConfigPaths
|
|
|
|
export const ConfigDirectoryTypoError = NamedError.create(
|
|
"ConfigDirectoryTypoError",
|
|
z.object({
|
|
path: z.string(),
|
|
dir: z.string(),
|
|
suggestion: z.string(),
|
|
}),
|
|
)
|
|
|
|
export const layer = Layer.effect(
|
|
Service,
|
|
Effect.gen(function* () {
|
|
const fs = yield* AppFileSystem.Service
|
|
const authSvc = yield* Auth.Service
|
|
const accountSvc = yield* Account.Service
|
|
const env = yield* Env.Service
|
|
const npmSvc = yield* Npm.Service
|
|
|
|
const readConfigFile = Effect.fnUntraced(function* (filepath: string) {
|
|
return yield* fs.readFileString(filepath).pipe(
|
|
Effect.catchIf(
|
|
(e) => e.reason._tag === "NotFound",
|
|
() => Effect.succeed(undefined),
|
|
),
|
|
Effect.orDie,
|
|
)
|
|
})
|
|
|
|
const loadConfig = Effect.fnUntraced(function* (
|
|
text: string,
|
|
options: { path: string } | { dir: string; source: string },
|
|
) {
|
|
const original = text
|
|
const source = "path" in options ? options.path : options.source
|
|
const isFile = "path" in options
|
|
const data = yield* Effect.promise(() =>
|
|
ConfigPaths.parseText(text, "path" in options ? options.path : { source: options.source, dir: options.dir }),
|
|
)
|
|
|
|
const normalized = (() => {
|
|
if (!data || typeof data !== "object" || Array.isArray(data)) return data
|
|
const copy = { ...(data as Record<string, unknown>) }
|
|
const hadLegacy = "theme" in copy || "keybinds" in copy || "tui" in copy
|
|
if (!hadLegacy) return copy
|
|
delete copy.theme
|
|
delete copy.keybinds
|
|
delete copy.tui
|
|
log.warn("tui keys in opencode config are deprecated; move them to tui.json", { path: source })
|
|
return copy
|
|
})()
|
|
|
|
const parsed = Info.safeParse(normalized)
|
|
if (parsed.success) {
|
|
if (!parsed.data.$schema && isFile) {
|
|
parsed.data.$schema = "https://opencode.ai/config.json"
|
|
const updated = original.replace(/^\s*\{/, '{\n "$schema": "https://opencode.ai/config.json",')
|
|
yield* fs.writeFileString(options.path, updated).pipe(Effect.catch(() => Effect.void))
|
|
}
|
|
const data = parsed.data
|
|
if (data.plugin && isFile) {
|
|
const list = data.plugin
|
|
for (let i = 0; i < list.length; i++) {
|
|
list[i] = yield* Effect.promise(() => ConfigPlugin.resolvePluginSpec(list[i], options.path))
|
|
}
|
|
}
|
|
return data
|
|
}
|
|
|
|
throw new InvalidError({
|
|
path: source,
|
|
issues: parsed.error.issues,
|
|
})
|
|
})
|
|
|
|
const loadFile = Effect.fnUntraced(function* (filepath: string) {
|
|
log.info("loading", { path: filepath })
|
|
const text = yield* readConfigFile(filepath)
|
|
if (!text) return {} as Info
|
|
return yield* loadConfig(text, { path: filepath })
|
|
})
|
|
|
|
const loadGlobal = Effect.fnUntraced(function* () {
|
|
let result: Info = pipe(
|
|
{},
|
|
mergeDeep(yield* loadFile(path.join(Global.Path.config, "config.json"))),
|
|
mergeDeep(yield* loadFile(path.join(Global.Path.config, "opencode.json"))),
|
|
mergeDeep(yield* loadFile(path.join(Global.Path.config, "opencode.jsonc"))),
|
|
)
|
|
|
|
const legacy = path.join(Global.Path.config, "config")
|
|
if (existsSync(legacy)) {
|
|
yield* Effect.promise(() =>
|
|
import(pathToFileURL(legacy).href, { with: { type: "toml" } })
|
|
.then(async (mod) => {
|
|
const { provider, model, ...rest } = mod.default
|
|
if (provider && model) result.model = `${provider}/${model}`
|
|
result["$schema"] = "https://opencode.ai/config.json"
|
|
result = mergeDeep(result, rest)
|
|
await fsNode.writeFile(path.join(Global.Path.config, "config.json"), JSON.stringify(result, null, 2))
|
|
await fsNode.unlink(legacy)
|
|
})
|
|
.catch(() => {}),
|
|
)
|
|
}
|
|
|
|
return result
|
|
})
|
|
|
|
const [cachedGlobal, invalidateGlobal] = yield* Effect.cachedInvalidateWithTTL(
|
|
loadGlobal().pipe(
|
|
Effect.tapError((error) =>
|
|
Effect.sync(() => log.error("failed to load global config, using defaults", { error: String(error) })),
|
|
),
|
|
Effect.orElseSucceed((): Info => ({})),
|
|
),
|
|
Duration.infinity,
|
|
)
|
|
|
|
const getGlobal = Effect.fn("Config.getGlobal")(function* () {
|
|
return yield* cachedGlobal
|
|
})
|
|
|
|
const ensureGitignore = Effect.fn("Config.ensureGitignore")(function* (dir: string) {
|
|
const gitignore = path.join(dir, ".gitignore")
|
|
const hasIgnore = yield* fs.existsSafe(gitignore)
|
|
if (!hasIgnore) {
|
|
yield* fs
|
|
.writeFileString(
|
|
gitignore,
|
|
["node_modules", "package.json", "package-lock.json", "bun.lock", ".gitignore"].join("\n"),
|
|
)
|
|
.pipe(
|
|
Effect.catchIf(
|
|
(e) => e.reason._tag === "PermissionDenied",
|
|
() => Effect.void,
|
|
),
|
|
)
|
|
}
|
|
})
|
|
|
|
const loadInstanceState = Effect.fn("Config.loadInstanceState")(function* (ctx: InstanceContext) {
|
|
const auth = yield* authSvc.all().pipe(Effect.orDie)
|
|
|
|
let result: Info = {}
|
|
const consoleManagedProviders = new Set<string>()
|
|
let activeOrgName: string | undefined
|
|
|
|
const scope = Effect.fnUntraced(function* (source: string) {
|
|
if (source.startsWith("http://") || source.startsWith("https://")) return "global"
|
|
if (source === "OPENCODE_CONFIG_CONTENT") return "local"
|
|
if (yield* InstanceRef.use((ctx) => Effect.succeed(Instance.containsPath(source, ctx)))) return "local"
|
|
return "global"
|
|
})
|
|
|
|
const track = Effect.fnUntraced(function* (
|
|
source: string,
|
|
list: ConfigPlugin.Spec[] | undefined,
|
|
kind?: ConfigPlugin.Scope,
|
|
) {
|
|
if (!list?.length) return
|
|
const hit = kind ?? (yield* scope(source))
|
|
const plugins = ConfigPlugin.deduplicatePluginOrigins([
|
|
...(result.plugin_origins ?? []),
|
|
...list.map((spec) => ({ spec, source, scope: hit })),
|
|
])
|
|
result.plugin = plugins.map((item) => item.spec)
|
|
result.plugin_origins = plugins
|
|
})
|
|
|
|
const merge = (source: string, next: Info, kind?: ConfigPlugin.Scope) => {
|
|
result = mergeConfigConcatArrays(result, next)
|
|
return track(source, next.plugin, kind)
|
|
}
|
|
|
|
for (const [key, value] of Object.entries(auth)) {
|
|
if (value.type === "wellknown") {
|
|
const url = key.replace(/\/+$/, "")
|
|
process.env[value.key] = value.token
|
|
log.debug("fetching remote config", { url: `${url}/.well-known/opencode` })
|
|
const response = yield* Effect.promise(() => fetch(`${url}/.well-known/opencode`))
|
|
if (!response.ok) {
|
|
throw new Error(`failed to fetch remote config from ${url}: ${response.status}`)
|
|
}
|
|
const wellknown = (yield* Effect.promise(() => response.json())) as any
|
|
const remoteConfig = wellknown.config ?? {}
|
|
if (!remoteConfig.$schema) remoteConfig.$schema = "https://opencode.ai/config.json"
|
|
const source = `${url}/.well-known/opencode`
|
|
const next = yield* loadConfig(JSON.stringify(remoteConfig), {
|
|
dir: path.dirname(source),
|
|
source,
|
|
})
|
|
yield* merge(source, next, "global")
|
|
log.debug("loaded remote config from well-known", { url })
|
|
}
|
|
}
|
|
|
|
const global = yield* getGlobal()
|
|
yield* merge(Global.Path.config, global, "global")
|
|
|
|
if (Flag.OPENCODE_CONFIG) {
|
|
yield* merge(Flag.OPENCODE_CONFIG, yield* loadFile(Flag.OPENCODE_CONFIG))
|
|
log.debug("loaded custom config", { path: Flag.OPENCODE_CONFIG })
|
|
}
|
|
|
|
if (!Flag.OPENCODE_DISABLE_PROJECT_CONFIG) {
|
|
for (const file of yield* Effect.promise(() =>
|
|
ConfigPaths.projectFiles("opencode", ctx.directory, ctx.worktree),
|
|
)) {
|
|
yield* merge(file, yield* loadFile(file), "local")
|
|
}
|
|
}
|
|
|
|
result.agent = result.agent || {}
|
|
result.mode = result.mode || {}
|
|
result.plugin = result.plugin || []
|
|
|
|
const directories = yield* Effect.promise(() => ConfigPaths.directories(ctx.directory, ctx.worktree))
|
|
|
|
if (Flag.OPENCODE_CONFIG_DIR) {
|
|
log.debug("loading config from OPENCODE_CONFIG_DIR", { path: Flag.OPENCODE_CONFIG_DIR })
|
|
}
|
|
|
|
const deps: Fiber.Fiber<void, never>[] = []
|
|
|
|
for (const dir of directories) {
|
|
if (dir.endsWith(".opencode") || dir === Flag.OPENCODE_CONFIG_DIR) {
|
|
for (const file of ["opencode.json", "opencode.jsonc"]) {
|
|
const source = path.join(dir, file)
|
|
log.debug(`loading config from ${source}`)
|
|
yield* merge(source, yield* loadFile(source))
|
|
result.agent ??= {}
|
|
result.mode ??= {}
|
|
result.plugin ??= []
|
|
}
|
|
}
|
|
|
|
yield* ensureGitignore(dir).pipe(Effect.orDie)
|
|
|
|
const dep = yield* npmSvc
|
|
.install(dir, {
|
|
add: ["@opencode-ai/plugin" + (InstallationLocal ? "" : "@" + InstallationVersion)],
|
|
})
|
|
.pipe(
|
|
Effect.exit,
|
|
Effect.tap((exit) =>
|
|
Exit.isFailure(exit)
|
|
? Effect.sync(() => {
|
|
log.warn("background dependency install failed", { dir, error: String(exit.cause) })
|
|
})
|
|
: Effect.void,
|
|
),
|
|
Effect.asVoid,
|
|
Effect.forkDetach,
|
|
)
|
|
deps.push(dep)
|
|
|
|
result.command = mergeDeep(result.command ?? {}, yield* Effect.promise(() => ConfigCommand.load(dir)))
|
|
result.agent = mergeDeep(result.agent ?? {}, yield* Effect.promise(() => ConfigAgent.load(dir)))
|
|
result.agent = mergeDeep(result.agent ?? {}, yield* Effect.promise(() => ConfigAgent.loadMode(dir)))
|
|
const list = yield* Effect.promise(() => ConfigPlugin.load(dir))
|
|
yield* track(dir, list)
|
|
}
|
|
|
|
if (process.env.OPENCODE_CONFIG_CONTENT) {
|
|
const source = "OPENCODE_CONFIG_CONTENT"
|
|
const next = yield* loadConfig(process.env.OPENCODE_CONFIG_CONTENT, {
|
|
dir: ctx.directory,
|
|
source,
|
|
})
|
|
yield* merge(source, next, "local")
|
|
log.debug("loaded custom config from OPENCODE_CONFIG_CONTENT")
|
|
}
|
|
|
|
const activeAccount = Option.getOrUndefined(
|
|
yield* accountSvc.active().pipe(Effect.catch(() => Effect.succeed(Option.none()))),
|
|
)
|
|
if (activeAccount?.active_org_id) {
|
|
const accountID = activeAccount.id
|
|
const orgID = activeAccount.active_org_id
|
|
const url = activeAccount.url
|
|
yield* Effect.gen(function* () {
|
|
const [configOpt, tokenOpt] = yield* Effect.all(
|
|
[accountSvc.config(accountID, orgID), accountSvc.token(accountID)],
|
|
{ concurrency: 2 },
|
|
)
|
|
if (Option.isSome(tokenOpt)) {
|
|
process.env["OPENCODE_CONSOLE_TOKEN"] = tokenOpt.value
|
|
yield* env.set("OPENCODE_CONSOLE_TOKEN", tokenOpt.value)
|
|
}
|
|
|
|
if (Option.isSome(configOpt)) {
|
|
const source = `${url}/api/config`
|
|
const next = yield* loadConfig(JSON.stringify(configOpt.value), {
|
|
dir: path.dirname(source),
|
|
source,
|
|
})
|
|
for (const providerID of Object.keys(next.provider ?? {})) {
|
|
consoleManagedProviders.add(providerID)
|
|
}
|
|
yield* merge(source, next, "global")
|
|
}
|
|
}).pipe(
|
|
Effect.withSpan("Config.loadActiveOrgConfig"),
|
|
Effect.catch((err) => {
|
|
log.debug("failed to fetch remote account config", {
|
|
error: err instanceof Error ? err.message : String(err),
|
|
})
|
|
return Effect.void
|
|
}),
|
|
)
|
|
}
|
|
|
|
const managedDir = ConfigManaged.managedConfigDir()
|
|
if (existsSync(managedDir)) {
|
|
for (const file of ["opencode.json", "opencode.jsonc"]) {
|
|
const source = path.join(managedDir, file)
|
|
yield* merge(source, yield* loadFile(source), "global")
|
|
}
|
|
}
|
|
|
|
// macOS managed preferences (.mobileconfig deployed via MDM) override everything
|
|
result = mergeConfigConcatArrays(result, yield* Effect.promise(() => ConfigManaged.readManagedPreferences()))
|
|
|
|
for (const [name, mode] of Object.entries(result.mode ?? {})) {
|
|
result.agent = mergeDeep(result.agent ?? {}, {
|
|
[name]: {
|
|
...mode,
|
|
mode: "primary" as const,
|
|
},
|
|
})
|
|
}
|
|
|
|
if (Flag.OPENCODE_PERMISSION) {
|
|
result.permission = mergeDeep(result.permission ?? {}, JSON.parse(Flag.OPENCODE_PERMISSION))
|
|
}
|
|
|
|
if (result.tools) {
|
|
const perms: Record<string, ConfigPermission.Action> = {}
|
|
for (const [tool, enabled] of Object.entries(result.tools)) {
|
|
const action: ConfigPermission.Action = enabled ? "allow" : "deny"
|
|
if (tool === "write" || tool === "edit" || tool === "patch" || tool === "multiedit") {
|
|
perms.edit = action
|
|
continue
|
|
}
|
|
perms[tool] = action
|
|
}
|
|
result.permission = mergeDeep(perms, result.permission ?? {})
|
|
}
|
|
|
|
if (!result.username) result.username = os.userInfo().username
|
|
|
|
if (result.autoshare === true && !result.share) {
|
|
result.share = "auto"
|
|
}
|
|
|
|
if (Flag.OPENCODE_DISABLE_AUTOCOMPACT) {
|
|
result.compaction = { ...result.compaction, auto: false }
|
|
}
|
|
if (Flag.OPENCODE_DISABLE_PRUNE) {
|
|
result.compaction = { ...result.compaction, prune: false }
|
|
}
|
|
|
|
return {
|
|
config: result,
|
|
directories,
|
|
deps,
|
|
consoleState: {
|
|
consoleManagedProviders: Array.from(consoleManagedProviders),
|
|
activeOrgName,
|
|
switchableOrgCount: 0,
|
|
},
|
|
}
|
|
})
|
|
|
|
const state = yield* InstanceState.make<State>(
|
|
Effect.fn("Config.state")(function* (ctx) {
|
|
return yield* loadInstanceState(ctx)
|
|
}),
|
|
)
|
|
|
|
const get = Effect.fn("Config.get")(function* () {
|
|
return yield* InstanceState.use(state, (s) => s.config)
|
|
})
|
|
|
|
const directories = Effect.fn("Config.directories")(function* () {
|
|
return yield* InstanceState.use(state, (s) => s.directories)
|
|
})
|
|
|
|
const getConsoleState = Effect.fn("Config.getConsoleState")(function* () {
|
|
return yield* InstanceState.use(state, (s) => s.consoleState)
|
|
})
|
|
|
|
const waitForDependencies = Effect.fn("Config.waitForDependencies")(function* () {
|
|
yield* InstanceState.useEffect(state, (s) =>
|
|
Effect.forEach(s.deps, Fiber.join, { concurrency: "unbounded" }).pipe(Effect.asVoid),
|
|
)
|
|
})
|
|
|
|
const update = Effect.fn("Config.update")(function* (config: Info) {
|
|
const dir = yield* InstanceState.directory
|
|
const file = path.join(dir, "config.json")
|
|
const existing = yield* loadFile(file)
|
|
yield* fs
|
|
.writeFileString(file, JSON.stringify(mergeDeep(writable(existing), writable(config)), null, 2))
|
|
.pipe(Effect.orDie)
|
|
yield* Effect.promise(() => Instance.dispose())
|
|
})
|
|
|
|
const invalidate = Effect.fn("Config.invalidate")(function* (wait?: boolean) {
|
|
yield* invalidateGlobal
|
|
const task = Instance.disposeAll()
|
|
.catch(() => undefined)
|
|
.finally(() =>
|
|
GlobalBus.emit("event", {
|
|
directory: "global",
|
|
payload: {
|
|
type: Event.Disposed.type,
|
|
properties: {},
|
|
},
|
|
}),
|
|
)
|
|
if (wait) yield* Effect.promise(() => task)
|
|
else void task
|
|
})
|
|
|
|
const updateGlobal = Effect.fn("Config.updateGlobal")(function* (config: Info) {
|
|
const file = globalConfigFile()
|
|
const before = (yield* readConfigFile(file)) ?? "{}"
|
|
const input = writable(config)
|
|
|
|
let next: Info
|
|
if (!file.endsWith(".jsonc")) {
|
|
const existing = parseConfig(before, file)
|
|
const merged = mergeDeep(writable(existing), input)
|
|
yield* fs.writeFileString(file, JSON.stringify(merged, null, 2)).pipe(Effect.orDie)
|
|
next = merged
|
|
} else {
|
|
const updated = patchJsonc(before, input)
|
|
next = parseConfig(updated, file)
|
|
yield* fs.writeFileString(file, updated).pipe(Effect.orDie)
|
|
}
|
|
|
|
yield* invalidate()
|
|
return next
|
|
})
|
|
|
|
return Service.of({
|
|
get,
|
|
getGlobal,
|
|
getConsoleState,
|
|
update,
|
|
updateGlobal,
|
|
invalidate,
|
|
directories,
|
|
waitForDependencies,
|
|
})
|
|
}),
|
|
)
|
|
|
|
export const defaultLayer = layer.pipe(
|
|
Layer.provide(EffectFlock.defaultLayer),
|
|
Layer.provide(AppFileSystem.defaultLayer),
|
|
Layer.provide(Env.defaultLayer),
|
|
Layer.provide(Auth.defaultLayer),
|
|
Layer.provide(Account.defaultLayer),
|
|
Layer.provide(Npm.defaultLayer),
|
|
)
|