dsh-opencode 0.1.0 → 0.1.2

package/README.md

@@ -1,108 +1,59 @@
-# dsh-opencode — OpenCode Zen / Go live catalog plugin
+# dsh-opencode
 
-An out-of-tree DSH bundle that serves the OpenCode **Zen** and **Go** products as two independent live LLM routes with a **dynamic model catalog**: models the official lists publish become selectable and executable without a plugin update, rebuild, or DSH restart, as long as they use a known wire protocol and publish the metadata the route needs.
+OpenCode Zen / Go を動的カタログ付きのライブ LLM ルートとして DSH に追加するプラグイン。
 
-- `opencode-zen-live` — **OpenCode Zen (Live)**
-- `opencode-go-live` — **OpenCode Go (Live)**
+- `opencode-zen-live` — OpenCode Zen (Live)
+- `opencode-go-live` — OpenCode Go (Live)
 
-The plugin reuses DSH's public `PiAiAdapter` and pi-ai's public `createProvider()` for all message conversion, streaming, tool calls, images, replay state, usage, cancellation, and idle-timeout behavior. It does **not** port OAuth, does not modify the existing `llm-pi-ai` configuration, does not fail over between Zen and Go automatically, and never sends an inference request as part of a catalog refresh.
-
-## Compatibility
-
-- DSH packages: `0.1.2-rc.1` (published release; peer range `^0.1.2-rc.1`)
-- pi-ai: pinned to the installed DSH adapter's range (`>=0.84.2 <0.86`, verified on `0.84.2`)
-- Cordis: `4.0.2`
-- Node: `^22.19.0 || >=24.0.0`
-
-## Installation
+## インストール
 
 ```sh
 pnpm dsh plugin --profile web add github:askdkc/dsh-opencode
-pnpm dsh --profile web --dump-config
 ```
 
-The dump should contain the `opencode-live` row with both provider routes. A restart applies the bundle once; after that, catalog updates need no restart.
-
-To remove it:
+削除:
 
 ```sh
 pnpm dsh plugin --profile web remove dsh-opencode
 ```
 
-## API key
-
-Both routes resolve the credential reference `apiKeyEnv` per request through the DSH credentials service (or the launch environment when no credential service is mounted). The default reference is `OPENCODE_API_KEY` for both products; set a different one per route in settings, e.g. `DSH_OPENCODE_ZEN_API_KEY` / `DSH_OPENCODE_GO_API_KEY`, and store the value through the standard credentials UI (the web Models page) or export it in the launch environment.
-
-- A missing or unusable key fails the request with `MISSING_CREDENTIAL`; the plugin never falls back to an unrelated ambient key (`OPENAI_API_KEY`, `GEMINI_API_KEY`, …).
-- Catalog fetches are unauthenticated and share no client with inference; keys never appear in URLs, logs, diagnostics, command output, or the cache.
-- Go requests carry an honest `x-opencode-client: opencode-live/<version>` header and an opaque, stable `x-opencode-session` value per DSH session; the plugin never impersonates OpenCode itself.
-
-## How the catalog works
-
-Three public sources feed the catalog: the official Zen list, the official Go list, and the Models.dev `api.json` metadata for the `opencode` / `opencode-go` providers. The plugin joins them by exact model id and keeps every candidate visible:
-
-| State | Meaning | Selector | Diagnostics |
-|---|---|---|---|
-| `ready` | officially listed with complete metadata and a known wire API | shown | — |
-| `metadata-pending` | officially listed; missing name/context/output/input/api | hidden | shown with the missing fields |
-| `unsupported-protocol` | metadata names an unknown SDK | hidden | shown with the SDK id |
-| `catalog-only` | in Models.dev but absent from the official list | hidden | shown |
-| `removed` | was officially listed before; no longer present | hidden (history keeps the name) | shown |
+## 使い方
 
