opencode-ghost 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 opencode-ghost contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,135 @@
+# opencode-ghost
+
+[![CI](https://github.com/ozandogrultan/opencode-ghost/actions/workflows/ci.yml/badge.svg)](https://github.com/ozandogrultan/opencode-ghost/actions/workflows/ci.yml)
+
+**Next-prompt suggestions** for the [opencode](https://opencode.ai) TUI, in the
+style of Claude Code: after each turn a small model reads the recent
+conversation and writes the message you would most likely send next, shown as
+dimmed ghost text you accept with <kbd>Tab</kbd> (or <kbd>→</kbd>).
+
+> Why "ghost": it writes the line you were about to type, then waits for you to
+> take it.
+
+## What it does
+
+- **Suggests your next message.** On `session.idle` it debounces, builds a short
+  transcript of the recent turns, and asks a model (your `small_model` by
+  default) for one line that sounds like you.
+- **Ghost text, `Tab` to accept.** The suggestion renders under the prompt;
+  `Tab` or `→` drops it into the input so you can edit and send.
+- **`/suggest` toggles it.** State is stored in the plugin KV.
+
+## Requirements
+
+- [opencode](https://opencode.ai) (TUI plugins; tested on 1.18.x).
+- A cheap/fast model for `small_model` — or set `model` explicitly.
+
+## Install
+
+### From this repo (recommended)
+
+```sh
+git clone https://github.com/ozandogrultan/opencode-ghost.git
+cd opencode-ghost
+./install.sh
+```
+
+Then **restart opencode** — plugins are loaded at startup only. `install.sh`
+copies the plugin into `<config>/plugins/opencode-ghost/` and registers it in
+`<config>/tui.json` (backing the file up first).
+
+### Manually
+
+Add the checkout to your `tui.json` (global at `~/.config/opencode/tui.json`, or
+a project's `.opencode/`). Plugins are loaded as source:
+
+```jsonc
+{
+  "$schema": "https://opencode.ai/tui.json",
+  "plugin": ["/absolute/path/to/opencode-ghost/src/tui.tsx"],
+}
+```
+
+### From npm
+
+```sh
+opencode plugin opencode-ghost       # current project
+opencode plugin -g opencode-ghost    # global
+```
+
+Restart opencode after changing `tui.json`.
+
+## Options
+
+Pass an options object as the second element of the plugin tuple:
+
+```jsonc
+{
+  "plugin": [
+    ["opencode-ghost", {
+      "enabled": true,
+      "model": "anthropic/claude-haiku-4-5",
+      "acceptKeys": ["tab", "right"],
+      "maxChars": 120,
+      "idleDelayMs": 500,
+      "recentMessages": 10
+    }]
+  ]
+}
+```
+
+| Option           | Type       | Default               | Notes                                                                 |
+| ---------------- | ---------- | --------------------- | --------------------------------------------------------------------- |
+| `enabled`        | `boolean`  | `true`                | Initial state; `/suggest` toggles it at runtime (persisted).          |
+| `model`          | `string`   | session `small_model` | `provider/model`. Falls back to `small_model`, then the session model. |
+| `acceptKeys`     | `string[]` | `["tab", "right"]`    | Key names as reported by the terminal (`tab`, `right`, ...).          |
+| `maxChars`       | `number`   | `120`                 | Maximum suggestion length.                                            |
+| `idleDelayMs`    | `number`   | `500`                 | Debounce after a turn finishes before generating.                     |
+| `recentMessages` | `number`   | `10`                  | How many recent messages feed the suggestion prompt.                  |
+| `system`         | `string`   | built-in              | Override the system prompt sent to the suggestion model.              |
+
+## Commands
+
+- `/suggest` — toggle suggestions on/off (state is stored in the plugin KV).
+
+When enabling, a suggestion is generated immediately for the current session.
+
+## How it works
+
+- Listens for `session.idle`, debounces, and builds a short transcript from the
+  session's recent messages.
+- Asks a model (your `small_model` by default) for one short next user message,
+  in a throwaway hidden session with tools disabled; the session is deleted
+  immediately afterwards.
+- Renders the result through the `session_prompt` host slot into the prompt's
+  `hint` row, and accepts it into the input via the prompt ref.
+
+## Caveats
+
+- **Owns the `session_prompt` slot.** opencode only exposes the prompt ref
+  through that slot, so this plugin replaces the default prompt component. It
+  forwards `on_submit`, `ref`, `right`, `visible`, and `disabled`, and cannot be
+  combined with another plugin that also renders `session_prompt`.
+- **`hint` row.** While a suggestion is showing it occupies the prompt's hint
+  row, so the working-directory label is hidden until you accept or type.
+- **Cost.** One small-model call per turn while enabled. Point `model` at a
+  cheap or free model.
+- **`acceptKeys`.** `tab` is also opencode's agent-cycle key; this plugin only
+  captures it while a suggestion is visible and the input is empty.
+- Suggestions fail silently (no ghost text) if the model is unavailable, the
+  provider is out of balance, or the reply is `NONE`.
+
+## Development
+
+```sh
+bun install
+bun run typecheck
+bun test
+```
+
+No build step: like other opencode TUI plugins, the package ships TSX source and
+opencode's runtime transpiles it.
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,55 @@
+{
+  "name": "opencode-ghost",
+  "version": "0.1.0",
+  "description": "Claude Code-style next-prompt suggestions in the opencode TUI, shown as dimmed ghost text and accepted with Tab. An opencode plugin.",
+  "type": "module",
+  "license": "MIT",
+  "author": "Ozan Dogrultan",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ozandogrultan/opencode-ghost.git"
+  },
+  "homepage": "https://github.com/ozandogrultan/opencode-ghost#readme",
+  "bugs": {
+    "url": "https://github.com/ozandogrultan/opencode-ghost/issues"
+  },
+  "exports": {
+    "./tui": "./src/tui.tsx"
+  },
+  "files": [
+    "src",
+    "LICENSE",
+    "README.md"
+  ],
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "test": "bun test"
+  },
+  "engines": {
+    "opencode": ">=1.18.0"
+  },
+  "keywords": [
+    "opencode",
+    "opencode-plugin",
+    "tui",
+    "ghost-text",
+    "autosuggest",
+    "prompt",
+    "suggestion"
+  ],
+  "dependencies": {
+    "solid-js": "^1.9.12"
+  },
+  "peerDependencies": {
+    "@opencode-ai/plugin": "*",
+    "solid-js": "*"
+  },
+  "devDependencies": {
+    "@opencode-ai/plugin": "1.18.25",
+    "@opentui/core": "0.4.5",
+    "@opentui/keymap": "0.4.5",
+    "@opentui/solid": "0.4.5",
+    "@types/node": "24.12.2",
+    "typescript": "5.8.2"
+  }
+}

package/src/options.ts

@@ -0,0 +1,60 @@
+export type PromptSuggestOptions = {
+  enabled?: boolean
+  model?: string
+  acceptKeys?: string[]
+  maxChars?: number
+  idleDelayMs?: number
+  recentMessages?: number
+  system?: string
+}
+
+export type ResolvedOptions = {
+  enabled: boolean
+  model: string | undefined
+  acceptKeys: string[]
+  maxChars: number
+  idleDelayMs: number
+  recentMessages: number
+  system: string
+}
+
+export const DEFAULT_SYSTEM = [
+  "You write the next message that the USER of a coding agent would send.",
+  "It must sound like the user, not the assistant: short and direct.",
+  "Never restate or summarize the assistant's reply.",
+  'If the assistant proposed a next step, a brief affirmation such as "Yes." or "Go ahead." is best.',
+  "If the assistant asked a question, answer it briefly.",
+  "Output one line, plain text only: no markdown, no quotes, no backticks, no preamble.",
+  "If no reply makes sense, output exactly: NONE",
+].join("\n")
+
+const DEFAULTS = {
+  enabled: true,
+  acceptKeys: ["tab", "right"],
+  maxChars: 120,
+  idleDelayMs: 500,
+  recentMessages: 10,
+}
+
+export function resolveOptions(options: PromptSuggestOptions | undefined): ResolvedOptions {
+  const input = options ?? {}
+  const maxChars = input.maxChars
+  const idleDelayMs = input.idleDelayMs
+  const recentMessages = input.recentMessages
+  return {
+    enabled: input.enabled ?? DEFAULTS.enabled,
+    model: typeof input.model === "string" && input.model.trim() ? input.model.trim() : undefined,
+    acceptKeys:
+      Array.isArray(input.acceptKeys) && input.acceptKeys.length > 0
+        ? input.acceptKeys
+        : [...DEFAULTS.acceptKeys],
+    maxChars: typeof maxChars === "number" && maxChars > 0 ? maxChars : DEFAULTS.maxChars,
+    idleDelayMs:
+      typeof idleDelayMs === "number" && idleDelayMs >= 0 ? idleDelayMs : DEFAULTS.idleDelayMs,
+    recentMessages:
+      typeof recentMessages === "number" && recentMessages > 0
+        ? recentMessages
+        : DEFAULTS.recentMessages,
+    system: typeof input.system === "string" && input.system.trim() ? input.system : DEFAULT_SYSTEM,
+  }
+}

package/src/text.ts

@@ -0,0 +1,34 @@
+export function parseModel(
+  spec: string | undefined,
+): { providerID: string; modelID: string } | undefined {
+  if (!spec) return undefined
+  const index = spec.indexOf("/")
+  if (index <= 0 || index === spec.length - 1) return undefined
+  return { providerID: spec.slice(0, index), modelID: spec.slice(index + 1) }
+}
+
+export function collapse(text: string): string {
+  return text.replace(/\s+/g, " ").trim()
+}
+
+export function clip(text: string, max: number): string {
+  const value = collapse(text)
+  if (value.length <= max) return value
+  return value.slice(0, max - 1).trimEnd() + "…"
+}
+
+export function normalize(raw: string, maxChars: number): string | undefined {
+  const first = raw
+    .split(/\r?\n/)
+    .map((line) => line.trim())
+    .find((line) => line.length > 0)
+  if (!first) return undefined
+  const cleaned = first
+    .replace(/^[`"'*\-_#\s]+/, "")
+    .replace(/[`"'*_#\s]+$/, "")
+    .replace(/[*`_]+/g, "")
+    .trim()
+  if (!cleaned || /^none\.?$/i.test(cleaned)) return undefined
+  if (cleaned.length <= maxChars) return cleaned
+  return cleaned.slice(0, maxChars - 1).trimEnd() + "…"
+}

package/src/tui.tsx

@@ -0,0 +1,274 @@
+/** @jsxImportSource @opentui/solid */
+import type { TuiPlugin, TuiPromptRef } from "@opencode-ai/plugin/tui"
+import { createSignal } from "solid-js"
+import { resolveOptions, type PromptSuggestOptions } from "./options"
+import { clip, normalize, parseModel } from "./text"
+
+const HIDDEN_TITLE = "ghost-hidden"
+const MAX_MESSAGE_CHARS = 800
+const MAX_TRANSCRIPT_CHARS = 6000
+const ENABLED_KEY = "ghost.enabled"
+const MODEL_KEY = "ghost.model"
+
+const HIDDEN_TOOLS = {
+  bash: false,
+  edit: false,
+  write: false,
+  read: false,
+  grep: false,
+  glob: false,
+  list: false,
+  task: false,
+  todowrite: false,
+  todoread: false,
+  webfetch: false,
+  websearch: false,
+  patch: false,
+  multiedit: false,
+  question: false,
+  skill: false,
+  lsp: false,
+}
+
+const tui: TuiPlugin = async (api, rawOptions) => {
+  const opts = resolveOptions(rawOptions as PromptSuggestOptions | undefined)
+  const [ghost, setGhost] = createSignal<{ sessionID: string; text: string } | undefined>()
+  let promptRef: TuiPromptRef | undefined
+  let timer: ReturnType<typeof setTimeout> | undefined
+  let generating = false
+  let acceptLayer: (() => void) | undefined
+
+  const currentSessionID = () => {
+    const route = api.route.current
+    if (route.name !== "session") return undefined
+    const id = route.params?.sessionID
+    return typeof id === "string" ? id : undefined
+  }
+
+  const currentInput = () => promptRef?.current.input ?? ""
+
+  const isEnabled = () => {
+    try {
+      return api.kv.get<boolean>(ENABLED_KEY, opts.enabled) !== false
+    } catch {
+      return opts.enabled
+    }
+  }
+
+  const setEnabled = (value: boolean) => {
+    try {
+      api.kv.set(ENABLED_KEY, value)
+    } catch {
+      // ignore
+    }
+  }
+
+  const resolveModel = () => {
+    try {
+      const override = api.kv.get<string>(MODEL_KEY)
+      if (typeof override === "string" && override.trim()) return parseModel(override.trim())
+    } catch {
+      // ignore
+    }
+    return (
+      parseModel(opts.model) ??
+      parseModel(api.state.config.small_model) ??
+      parseModel(api.state.config.model)
+    )
+  }
+
+  const buildTranscript = (sessionID: string) => {
+    const messages = api.state.session.messages(sessionID)
+    const lines: string[] = []
+    for (const message of messages.slice(-opts.recentMessages)) {
+      if (message.role !== "user" && message.role !== "assistant") continue
+      const text = api.state
+        .part(message.id)
+        .filter((part) => part.type === "text")
+        .map((part) => (part.type === "text" ? part.text : ""))
+        .join(" ")
+      if (!text.trim()) continue
+      lines.push(
+        `${message.role === "user" ? "User" : "Assistant"}: ${clip(text, MAX_MESSAGE_CHARS)}`,
+      )
+    }
+    if (lines.length === 0) return ""
+    return `${lines.join("\n").slice(-MAX_TRANSCRIPT_CHARS)}\n\nTask: write the user's next message.`
+  }
+
+  const generate = async (sessionID: string): Promise<string | undefined> => {
+    const transcript = buildTranscript(sessionID)
+    if (!transcript) return undefined
+
+    const created = await api.client.session.create({ title: HIDDEN_TITLE })
+    const tempID = created.data?.id
+    if (!tempID) return undefined
+
+    try {
+      const result = await api.client.session.prompt({
+        sessionID: tempID,
+        system: opts.system,
+        tools: { ...HIDDEN_TOOLS },
+        model: resolveModel(),
+        parts: [{ type: "text", text: transcript }],
+      })
+      const parts = result.data?.parts ?? []
+      const raw = parts
+        .filter((part) => part.type === "text")
+        .map((part) => (part.type === "text" ? part.text : ""))
+        .join("\n")
+      return normalize(raw, opts.maxChars)
+    } finally {
+      await api.client.session.delete({ sessionID: tempID }).catch(() => undefined)
+    }
+  }
+
+  const enableAccept = () => {
+    if (acceptLayer) return
+    acceptLayer = api.keymap.registerLayer({
+      mode: "base",
+      priority: 100,
+      bindings: opts.acceptKeys.map((key) => ({
+        key,
+        desc: "Accept suggested prompt",
+        preventDefault: true,
+        cmd: () => {
+          accept()
+          return true
+        },
+      })),
+    })
+  }
+
+  const disableAccept = () => {
+    acceptLayer?.()
+    acceptLayer = undefined
+  }
+
+  const showGhost = (value: { sessionID: string; text: string } | undefined) => {
+    setGhost(value)
+    if (value) enableAccept()
+    else disableAccept()
+  }
+
+  const run = async (sessionID: string) => {
+    if (generating) return
+    if (!isEnabled()) return
+    if (currentSessionID() !== sessionID) return
+    if (currentInput().trim()) return
+    generating = true
+    try {
+      const text = await generate(sessionID)
+      if (currentSessionID() !== sessionID) return
+      if (currentInput().trim()) return
+      if (!isEnabled()) return
+      showGhost(text ? { sessionID, text } : undefined)
+    } catch {
+      // ignore background failures
+    } finally {
+      generating = false
+    }
+  }
+
+  const schedule = (sessionID: string) => {
+    if (!isEnabled()) return
+    if (timer) clearTimeout(timer)
+    timer = setTimeout(() => void run(sessionID), opts.idleDelayMs)
+  }
+
+  const accept = () => {
+    const current = ghost()
+    if (!current) return false
+    if (currentSessionID() !== current.sessionID) {
+      showGhost(undefined)
+      return false
+    }
+    if (!promptRef) return false
+    if (currentInput().trim()) return false
+    promptRef.set({ input: current.text, parts: [] })
+    promptRef.focus()
+    showGhost(undefined)
+    return true
+  }
+
+  const offIdle = api.event.on("session.idle", (event) => {
+    const id = event.properties?.sessionID
+    if (!id) return
+    schedule(id)
+  })
+
+  api.slots.register({
+    order: 60,
+    slots: {
+      session_prompt(_ctx, props) {
+        const suggestion = () => {
+          const current = ghost()
+          return current && current.sessionID === props.session_id ? current.text : ""
+        }
+        return (
+          <api.ui.Prompt
+            sessionID={props.session_id}
+            visible={props.visible}
+            disabled={props.disabled}
+            showPlaceholder={false}
+            hint={
+              suggestion() ? (
+                <box marginLeft={1}>
+                  <text fg={api.theme.current.textMuted}>{suggestion()}</text>
+                </box>
+              ) : undefined
+            }
+            right={<api.ui.Slot name="session_prompt_right" session_id={props.session_id} />}
+            onSubmit={() => {
+              showGhost(undefined)
+              props.on_submit?.()
+            }}
+            ref={(ref) => {
+              promptRef = ref
+              props.ref?.(ref)
+            }}
+          />
+        )
+      },
+    },
+  })
+
+  api.command?.register(() => [
+    {
+      title: `Prompt suggestions: ${isEnabled() ? "on" : "off"}`,
+      value: "ghost",
+      description: "Toggle the suggested next prompt",
+      category: "Prompt",
+      slash: { name: "suggest" },
+      onSelect: async () => {
+        const next = !isEnabled()
+        setEnabled(next)
+        if (!next) {
+          showGhost(undefined)
+          api.ui.toast({ title: "Prompt suggestions", message: "Off" })
+          return
+        }
+        api.ui.toast({ title: "Prompt suggestions", message: "On" })
+        const sessionID = currentSessionID()
+        if (!sessionID) return
+        try {
+          const text = await generate(sessionID)
+          showGhost(text ? { sessionID, text } : undefined)
+        } catch {
+          // ignore
+        }
+      },
+    },
+  ])
+
+  api.lifecycle.onDispose(() => {
+    if (timer) clearTimeout(timer)
+    offIdle()
+    disableAccept()
+  })
+}
+
+export default {
+  id: "ghost",
+  tui,
+}