feat(plugin): expose app metadata (#38179)

packages/cli/src/acp/service.ts

@@ -38,7 +38,7 @@ import type {
   SetSessionModeRequest,
   SetSessionModeResponse,
 } from "@agentclientprotocol/sdk"
-import { InstallationVersion } from "@opencode-ai/util/installation/version"
+import { OPENCODE_VERSION } from "../version"
 import { SessionMessage } from "@opencode-ai/schema/session-message"
 import { buildConfigOptions, parseModelSelection, type ConfigOptionProvider } from "./config-option"
 import { promptContentToParts } from "./content"
@@ -176,7 +176,7 @@ export function make(input: { readonly client: OpenCodeClient; readonly connecti
           sessionCapabilities: { close: {}, fork: {}, list: {}, resume: {} },
         },
         authMethods: [authMethod],
-        agentInfo: { name: "OpenCode", version: InstallationVersion },
+        agentInfo: { name: "OpenCode", version: OPENCODE_VERSION },
       }
     },
     authenticate: async (params) => {

packages/cli/src/commands/handlers/default.ts

@@ -9,6 +9,7 @@ import { ServerConnection } from "../../services/server-connection"
 import { Updater } from "../../services/updater"
 import { UpdatePreflight } from "../../services/update-preflight"
 import { Npm } from "@opencode-ai/util/npm"
+import { OPENCODE_CHANNEL, OPENCODE_VERSION } from "../../version"
 
 export default Runtime.handler(Commands, (input) =>
   Effect.gen(function* () {
@@ -44,6 +45,7 @@ export default Runtime.handler(Commands, (input) =>
     const runPromise = Effect.runPromiseWith(context)
     const service = server.service
     yield* run({
+      app: { name: process.env.OPENCODE_CLIENT ?? "cli", version: OPENCODE_VERSION, channel: OPENCODE_CHANNEL },
       server: {
         endpoint: server.endpoint,
         service: service

packages/cli/src/index.ts

@@ -1,13 +1,12 @@
 #!/usr/bin/env bun
 
 import { NodeRuntime, NodeServices } from "@effect/platform-node"
-import { Effect, Layer } from "effect"
+import { Effect } from "effect"
 import { Commands } from "./commands/commands"
 import { Runtime } from "./framework/runtime"
 import { Observability } from "@opencode-ai/util/observability"
-import { Client } from "@opencode-ai/util/client"
 import { Updater } from "./services/updater"
-import { InstallationChannel, InstallationVersion, InstallationLocal } from "@opencode-ai/util/installation/version"
+import { OPENCODE_CHANNEL, OPENCODE_LOCAL, OPENCODE_VERSION } from "./version"
 import { LayerNode } from "@opencode-ai/util/effect/layer-node"
 import { Global } from "@opencode-ai/util/global"
 import { AppProcess } from "@opencode-ai/util/process"
@@ -53,12 +52,12 @@ const Handlers = Runtime.handlers(Commands, {
 })
 
 Effect.logInfo("cli starting", {
-  version: InstallationVersion,
-  channel: InstallationChannel,
-  local: InstallationLocal,
+  version: OPENCODE_VERSION,
+  channel: OPENCODE_CHANNEL,
+  local: OPENCODE_LOCAL,
   args: process.argv.slice(2),
 }).pipe(
-  Effect.flatMap(() => Runtime.run(Commands, Handlers, { version: InstallationVersion })),
+  Effect.flatMap(() => Runtime.run(Commands, Handlers, { version: OPENCODE_VERSION })),
   Effect.annotateLogs({ role: "cli" }),
   Effect.provide(Config.layer),
   Effect.provide(Updater.layer),
@@ -74,7 +73,10 @@ Effect.logInfo("cli starting", {
     Observability.layer({
       endpoint: process.env.OTEL_EXPORTER_OTLP_ENDPOINT,
       headers: process.env.OTEL_EXPORTER_OTLP_HEADERS,
-    }).pipe(Layer.provide(Client.layer(process.env.OPENCODE_CLIENT))),
+      client: process.env.OPENCODE_CLIENT ?? "cli",
+      version: OPENCODE_VERSION,
+      channel: OPENCODE_CHANNEL,
+    }),
   ),
   Effect.provide(NodeServices.layer),
   Effect.scoped,

packages/cli/src/server-process.ts

@@ -4,7 +4,7 @@ import { NodeServices } from "@effect/platform-node"
 import { Service, type DiscoverOptions, type Info } from "@opencode-ai/client/effect/service"
 import { LayerNode } from "@opencode-ai/util/effect/layer-node"
 import { Global } from "@opencode-ai/util/global"
-import { InstallationChannel, InstallationVersion } from "@opencode-ai/util/installation/version"
+import { OPENCODE_CHANNEL, OPENCODE_VERSION } from "./version"
 import { AppProcess } from "@opencode-ai/util/process"
 import { randomBytes, randomUUID } from "node:crypto"
 import path from "node:path"
@@ -69,7 +69,11 @@ const processEffect = Effect.fnUntraced(function* (options: Options) {
       const instanceID = randomUUID()
       const server = yield* start(
         {
-          client: process.env.OPENCODE_CLIENT ?? "cli",
+          app: {
+            name: process.env.OPENCODE_CLIENT ?? "cli",
+            version: OPENCODE_VERSION,
+            channel: OPENCODE_CHANNEL,
+          },
           hostname,
           port,
           password,
@@ -77,11 +81,11 @@ const processEffect = Effect.fnUntraced(function* (options: Options) {
           database: {
             path:
               process.env.OPENCODE_DB ??
-              (["latest", "beta", "prod"].includes(InstallationChannel) ||
+              (["latest", "beta", "prod"].includes(OPENCODE_CHANNEL) ||
               process.env.OPENCODE_DISABLE_CHANNEL_DB === "1" ||
               process.env.OPENCODE_DISABLE_CHANNEL_DB === "true"
                 ? "opencode.db"
-                : `opencode-${InstallationChannel.replace(/[^a-zA-Z0-9._-]/g, "-")}.db`),
+                : `opencode-${OPENCODE_CHANNEL.replace(/[^a-zA-Z0-9._-]/g, "-")}.db`),
           },
           models: {
             url: process.env.OPENCODE_MODELS_URL,
@@ -173,7 +177,7 @@ const register = Effect.fnUntraced(function* (
   yield* fs.makeDirectory(path.dirname(file), { recursive: true })
   const info = {
     id,
-    version: InstallationVersion,
+    version: OPENCODE_VERSION,
     url: HttpServer.formatAddress(address),
     pid: process.pid,
     password,

packages/cli/src/services/server-connection.ts

@@ -1,6 +1,6 @@
 import { Service, type Endpoint, type EnsureOptions } from "@opencode-ai/client/effect/service"
 import { ClientError, isUnauthorizedError, OpenCode } from "@opencode-ai/client/promise"
-import { InstallationVersion } from "@opencode-ai/util/installation/version"
+import { OPENCODE_VERSION } from "../version"
 import { Effect, Redacted } from "effect"
 import { Env } from "../env"
 import { ServiceConfig } from "./service-config"
@@ -32,9 +32,9 @@ export const resolve = Effect.fn("cli.server-connection.resolve")(function* (arg
       try: () => client.health.get({ signal: AbortSignal.timeout(5_000) }),
       catch: (cause) => connectError(endpoint, cause),
     })
-    if (health.version !== InstallationVersion)
+    if (health.version !== OPENCODE_VERSION)
       process.stderr.write(
-        `Warning: Server at ${endpoint.url} has version ${health.version}; this client is ${InstallationVersion}. Continuing anyway.\n`,
+        `Warning: Server at ${endpoint.url} has version ${health.version}; this client is ${OPENCODE_VERSION}. Continuing anyway.\n`,
       )
     return { endpoint } satisfies Resolved
   }

packages/cli/src/services/service-config.ts

@@ -1,5 +1,5 @@
 import { Global } from "@opencode-ai/util/global"
-import { InstallationChannel, InstallationVersion } from "@opencode-ai/util/installation/version"
+import { OPENCODE_CHANNEL, OPENCODE_VERSION } from "../version"
 import { Hash } from "@opencode-ai/util/hash"
 import { Service } from "@opencode-ai/client/effect/service"
 import { Effect, FileSystem, Option, Schema } from "effect"
@@ -24,26 +24,26 @@ type Key = (typeof keys)[number]
 const decodeInfo = Schema.decodeUnknownEffect(Schema.fromJsonString(Info))
 const decodeRegistration = Schema.decodeUnknownEffect(Schema.fromJsonString(Service.Info))
 
-export function filename(channel = InstallationChannel) {
+export function filename(channel = OPENCODE_CHANNEL) {
   if (channel === "latest" || channel === "next") return "service.json"
   return `service-${channel.replace(/[^a-zA-Z0-9._-]/g, "-")}.json`
 }
 
-export function defaultPort(channel = InstallationChannel) {
+export function defaultPort(channel = OPENCODE_CHANNEL) {
   if (channel === "latest" || channel === "next") return 0xc0de
   if (channel === "local") return 0xc0df
   return 10_000 + (Number.parseInt(Hash.fast(channel).slice(0, 8), 16) % 50_000)
 }
 
-export function legacyFilename(channel = InstallationChannel) {
+export function legacyFilename(channel = OPENCODE_CHANNEL) {
   if (channel === "latest" || channel === "local") return
   return `service-${Hash.fast(channel)}.json`
 }
 
 export function versionBelongsToChannel(
   version: string | undefined,
-  channel = InstallationChannel,
-  installedVersion = InstallationVersion,
+  channel = OPENCODE_CHANNEL,
+  installedVersion = OPENCODE_VERSION,
 ) {
   if (version === undefined) return false
   if (version === installedVersion) return true
@@ -55,8 +55,8 @@ export function versionBelongsToChannel(
 export const migrateRegistration = Effect.fnUntraced(function* (
   legacy: string,
   file: string,
-  channel = InstallationChannel,
-  installedVersion = InstallationVersion,
+  channel = OPENCODE_CHANNEL,
+  installedVersion = OPENCODE_VERSION,
 ) {
   const fs = yield* FileSystem.FileSystem
   const text = yield* fs.readFileString(legacy).pipe(Effect.option)
@@ -92,7 +92,7 @@ const paths = Effect.gen(function* () {
     legacyConfigFile: legacy ? path.join(global.config, legacy) : undefined,
     legacyRegistrationFiles: [
       ...(legacy ? [path.join(global.state, legacy)] : []),
-      ...(name !== "service.json" && InstallationChannel !== "local" ? [path.join(global.state, "service.json")] : []),
+      ...(name !== "service.json" && OPENCODE_CHANNEL !== "local" ? [path.join(global.state, "service.json")] : []),
     ],
     configFile: path.join(global.config, name),
   }
@@ -103,7 +103,7 @@ export const options = Effect.fnUntraced(function* () {
   yield* Effect.forEach(legacyRegistrationFiles, (legacy) => migrateRegistration(legacy, file))
   return {
     file,
-    version: InstallationVersion,
+    version: OPENCODE_VERSION,
     command: [...selfCommand(), "serve", "--service"],
   }
 })

packages/cli/src/services/update-preflight.tsx

@@ -3,7 +3,7 @@
 // version-mismatched background service before the TUI attaches.
 import { createCliRenderer, RGBA, TextAttributes, type CliRenderer, type ThemeMode } from "@opentui/core"
 import { render, useTerminalDimensions } from "@opentui/solid"
-import { InstallationVersion } from "@opencode-ai/util/installation/version"
+import { OPENCODE_VERSION } from "../version"
 import { registerOpencodeSpinner } from "@opencode-ai/tui/component/register-spinner"
 import { SPINNER_FRAMES } from "@opencode-ai/tui/component/spinner"
 import { go } from "@opencode-ai/tui/logo"
@@ -356,12 +356,12 @@ function UpdateFooter(props: {
           ] as const)
         : []),
       ["to", colors.muted],
-      [InstallationVersion, colors.accent],
+      [OPENCODE_VERSION, colors.accent],
     )
   const completedHeader = phrase(
     ["OpenCode", colors.muted, true],
     ["updated to", colors.muted],
-    [InstallationVersion, colors.accent],
+    [OPENCODE_VERSION, colors.accent],
   )
   const pausedHeader = phrase(["OpenCode", colors.muted, true], ["update paused", colors.muted])
   const outcomeStatus = () =>

packages/cli/src/services/updater.ts

@@ -1,10 +1,6 @@
 import { Global } from "@opencode-ai/util/global"
 import { AppProcess } from "@opencode-ai/util/process"
-import {
-  InstallationChannel,
-  InstallationLocal,
-  InstallationVersion,
-} from "@opencode-ai/util/installation/version"
+import { OPENCODE_CHANNEL, OPENCODE_LOCAL, OPENCODE_VERSION } from "../version"
 import { Context, Duration, Effect, FileSystem, Layer } from "effect"
 import { ChildProcess } from "effect/unstable/process"
 import { parse, type ParseError } from "jsonc-parser"
@@ -52,7 +48,7 @@ export const layer = Layer.effect(
     const fs = yield* FileSystem.FileSystem
     const global = yield* Global.Service
     const appProcess = yield* AppProcess.Service
-    const channel = InstallationChannel.replace(/[^a-zA-Z0-9._-]/g, "-")
+    const channel = OPENCODE_CHANNEL.replace(/[^a-zA-Z0-9._-]/g, "-")
 
     const readPolicy = Effect.fnUntraced(function* () {
       const values = yield* Effect.forEach(["config.json", "opencode.json", "opencode.jsonc"], (name) =>
@@ -99,8 +95,8 @@ export const layer = Layer.effect(
       const response = yield* Effect.tryPromise({
         try: () =>
           fetch(
-            `https://registry.npmjs.org/${encodeURIComponent(packageName)}/${encodeURIComponent(InstallationChannel)}`,
-            { headers: { "User-Agent": `opencode/${InstallationVersion}` }, signal: AbortSignal.timeout(10_000) },
+            `https://registry.npmjs.org/${encodeURIComponent(packageName)}/${encodeURIComponent(OPENCODE_CHANNEL)}`,
+            { headers: { "User-Agent": `opencode/${OPENCODE_VERSION}` }, signal: AbortSignal.timeout(10_000) },
           ),
         catch: (cause) => new Error("Failed to check for updates", { cause }),
       })
@@ -138,13 +134,13 @@ export const layer = Layer.effect(
 
     const check = Effect.fn("cli.updater.check")(function* () {
       if (
-        InstallationLocal ||
+        OPENCODE_LOCAL ||
         ["1", "true"].includes(process.env.OPENCODE_DISABLE_AUTOUPDATE?.toLowerCase() ?? "")
       )
         return yield* Effect.logInfo("update check skipped", {
-          reason: InstallationLocal ? "local-install" : "disabled",
-          version: InstallationVersion,
-          channel: InstallationChannel,
+          reason: OPENCODE_LOCAL ? "local-install" : "disabled",
+          version: OPENCODE_VERSION,
+          channel: OPENCODE_CHANNEL,
         })
       const policy = yield* readPolicy()
       if (policy === false) return yield* Effect.logInfo("update check skipped", { reason: "policy-disabled" })
@@ -152,15 +148,15 @@ export const layer = Layer.effect(
       return yield* Effect.gen(function* () {
         const version = yield* latest()
         yield* Effect.logInfo("update check", {
-          current: InstallationVersion,
+          current: OPENCODE_VERSION,
           latest: version,
         })
-        const next = action(InstallationVersion, version, policy)
+        const next = action(OPENCODE_VERSION, version, policy)
         if (next === "none") return yield* Effect.logInfo("update check done", { action: "up-to-date" })
         const detected = yield* method()
         if (!detected) return yield* Effect.logWarning("automatic update skipped: installation method not found")
         yield* upgrade(detected, version)
-        yield* Effect.logInfo("updated OpenCode", { from: InstallationVersion, to: version, method: detected })
+        yield* Effect.logInfo("updated OpenCode", { from: OPENCODE_VERSION, to: version, method: detected })
       })
     }, Effect.catchCause((cause) => Effect.logWarning("automatic update failed", { cause })))
 

packages/cli/src/version.ts

@@ -0,0 +1,8 @@
+declare const OPENCODE_VERSION: string
+declare const OPENCODE_CHANNEL: string
+
+const version = typeof OPENCODE_VERSION === "string" ? OPENCODE_VERSION : "local"
+const channel = typeof OPENCODE_CHANNEL === "string" ? OPENCODE_CHANNEL : "local"
+
+export { version as OPENCODE_VERSION, channel as OPENCODE_CHANNEL }
+export const OPENCODE_LOCAL = channel === "local"