@op1/goals

Long-running goal support for OpenCode.

@op1/goals adds a Codex-style /goal workflow to OpenCode: set a durable objective for a session, expose goal state to the model through tools, account token/time usage, and continue active goals while the session is idle.

Features

• /goal summary for the current session goal
• /goal <objective> to create or replace a goal
• /goal edit, /goal pause, /goal resume, and /goal clear
• get_goal, create_goal, and update_goal model tools
• Project-local persistence in .opencode/goals/<sessionID>.json
• Token budget accounting from OpenCode step events
• Guarded continuation prompts that require evidence before marking a goal complete
• Codex-style states: active, paused, budget_limited, and complete

Install

Register the npm plugin from opencode.json or opencode.jsonc:

{
  "$schema": "https://opencode.ai/config.json",
  "plugin": ["@op1/goals"]
}

OpenCode installs npm plugins automatically with Bun at startup. You do not need to add the plugin as a project dependency. For local development, you can also load a JavaScript or TypeScript plugin file under .opencode/plugins/ or ~/.config/opencode/plugins/.

Usage

Set a goal:

/goal finish the checkout refactor and verify the regression tests pass

Show the current goal:

/goal

Edit or control it:

/goal edit
/goal pause
/goal resume
/goal clear

The model can also create a goal with an explicit token budget through create_goal when the user asks for one. The slash command keeps Codex parity and treats text such as /goal --tokens 98.5K improve coverage as objective text, not special syntax.

Goal Lifecycle

Active goals are injected into the model context as untrusted user-provided objective data. When a turn finishes and the session becomes idle, the plugin can send a continuation prompt so work continues toward the same objective. If a token budget is reached, the goal is marked budget_limited and the next prompt asks the model to wrap up rather than start new substantive work.

OpenCode's local continuation cap uses Codex's existing paused state so a capped goal is visible and can be resumed with /goal resume.

The model can only mark a goal complete through update_goal after auditing that the objective is actually achieved. Pause, resume, and budget-limited status changes are controlled by the user or system.

Development

bun install
bun test
bun run typecheck
bun run build

Publishing

The package is configured for public npm publishing. Set NPM_TOKEN in your shell or replace the placeholder in .npmrc, then run:

bun run build
npm publish --access public