-Wire APIs are chosen from the model-level `provider.npm` (falling back to the provider default) through a fixed allowlist: `@ai-sdk/openai-compatible` → Chat Completions, `@ai-sdk/openai` → Responses, `@ai-sdk/anthropic` → Anthropic Messages, `@ai-sdk/google` → Google Generative AI. Unknown SDK identifiers are never executed and nothing fetched is ever imported or installed. Reasoning-effort controls are offered only where the source publishes a verified effort list; toggle-only models keep the provider's default behavior.
+1. DSH を再起動すると両ルートが登録される(以降のカタログ更新に再起動は不要)
+2. Web の 設定 > モデル > OpenCode Zen (Live) の「編集」を開き、マスク済み API キー入力欄にキーを貼り付けて保存
+3. モデルセレクターから OpenCode のモデルを選んで使う
 
-Refreshes run single-flight per source (Models.dev once for both products) with conditional GET/304 handling, timeout and decoded-body caps, empty-list protection, and per-source failure isolation. An executable-set change re-registers the same routes in place, which publishes `llm/adapters-updated` so an open selection UI re-fetches. Snapshots are immutable and generation-bound; a prepared call cannot switch providers mid-request.
-
-## Commands
-
-| Command | Effect |
+| コマンド | 効果 |
 |---|---|
-| `/dsh-opencode` | After the key is stored securely, refreshes both catalogs and enables Zen/Go immediately; never accepts key values |
-| `/opencode-refresh [all\|zen\|go]` | Force a catalog refresh (joins in-flight fetches) |
-| `/opencode-status` | Freshness, per-source errors, ready/pending counts, credential presence |
-| `/opencode-models <zen\|go> [--all]` | Ready models, or every candidate with its state and reason |
+| `/dsh-opencode` | ステータス表示とキー設定場所の案内 |
+| `/opencode-refresh [all\|zen\|go]` | カタログを強制更新 |
+| `/opencode-status` | 更新時刻・エラー・モデル数・キー設定状況 |
+| `/opencode-models <zen\|go> [--all]` | モデル一覧(`--all` で非対応含む) |
 
-None of these commands displays key values or fragments, and none registers a model-visible tool.
+## 設定
 
-## Configuration
-
-Namespace `opencode-live` (composition defaults in `cordis.patch.yml`):
+名前空間 `opencode-live`(デフォルトは `cordis.patch.yml` 参照):
 
 ```yaml
 providers:
   opencode-zen-live:
-    product: zen            # must match the route key
-    apiKeyEnv: OPENCODE_API_KEY
+    product: zen
+    apiKeyEnv: OPENCODE_API_KEY   # 両ルート既定は同一参照
   opencode-go-live:
     product: go
     apiKeyEnv: OPENCODE_API_KEY
 catalog:
-  refreshIntervalMs: 900000   # periodic refresh (with jitter)
-  listRevalidateAfterMs: 60000  # re-check TTL on display/selection
-  timeoutMs: 15000            # per-request HTTP timeout
-  maxStaleMs: 604800000       # 7 days; staleness display bound
-  requireFresh: false         # true refuses requests while the official list is stale
+  refreshIntervalMs: 900000
+  timeoutMs: 15000
+  requireFresh: false
 ```
 
-`cachePath` (optional) relocates the validated-source cache; it defaults to `cache/opencode-live/catalog.json` under the DSH home. The cache stores source payloads and freshness facts only — never normalized output, never secrets.
+- API キーは設定 UI から保存(コマンド引数では受け付けない)。環境変数 `OPENCODE_API_KEY` でも可
+- `cachePath` でキャッシュ位置を変更可能(既定は DSH ホーム下 `cache/opencode-live/catalog.json`)
 
