mirror of
https://gitea.toothfairyai.com/ToothFairyAI/tf_code.git
synced 2026-04-01 06:42:26 +00:00
1465 lines
55 KiB
TypeScript
1465 lines
55 KiB
TypeScript
import { Log } from "../util/log"
|
|
import path from "path"
|
|
import { pathToFileURL, fileURLToPath } from "url"
|
|
import { createRequire } from "module"
|
|
import os from "os"
|
|
import z from "zod"
|
|
import { ModelsDev } from "../provider/models"
|
|
import { mergeDeep, pipe, unique } from "remeda"
|
|
import { Global } from "../global"
|
|
import fs from "fs/promises"
|
|
import { lazy } from "../util/lazy"
|
|
import { NamedError } from "@opencode-ai/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 } from "../project/instance"
|
|
import { LSPServer } from "../lsp/server"
|
|
import { BunProc } from "@/bun"
|
|
import { Installation } from "@/installation"
|
|
import { ConfigMarkdown } from "./markdown"
|
|
import { constants, existsSync } from "fs"
|
|
import { Bus } from "@/bus"
|
|
import { GlobalBus } from "@/bus/global"
|
|
import { Event } from "../server/event"
|
|
import { Glob } from "../util/glob"
|
|
import { PackageRegistry } from "@/bun/registry"
|
|
import { proxied } from "@/util/proxied"
|
|
import { iife } from "@/util/iife"
|
|
import { Account } from "@/account"
|
|
import { ConfigPaths } from "./paths"
|
|
import { Filesystem } from "@/util/filesystem"
|
|
import { Process } from "@/util/process"
|
|
import { Lock } from "@/util/lock"
|
|
|
|
export namespace Config {
|
|
const ModelId = z.string().meta({ $ref: "https://models.dev/model-schema.json#/$defs/Model" })
|
|
|
|
const log = Log.create({ service: "config" })
|
|
|
|
// Managed settings directory for enterprise deployments (highest priority, admin-controlled)
|
|
// These settings override all user and project settings
|
|
function systemManagedConfigDir(): string {
|
|
switch (process.platform) {
|
|
case "darwin":
|
|
return "/Library/Application Support/opencode"
|
|
case "win32":
|
|
return path.join(process.env.ProgramData || "C:\\ProgramData", "opencode")
|
|
default:
|
|
return "/etc/opencode"
|
|
}
|
|
}
|
|
|
|
export function managedConfigDir() {
|
|
return process.env.OPENCODE_TEST_MANAGED_CONFIG_DIR || systemManagedConfigDir()
|
|
}
|
|
|
|
const managedDir = managedConfigDir()
|
|
|
|
// 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.plugin && source.plugin) {
|
|
merged.plugin = Array.from(new Set([...target.plugin, ...source.plugin]))
|
|
}
|
|
if (target.instructions && source.instructions) {
|
|
merged.instructions = Array.from(new Set([...target.instructions, ...source.instructions]))
|
|
}
|
|
return merged
|
|
}
|
|
|
|
export const state = Instance.state(async () => {
|
|
const auth = await Auth.all()
|
|
|
|
// Config loading order (low -> high precedence): https://opencode.ai/docs/config#precedence-order
|
|
// 1) Remote .well-known/opencode (org defaults)
|
|
// 2) Global config (~/.config/opencode/opencode.json{,c})
|
|
// 3) Custom config (OPENCODE_CONFIG)
|
|
// 4) Project config (opencode.json{,c})
|
|
// 5) .opencode directories (.opencode/agents/, .opencode/commands/, .opencode/plugins/, .opencode/opencode.json{,c})
|
|
// 6) Inline config (OPENCODE_CONFIG_CONTENT)
|
|
// Managed config directory is enterprise-only and always overrides everything above.
|
|
let result: Info = {}
|
|
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 = await fetch(`${url}/.well-known/opencode`)
|
|
if (!response.ok) {
|
|
throw new Error(`failed to fetch remote config from ${url}: ${response.status}`)
|
|
}
|
|
const wellknown = (await response.json()) as any
|
|
const remoteConfig = wellknown.config ?? {}
|
|
// Add $schema to prevent load() from trying to write back to a non-existent file
|
|
if (!remoteConfig.$schema) remoteConfig.$schema = "https://opencode.ai/config.json"
|
|
result = mergeConfigConcatArrays(
|
|
result,
|
|
await load(JSON.stringify(remoteConfig), {
|
|
dir: path.dirname(`${url}/.well-known/opencode`),
|
|
source: `${url}/.well-known/opencode`,
|
|
}),
|
|
)
|
|
log.debug("loaded remote config from well-known", { url })
|
|
}
|
|
}
|
|
|
|
// Global user config overrides remote config.
|
|
result = mergeConfigConcatArrays(result, await global())
|
|
|
|
// Custom config path overrides global config.
|
|
if (Flag.OPENCODE_CONFIG) {
|
|
result = mergeConfigConcatArrays(result, await loadFile(Flag.OPENCODE_CONFIG))
|
|
log.debug("loaded custom config", { path: Flag.OPENCODE_CONFIG })
|
|
}
|
|
|
|
// Project config overrides global and remote config.
|
|
if (!Flag.OPENCODE_DISABLE_PROJECT_CONFIG) {
|
|
for (const file of await ConfigPaths.projectFiles("opencode", Instance.directory, Instance.worktree)) {
|
|
result = mergeConfigConcatArrays(result, await loadFile(file))
|
|
}
|
|
}
|
|
|
|
result.agent = result.agent || {}
|
|
result.mode = result.mode || {}
|
|
result.plugin = result.plugin || []
|
|
|
|
const directories = await ConfigPaths.directories(Instance.directory, Instance.worktree)
|
|
|
|
// .opencode directory config overrides (project and global) config sources.
|
|
if (Flag.OPENCODE_CONFIG_DIR) {
|
|
log.debug("loading config from OPENCODE_CONFIG_DIR", { path: Flag.OPENCODE_CONFIG_DIR })
|
|
}
|
|
|
|
const deps = []
|
|
|
|
for (const dir of unique(directories)) {
|
|
if (dir.endsWith(".opencode") || dir === Flag.OPENCODE_CONFIG_DIR) {
|
|
for (const file of ["opencode.jsonc", "opencode.json"]) {
|
|
log.debug(`loading config from ${path.join(dir, file)}`)
|
|
result = mergeConfigConcatArrays(result, await loadFile(path.join(dir, file)))
|
|
// to satisfy the type checker
|
|
result.agent ??= {}
|
|
result.mode ??= {}
|
|
result.plugin ??= []
|
|
}
|
|
}
|
|
|
|
deps.push(
|
|
iife(async () => {
|
|
const shouldInstall = await needsInstall(dir)
|
|
if (shouldInstall) await installDependencies(dir)
|
|
}),
|
|
)
|
|
|
|
result.command = mergeDeep(result.command ?? {}, await loadCommand(dir))
|
|
result.agent = mergeDeep(result.agent, await loadAgent(dir))
|
|
result.agent = mergeDeep(result.agent, await loadMode(dir))
|
|
result.plugin.push(...(await loadPlugin(dir)))
|
|
}
|
|
|
|
// Inline config content overrides all non-managed config sources.
|
|
if (process.env.OPENCODE_CONFIG_CONTENT) {
|
|
result = mergeConfigConcatArrays(
|
|
result,
|
|
await load(process.env.OPENCODE_CONFIG_CONTENT, {
|
|
dir: Instance.directory,
|
|
source: "OPENCODE_CONFIG_CONTENT",
|
|
}),
|
|
)
|
|
log.debug("loaded custom config from OPENCODE_CONFIG_CONTENT")
|
|
}
|
|
|
|
const active = await Account.active()
|
|
if (active?.active_org_id) {
|
|
try {
|
|
const [config, token] = await Promise.all([
|
|
Account.config(active.id, active.active_org_id),
|
|
Account.token(active.id),
|
|
])
|
|
if (token) {
|
|
process.env["OPENCODE_CONSOLE_TOKEN"] = token
|
|
Env.set("OPENCODE_CONSOLE_TOKEN", token)
|
|
}
|
|
|
|
if (config) {
|
|
result = mergeConfigConcatArrays(
|
|
result,
|
|
await load(JSON.stringify(config), {
|
|
dir: path.dirname(`${active.url}/api/config`),
|
|
source: `${active.url}/api/config`,
|
|
}),
|
|
)
|
|
}
|
|
} catch (err: any) {
|
|
log.debug("failed to fetch remote account config", { error: err?.message ?? err })
|
|
}
|
|
}
|
|
|
|
// Load managed config files last (highest priority) - enterprise admin-controlled
|
|
// Kept separate from directories array to avoid write operations when installing plugins
|
|
// which would fail on system directories requiring elevated permissions
|
|
// This way it only loads config file and not skills/plugins/commands
|
|
if (existsSync(managedDir)) {
|
|
for (const file of ["opencode.jsonc", "opencode.json"]) {
|
|
result = mergeConfigConcatArrays(result, await loadFile(path.join(managedDir, file)))
|
|
}
|
|
}
|
|
|
|
// Migrate deprecated mode field to agent field
|
|
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))
|
|
}
|
|
|
|
// Backwards compatibility: legacy top-level `tools` config
|
|
if (result.tools) {
|
|
const perms: Record<string, Config.PermissionAction> = {}
|
|
for (const [tool, enabled] of Object.entries(result.tools)) {
|
|
const action: Config.PermissionAction = 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
|
|
|
|
// Handle migration from autoshare to share field
|
|
if (result.autoshare === true && !result.share) {
|
|
result.share = "auto"
|
|
}
|
|
|
|
// Apply flag overrides for compaction settings
|
|
if (Flag.OPENCODE_DISABLE_AUTOCOMPACT) {
|
|
result.compaction = { ...result.compaction, auto: false }
|
|
}
|
|
if (Flag.OPENCODE_DISABLE_PRUNE) {
|
|
result.compaction = { ...result.compaction, prune: false }
|
|
}
|
|
|
|
result.plugin = deduplicatePlugins(result.plugin ?? [])
|
|
|
|
return {
|
|
config: result,
|
|
directories,
|
|
deps,
|
|
}
|
|
})
|
|
|
|
export async function waitForDependencies() {
|
|
const deps = await state().then((x) => x.deps)
|
|
await Promise.all(deps)
|
|
}
|
|
|
|
export async function installDependencies(dir: string) {
|
|
const pkg = path.join(dir, "package.json")
|
|
const targetVersion = Installation.isLocal() ? "*" : Installation.VERSION
|
|
|
|
const json = await Filesystem.readJson<{ dependencies?: Record<string, string> }>(pkg).catch(() => ({
|
|
dependencies: {},
|
|
}))
|
|
json.dependencies = {
|
|
...json.dependencies,
|
|
"@opencode-ai/plugin": targetVersion,
|
|
}
|
|
await Filesystem.writeJson(pkg, json)
|
|
|
|
const gitignore = path.join(dir, ".gitignore")
|
|
const hasGitIgnore = await Filesystem.exists(gitignore)
|
|
if (!hasGitIgnore)
|
|
await Filesystem.write(gitignore, ["node_modules", "package.json", "bun.lock", ".gitignore"].join("\n"))
|
|
|
|
// Install any additional dependencies defined in the package.json
|
|
// This allows local plugins and custom tools to use external packages
|
|
using _ = await Lock.write("bun-install")
|
|
await BunProc.run(
|
|
[
|
|
"install",
|
|
// TODO: get rid of this case (see: https://github.com/oven-sh/bun/issues/19936)
|
|
...(proxied() || process.env.CI ? ["--no-cache"] : []),
|
|
],
|
|
{ cwd: dir },
|
|
).catch((err) => {
|
|
if (err instanceof Process.RunFailedError) {
|
|
const detail = {
|
|
dir,
|
|
cmd: err.cmd,
|
|
code: err.code,
|
|
stdout: err.stdout.toString(),
|
|
stderr: err.stderr.toString(),
|
|
}
|
|
if (Flag.OPENCODE_STRICT_CONFIG_DEPS) {
|
|
log.error("failed to install dependencies", detail)
|
|
throw err
|
|
}
|
|
log.warn("failed to install dependencies", detail)
|
|
return
|
|
}
|
|
|
|
if (Flag.OPENCODE_STRICT_CONFIG_DEPS) {
|
|
log.error("failed to install dependencies", { dir, error: err })
|
|
throw err
|
|
}
|
|
log.warn("failed to install dependencies", { dir, error: err })
|
|
})
|
|
}
|
|
|
|
async function isWritable(dir: string) {
|
|
try {
|
|
await fs.access(dir, constants.W_OK)
|
|
return true
|
|
} catch {
|
|
return false
|
|
}
|
|
}
|
|
|
|
export async function needsInstall(dir: string) {
|
|
// Some config dirs may be read-only.
|
|
// Installing deps there will fail; skip installation in that case.
|
|
const writable = await isWritable(dir)
|
|
if (!writable) {
|
|
log.debug("config dir is not writable, skipping dependency install", { dir })
|
|
return false
|
|
}
|
|
|
|
const nodeModules = path.join(dir, "node_modules")
|
|
if (!existsSync(nodeModules)) return true
|
|
|
|
const pkg = path.join(dir, "package.json")
|
|
const pkgExists = await Filesystem.exists(pkg)
|
|
if (!pkgExists) return true
|
|
|
|
const parsed = await Filesystem.readJson<{ dependencies?: Record<string, string> }>(pkg).catch(() => null)
|
|
const dependencies = parsed?.dependencies ?? {}
|
|
const depVersion = dependencies["@opencode-ai/plugin"]
|
|
if (!depVersion) return true
|
|
|
|
const targetVersion = Installation.isLocal() ? "latest" : Installation.VERSION
|
|
if (targetVersion === "latest") {
|
|
const isOutdated = await PackageRegistry.isOutdated("@opencode-ai/plugin", depVersion, dir)
|
|
if (!isOutdated) return false
|
|
log.info("Cached version is outdated, proceeding with install", {
|
|
pkg: "@opencode-ai/plugin",
|
|
cachedVersion: depVersion,
|
|
})
|
|
return true
|
|
}
|
|
if (depVersion === targetVersion) return false
|
|
return true
|
|
}
|
|
|
|
function rel(item: string, patterns: string[]) {
|
|
const normalizedItem = item.replaceAll("\\", "/")
|
|
for (const pattern of patterns) {
|
|
const index = normalizedItem.indexOf(pattern)
|
|
if (index === -1) continue
|
|
return normalizedItem.slice(index + pattern.length)
|
|
}
|
|
}
|
|
|
|
function trim(file: string) {
|
|
const ext = path.extname(file)
|
|
return ext.length ? file.slice(0, -ext.length) : file
|
|
}
|
|
|
|
async function loadCommand(dir: string) {
|
|
const result: Record<string, Command> = {}
|
|
for (const item of await Glob.scan("{command,commands}/**/*.md", {
|
|
cwd: dir,
|
|
absolute: true,
|
|
dot: true,
|
|
symlink: true,
|
|
})) {
|
|
const md = await ConfigMarkdown.parse(item).catch(async (err) => {
|
|
const message = ConfigMarkdown.FrontmatterError.isInstance(err)
|
|
? err.data.message
|
|
: `Failed to parse command ${item}`
|
|
const { Session } = await import("@/session")
|
|
Bus.publish(Session.Event.Error, { error: new NamedError.Unknown({ message }).toObject() })
|
|
log.error("failed to load command", { command: item, err })
|
|
return undefined
|
|
})
|
|
if (!md) continue
|
|
|
|
const patterns = ["/.opencode/command/", "/.opencode/commands/", "/command/", "/commands/"]
|
|
const file = rel(item, patterns) ?? path.basename(item)
|
|
const name = trim(file)
|
|
|
|
const config = {
|
|
name,
|
|
...md.data,
|
|
template: md.content.trim(),
|
|
}
|
|
const parsed = Command.safeParse(config)
|
|
if (parsed.success) {
|
|
result[config.name] = parsed.data
|
|
continue
|
|
}
|
|
throw new InvalidError({ path: item, issues: parsed.error.issues }, { cause: parsed.error })
|
|
}
|
|
return result
|
|
}
|
|
|
|
async function loadAgent(dir: string) {
|
|
const result: Record<string, Agent> = {}
|
|
|
|
for (const item of await Glob.scan("{agent,agents}/**/*.md", {
|
|
cwd: dir,
|
|
absolute: true,
|
|
dot: true,
|
|
symlink: true,
|
|
})) {
|
|
const md = await ConfigMarkdown.parse(item).catch(async (err) => {
|
|
const message = ConfigMarkdown.FrontmatterError.isInstance(err)
|
|
? err.data.message
|
|
: `Failed to parse agent ${item}`
|
|
const { Session } = await import("@/session")
|
|
Bus.publish(Session.Event.Error, { error: new NamedError.Unknown({ message }).toObject() })
|
|
log.error("failed to load agent", { agent: item, err })
|
|
return undefined
|
|
})
|
|
if (!md) continue
|
|
|
|
const patterns = ["/.opencode/agent/", "/.opencode/agents/", "/agent/", "/agents/"]
|
|
const file = rel(item, patterns) ?? path.basename(item)
|
|
const agentName = trim(file)
|
|
|
|
const config = {
|
|
name: agentName,
|
|
...md.data,
|
|
prompt: md.content.trim(),
|
|
}
|
|
const parsed = Agent.safeParse(config)
|
|
if (parsed.success) {
|
|
result[config.name] = parsed.data
|
|
continue
|
|
}
|
|
throw new InvalidError({ path: item, issues: parsed.error.issues }, { cause: parsed.error })
|
|
}
|
|
return result
|
|
}
|
|
|
|
async function loadMode(dir: string) {
|
|
const result: Record<string, Agent> = {}
|
|
for (const item of await Glob.scan("{mode,modes}/*.md", {
|
|
cwd: dir,
|
|
absolute: true,
|
|
dot: true,
|
|
symlink: true,
|
|
})) {
|
|
const md = await ConfigMarkdown.parse(item).catch(async (err) => {
|
|
const message = ConfigMarkdown.FrontmatterError.isInstance(err)
|
|
? err.data.message
|
|
: `Failed to parse mode ${item}`
|
|
const { Session } = await import("@/session")
|
|
Bus.publish(Session.Event.Error, { error: new NamedError.Unknown({ message }).toObject() })
|
|
log.error("failed to load mode", { mode: item, err })
|
|
return undefined
|
|
})
|
|
if (!md) continue
|
|
|
|
const config = {
|
|
name: path.basename(item, ".md"),
|
|
...md.data,
|
|
prompt: md.content.trim(),
|
|
}
|
|
const parsed = Agent.safeParse(config)
|
|
if (parsed.success) {
|
|
result[config.name] = {
|
|
...parsed.data,
|
|
mode: "primary" as const,
|
|
}
|
|
continue
|
|
}
|
|
}
|
|
return result
|
|
}
|
|
|
|
async function loadPlugin(dir: string) {
|
|
const plugins: string[] = []
|
|
|
|
for (const item of await Glob.scan("{plugin,plugins}/*.{ts,js}", {
|
|
cwd: dir,
|
|
absolute: true,
|
|
dot: true,
|
|
symlink: true,
|
|
})) {
|
|
plugins.push(pathToFileURL(item).href)
|
|
}
|
|
return plugins
|
|
}
|
|
|
|
/**
|
|
* Extracts a canonical plugin name from a plugin specifier.
|
|
* - For file:// URLs: extracts filename without extension
|
|
* - For npm packages: extracts package name without version
|
|
*
|
|
* @example
|
|
* getPluginName("file:///path/to/plugin/foo.js") // "foo"
|
|
* getPluginName("oh-my-opencode@2.4.3") // "oh-my-opencode"
|
|
* getPluginName("@scope/pkg@1.0.0") // "@scope/pkg"
|
|
*/
|
|
export function getPluginName(plugin: string): string {
|
|
if (plugin.startsWith("file://")) {
|
|
return path.parse(new URL(plugin).pathname).name
|
|
}
|
|
const lastAt = plugin.lastIndexOf("@")
|
|
if (lastAt > 0) {
|
|
return plugin.substring(0, lastAt)
|
|
}
|
|
return plugin
|
|
}
|
|
|
|
/**
|
|
* Deduplicates plugins by name, with later entries (higher priority) winning.
|
|
* Priority order (highest to lowest):
|
|
* 1. Local plugin/ directory
|
|
* 2. Local opencode.json
|
|
* 3. Global plugin/ directory
|
|
* 4. Global opencode.json
|
|
*
|
|
* Since plugins are added in low-to-high priority order,
|
|
* we reverse, deduplicate (keeping first occurrence), then restore order.
|
|
*/
|
|
export function deduplicatePlugins(plugins: string[]): string[] {
|
|
// seenNames: canonical plugin names for duplicate detection
|
|
// e.g., "oh-my-opencode", "@scope/pkg"
|
|
const seenNames = new Set<string>()
|
|
|
|
// uniqueSpecifiers: full plugin specifiers to return
|
|
// e.g., "oh-my-opencode@2.4.3", "file:///path/to/plugin.js"
|
|
const uniqueSpecifiers: string[] = []
|
|
|
|
for (const specifier of plugins.toReversed()) {
|
|
const name = getPluginName(specifier)
|
|
if (!seenNames.has(name)) {
|
|
seenNames.add(name)
|
|
uniqueSpecifiers.push(specifier)
|
|
}
|
|
}
|
|
|
|
return uniqueSpecifiers.toReversed()
|
|
}
|
|
|
|
export const McpLocal = z
|
|
.object({
|
|
type: z.literal("local").describe("Type of MCP server connection"),
|
|
command: z.string().array().describe("Command and arguments to run the MCP server"),
|
|
environment: z
|
|
.record(z.string(), z.string())
|
|
.optional()
|
|
.describe("Environment variables to set when running the MCP server"),
|
|
enabled: z.boolean().optional().describe("Enable or disable the MCP server on startup"),
|
|
timeout: z
|
|
.number()
|
|
.int()
|
|
.positive()
|
|
.optional()
|
|
.describe("Timeout in ms for MCP server requests. Defaults to 5000 (5 seconds) if not specified."),
|
|
})
|
|
.strict()
|
|
.meta({
|
|
ref: "McpLocalConfig",
|
|
})
|
|
|
|
export const McpOAuth = z
|
|
.object({
|
|
clientId: z
|
|
.string()
|
|
.optional()
|
|
.describe("OAuth client ID. If not provided, dynamic client registration (RFC 7591) will be attempted."),
|
|
clientSecret: z.string().optional().describe("OAuth client secret (if required by the authorization server)"),
|
|
scope: z.string().optional().describe("OAuth scopes to request during authorization"),
|
|
})
|
|
.strict()
|
|
.meta({
|
|
ref: "McpOAuthConfig",
|
|
})
|
|
export type McpOAuth = z.infer<typeof McpOAuth>
|
|
|
|
export const McpRemote = z
|
|
.object({
|
|
type: z.literal("remote").describe("Type of MCP server connection"),
|
|
url: z.string().describe("URL of the remote MCP server"),
|
|
enabled: z.boolean().optional().describe("Enable or disable the MCP server on startup"),
|
|
headers: z.record(z.string(), z.string()).optional().describe("Headers to send with the request"),
|
|
oauth: z
|
|
.union([McpOAuth, z.literal(false)])
|
|
.optional()
|
|
.describe(
|
|
"OAuth authentication configuration for the MCP server. Set to false to disable OAuth auto-detection.",
|
|
),
|
|
timeout: z
|
|
.number()
|
|
.int()
|
|
.positive()
|
|
.optional()
|
|
.describe("Timeout in ms for MCP server requests. Defaults to 5000 (5 seconds) if not specified."),
|
|
})
|
|
.strict()
|
|
.meta({
|
|
ref: "McpRemoteConfig",
|
|
})
|
|
|
|
export const Mcp = z.discriminatedUnion("type", [McpLocal, McpRemote])
|
|
export type Mcp = z.infer<typeof Mcp>
|
|
|
|
export const PermissionAction = z.enum(["ask", "allow", "deny"]).meta({
|
|
ref: "PermissionActionConfig",
|
|
})
|
|
export type PermissionAction = z.infer<typeof PermissionAction>
|
|
|
|
export const PermissionObject = z.record(z.string(), PermissionAction).meta({
|
|
ref: "PermissionObjectConfig",
|
|
})
|
|
export type PermissionObject = z.infer<typeof PermissionObject>
|
|
|
|
export const PermissionRule = z.union([PermissionAction, PermissionObject]).meta({
|
|
ref: "PermissionRuleConfig",
|
|
})
|
|
export type PermissionRule = z.infer<typeof PermissionRule>
|
|
|
|
// Capture original key order before zod reorders, then rebuild in original order
|
|
const permissionPreprocess = (val: unknown) => {
|
|
if (typeof val === "object" && val !== null && !Array.isArray(val)) {
|
|
return { __originalKeys: Object.keys(val), ...val }
|
|
}
|
|
return val
|
|
}
|
|
|
|
const permissionTransform = (x: unknown): Record<string, PermissionRule> => {
|
|
if (typeof x === "string") return { "*": x as PermissionAction }
|
|
const obj = x as { __originalKeys?: string[] } & Record<string, unknown>
|
|
const { __originalKeys, ...rest } = obj
|
|
if (!__originalKeys) return rest as Record<string, PermissionRule>
|
|
const result: Record<string, PermissionRule> = {}
|
|
for (const key of __originalKeys) {
|
|
if (key in rest) result[key] = rest[key] as PermissionRule
|
|
}
|
|
return result
|
|
}
|
|
|
|
export const Permission = z
|
|
.preprocess(
|
|
permissionPreprocess,
|
|
z
|
|
.object({
|
|
__originalKeys: z.string().array().optional(),
|
|
read: PermissionRule.optional(),
|
|
edit: PermissionRule.optional(),
|
|
glob: PermissionRule.optional(),
|
|
grep: PermissionRule.optional(),
|
|
list: PermissionRule.optional(),
|
|
bash: PermissionRule.optional(),
|
|
task: PermissionRule.optional(),
|
|
external_directory: PermissionRule.optional(),
|
|
todowrite: PermissionAction.optional(),
|
|
todoread: PermissionAction.optional(),
|
|
question: PermissionAction.optional(),
|
|
webfetch: PermissionAction.optional(),
|
|
websearch: PermissionAction.optional(),
|
|
codesearch: PermissionAction.optional(),
|
|
lsp: PermissionRule.optional(),
|
|
doom_loop: PermissionAction.optional(),
|
|
skill: PermissionRule.optional(),
|
|
})
|
|
.catchall(PermissionRule)
|
|
.or(PermissionAction),
|
|
)
|
|
.transform(permissionTransform)
|
|
.meta({
|
|
ref: "PermissionConfig",
|
|
})
|
|
export type Permission = z.infer<typeof Permission>
|
|
|
|
export const Command = z.object({
|
|
template: z.string(),
|
|
description: z.string().optional(),
|
|
agent: z.string().optional(),
|
|
model: ModelId.optional(),
|
|
subtask: z.boolean().optional(),
|
|
})
|
|
export type Command = z.infer<typeof Command>
|
|
|
|
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 Agent = z
|
|
.object({
|
|
model: ModelId.optional(),
|
|
variant: z
|
|
.string()
|
|
.optional()
|
|
.describe("Default model variant for this agent (applies only when using the agent's configured model)."),
|
|
temperature: z.number().optional(),
|
|
top_p: z.number().optional(),
|
|
prompt: z.string().optional(),
|
|
tools: z.record(z.string(), z.boolean()).optional().describe("@deprecated Use 'permission' field instead"),
|
|
disable: z.boolean().optional(),
|
|
description: z.string().optional().describe("Description of when to use the agent"),
|
|
mode: z.enum(["subagent", "primary", "all"]).optional(),
|
|
hidden: z
|
|
.boolean()
|
|
.optional()
|
|
.describe("Hide this subagent from the @ autocomplete menu (default: false, only applies to mode: subagent)"),
|
|
options: z.record(z.string(), z.any()).optional(),
|
|
color: z
|
|
.union([
|
|
z.string().regex(/^#[0-9a-fA-F]{6}$/, "Invalid hex color format"),
|
|
z.enum(["primary", "secondary", "accent", "success", "warning", "error", "info"]),
|
|
])
|
|
.optional()
|
|
.describe("Hex color code (e.g., #FF5733) or theme color (e.g., primary)"),
|
|
steps: z
|
|
.number()
|
|
.int()
|
|
.positive()
|
|
.optional()
|
|
.describe("Maximum number of agentic iterations before forcing text-only response"),
|
|
maxSteps: z.number().int().positive().optional().describe("@deprecated Use 'steps' field instead."),
|
|
permission: Permission.optional(),
|
|
})
|
|
.catchall(z.any())
|
|
.transform((agent, ctx) => {
|
|
const knownKeys = new Set([
|
|
"name",
|
|
"model",
|
|
"variant",
|
|
"prompt",
|
|
"description",
|
|
"temperature",
|
|
"top_p",
|
|
"mode",
|
|
"hidden",
|
|
"color",
|
|
"steps",
|
|
"maxSteps",
|
|
"options",
|
|
"permission",
|
|
"disable",
|
|
"tools",
|
|
])
|
|
|
|
// Extract unknown properties into options
|
|
const options: Record<string, unknown> = { ...agent.options }
|
|
for (const [key, value] of Object.entries(agent)) {
|
|
if (!knownKeys.has(key)) options[key] = value
|
|
}
|
|
|
|
// Convert legacy tools config to permissions
|
|
const permission: Permission = {}
|
|
for (const [tool, enabled] of Object.entries(agent.tools ?? {})) {
|
|
const action = enabled ? "allow" : "deny"
|
|
// write, edit, patch, multiedit all map to edit permission
|
|
if (tool === "write" || tool === "edit" || tool === "patch" || tool === "multiedit") {
|
|
permission.edit = action
|
|
} else {
|
|
permission[tool] = action
|
|
}
|
|
}
|
|
Object.assign(permission, agent.permission)
|
|
|
|
// Convert legacy maxSteps to steps
|
|
const steps = agent.steps ?? agent.maxSteps
|
|
|
|
return { ...agent, options, permission, steps } as typeof agent & {
|
|
options?: Record<string, unknown>
|
|
permission?: Permission
|
|
steps?: number
|
|
}
|
|
})
|
|
.meta({
|
|
ref: "AgentConfig",
|
|
})
|
|
export type Agent = z.infer<typeof Agent>
|
|
|
|
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"),
|
|
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"),
|
|
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 Provider = ModelsDev.Provider.partial()
|
|
.extend({
|
|
whitelist: z.array(z.string()).optional(),
|
|
blacklist: z.array(z.string()).optional(),
|
|
models: z
|
|
.record(
|
|
z.string(),
|
|
ModelsDev.Model.partial().extend({
|
|
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"),
|
|
}),
|
|
)
|
|
.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(),
|
|
})
|
|
.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(), Command)
|
|
.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(),
|
|
plugin: z.string().array().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.",
|
|
),
|
|
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: ModelId.describe("Model to use in the format of provider/model, eg anthropic/claude-2").optional(),
|
|
small_model: ModelId.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: Agent.optional(),
|
|
plan: Agent.optional(),
|
|
})
|
|
.catchall(Agent)
|
|
.optional()
|
|
.describe("@deprecated Use `agent` field instead."),
|
|
agent: z
|
|
.object({
|
|
// primary
|
|
plan: Agent.optional(),
|
|
build: Agent.optional(),
|
|
// subagent
|
|
general: Agent.optional(),
|
|
explore: Agent.optional(),
|
|
// specialized
|
|
title: Agent.optional(),
|
|
summary: Agent.optional(),
|
|
compaction: Agent.optional(),
|
|
})
|
|
.catchall(Agent)
|
|
.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([
|
|
Mcp,
|
|
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: Permission.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>
|
|
|
|
export const global = lazy(async () => {
|
|
let result: Info = pipe(
|
|
{},
|
|
mergeDeep(await loadFile(path.join(Global.Path.config, "config.json"))),
|
|
mergeDeep(await loadFile(path.join(Global.Path.config, "opencode.json"))),
|
|
mergeDeep(await loadFile(path.join(Global.Path.config, "opencode.jsonc"))),
|
|
)
|
|
|
|
const legacy = path.join(Global.Path.config, "config")
|
|
if (existsSync(legacy)) {
|
|
await 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 Filesystem.writeJson(path.join(Global.Path.config, "config.json"), result)
|
|
await fs.unlink(legacy)
|
|
})
|
|
.catch(() => {})
|
|
}
|
|
|
|
return result
|
|
})
|
|
|
|
export const { readFile } = ConfigPaths
|
|
|
|
async function loadFile(filepath: string): Promise<Info> {
|
|
log.info("loading", { path: filepath })
|
|
const text = await readFile(filepath)
|
|
if (!text) return {}
|
|
return load(text, { path: filepath })
|
|
}
|
|
|
|
async function load(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 = await 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",')
|
|
await Filesystem.write(options.path, updated).catch(() => {})
|
|
}
|
|
const data = parsed.data
|
|
if (data.plugin && isFile) {
|
|
for (let i = 0; i < data.plugin.length; i++) {
|
|
const plugin = data.plugin[i]
|
|
try {
|
|
data.plugin[i] = import.meta.resolve!(plugin, options.path)
|
|
} catch (e) {
|
|
try {
|
|
// import.meta.resolve sometimes fails with newly created node_modules
|
|
const require = createRequire(options.path)
|
|
const resolvedPath = require.resolve(plugin)
|
|
data.plugin[i] = pathToFileURL(resolvedPath).href
|
|
} catch {
|
|
// Ignore, plugin might be a generic string identifier like "mcp-server"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
return data
|
|
}
|
|
|
|
throw new InvalidError({
|
|
path: source,
|
|
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 async function get() {
|
|
return state().then((x) => x.config)
|
|
}
|
|
|
|
export async function getGlobal() {
|
|
return global()
|
|
}
|
|
|
|
export async function update(config: Info) {
|
|
const filepath = path.join(Instance.directory, "config.json")
|
|
const existing = await loadFile(filepath)
|
|
await Filesystem.writeJson(filepath, mergeDeep(existing, config))
|
|
await Instance.dispose()
|
|
}
|
|
|
|
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 isRecord(value: unknown): value is Record<string, unknown> {
|
|
return !!value && typeof value === "object" && !Array.isArray(value)
|
|
}
|
|
|
|
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 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 async function updateGlobal(config: Info) {
|
|
const filepath = globalConfigFile()
|
|
const before = await Filesystem.readText(filepath).catch((err: any) => {
|
|
if (err.code === "ENOENT") return "{}"
|
|
throw new JsonError({ path: filepath }, { cause: err })
|
|
})
|
|
|
|
const next = await (async () => {
|
|
if (!filepath.endsWith(".jsonc")) {
|
|
const existing = parseConfig(before, filepath)
|
|
const merged = mergeDeep(existing, config)
|
|
await Filesystem.writeJson(filepath, merged)
|
|
return merged
|
|
}
|
|
|
|
const updated = patchJsonc(before, config)
|
|
const merged = parseConfig(updated, filepath)
|
|
await Filesystem.write(filepath, updated)
|
|
return merged
|
|
})()
|
|
|
|
global.reset()
|
|
|
|
void Instance.disposeAll()
|
|
.catch(() => undefined)
|
|
.finally(() => {
|
|
GlobalBus.emit("event", {
|
|
directory: "global",
|
|
payload: {
|
|
type: Event.Disposed.type,
|
|
properties: {},
|
|
},
|
|
})
|
|
})
|
|
|
|
return next
|
|
}
|
|
|
|
export async function directories() {
|
|
return state().then((x) => x.directories)
|
|
}
|
|
}
|
|
Filesystem.write
|
|
Filesystem.write
|