-`limit.output` sizes the model's capability; it is never materialized as a per-request token default. `configuredMaxTokens` stays empty by design: only explicit per-model configuration belongs there, and this plugin defines none.
-
-## Development
+## 開発
 
 ```sh
 pnpm install
-pnpm typecheck        # tsc --noEmit
-pnpm test             # vitest run (offline only; live tests skip)
-pnpm test:live        # opt-in: hits the public GET endpoints, no key, no inference
-pnpm build            # tsdown -> lib/
-pnpm pack:check       # npm pack --dry-run
+pnpm typecheck && pnpm test && pnpm build
 ```
-
-Tests mount a real Cordis context with the published DSH packages, stub the three catalog URLs, and cover the candidate states, refresh failure classes, wire-API selection, session headers, credential semantics, registry replacement, unload safety, and packaging.
-
-## Scope notes
-
-- Catalog refreshes never generate inference traffic, and a Go auth/limit error never switches the request to Zen.
-- Model `limit.context` / `limit.output` come only from a validated source; unknown capacities never become fabricated numbers. Source pricing maps into pi-ai's descriptor; absent pricing is the absence of a fact, not a $0 claim.
-- The repository commits the built `lib/` so installation needs no runtime TypeScript compilation.

package/lib/commands.js

@@ -2,7 +2,7 @@ import { PRODUCT_BY_ROUTE, ROUTE_BY_PRODUCT, describeNonReadyState } from "./nor
 //#region src/commands.ts
 const USAGE_REFRESH = "Usage: /opencode-refresh [all|zen|go]";
 const USAGE_MODELS = "Usage: /opencode-models <zen|go> [--all]";
-const USAGE_ENABLE = "Usage: /dsh-opencode — never pass the API key in the command line";
+const USAGE_ENABLE = "Usage: /dsh-opencode — report status; store the API key through the web Models page";
 /** Whether one date stamp renders as a short local time. */
 function renderTime(timestamp) {
 	if (timestamp === void 0) return "never";
@@ -130,12 +130,12 @@ function commandDefinitions(ctx, services) {
 		},
 		{
 			name: "dsh-opencode",
-			description: "Enable OpenCode Zen/Go immediately after the API key is stored securely",
+			description: "Show OpenCode status and where to store the API key",
 			recordInput: false,
 			handler: async (invocation) => {
 				if (invocation.rawInput.trim().length > 0) return {
 					kind: "error",
-					text: USAGE_ENABLE
+					text: [USAGE_ENABLE, "This command never accepts the key as text; paste it into the masked API key input on the web Models page instead."].join("\n")
 				};
 				const routes = [ROUTE_BY_PRODUCT.zen, ROUTE_BY_PRODUCT.go];
 				if (!(await Promise.all(routes.map(async (route) => {
@@ -144,9 +144,8 @@ function commandDefinitions(ctx, services) {
 					kind: "success",
 					text: [
 						"No OpenCode API key is configured yet.",
-						"Store it securely through the standard credentials input (the web Models page writes it),",
-						"then run /dsh-opencode again to refresh both catalogs and enable the routes immediately.",
-						"This command never accepts, records, or displays key values."
+						"Open Settings > Models, edit the OpenCode Zen (Live) provider, and paste the key into its masked API key input.",
+						"This command never displays key values."
 					].join("\n")
 				};
 				if (invocation.signal.aborted) return {

package/lib/transport.js

@@ -27,7 +27,7 @@ import { openAIResponsesApi } from "@earendil-works/pi-ai/api/openai-responses.l
 */
 /** The plugin's honest client identification value. */
 const PLUGIN_ID = "opencode-live";
-const PLUGIN_VERSION = "0.1.0";
+const PLUGIN_VERSION = "0.1.1";
 /** Header OpenCode Go documents for coding-agent session identification. */
 const SESSION_HEADER = "x-opencode-session";
 /** Header carrying this plugin's honest client identity alongside DSH attribution. */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dsh-opencode",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Out-of-tree DSH bundle with live dynamic OpenCode Zen / Go model catalogs",
   "private": false,
   "license": "MIT",