@heretek-ai/opencode-harness (v1.0.5)
Plugin-first OpenCode v2 in-process harness targeting Muse 1.3 (opencode-go/muse-spark-1.3-contributor): zero-patch built-in tool interceptors (edit, read, write, patch, shell, subagent), cross-file relative import & named-export contract verification, Dual Direct + Code Mode (tools.harness.*) tool registration, 4-hex FNV-1a hash-anchored file edits, AST structural codemods, PageRank repository mapping, lexer-aware symbol reference & call-site search, blast-radius & circular-dependency auditing, all-or-nothing atomic transactions, warm-cached post-mutation diagnostics, stack-frame <fault-context> localization, head+tail anti-truncation output compaction, KV-cache-safe context budgeting, role/path/contract/taint permission guards, a doom-loop circuit breaker, and DOM geometry auditing.
Single-session in-process plugin only — no HTTP servers, daemons, or multi-agent DAG schedulers. See AGENTS.md for the scope contract and docs/prompts/SPEC.md for the full build specification.
Install & Build
bun install
bun run check # tsc --noEmit — must exit 0
bun test # full unit suite (189 tests across 11 suites) — must exit 0
make check # bun run check + bun test
make accept # wave-1 through wave-6 acceptance scripts
Plugin Usage
1. Native OpenCode V2 PluginModule (default export)
When loaded by OpenCode V2's plugin system (packages/core/src/plugin/module.ts), @heretek-ai/opencode-harness exports a native PromiseContext plugin definition (default: { id: "@heretek-ai/opencode-harness", setup(ctx) }) that automatically wires all 12 direct tools (options: { codemode: false }), pinned Code Mode companion tools (tools.harness.*), all zero-patch tool/session/compaction/shell/permission interceptors, recommended MCP servers (lsp-mcp-server, fallow-mcp), and /doctor + /audit slash commands:
import OpenCodeV2Plugin from "@heretek-ai/opencode-harness";
// Called automatically by OpenCode V2's PluginModule.load:
const doctorReport = OpenCodeV2Plugin.setup(promiseContext);
2. Explicit Programmatic Activation (activate / createHarnessPlugin)
import { createHarnessPlugin } from "@heretek-ai/opencode-harness";
const plugin = createHarnessPlugin({
rootDir: "/home/user/project",
guardConfig: {
lockedContractGlobs: ["**/contracts/**", "**/schemas/*.schema.json"],
},
contextBudgetTokens: 4000,
taskMd: "# Current task\n...",
planMd: "# Plan\n...",
lessons: [{ id: "l-1", trigger: "anchor drift", lesson: "re-read before retry" }],
});
plugin.activate(context);
Zero-Patch Plugin Interceptors (Plugin Over Patching)
| Interceptor | Hook Surface | What It Fixes in OpenCode V2 (opencode-2) Without Upstream Patching |
|---|---|---|
EditTool Auto-Repair & Near-Miss Recovery |
tool.hook("execute.before" | "execute.after") |
Strips accidental ReadTool (12: ) or file_hash_read (12#a3f2| ) line prefixes from oldString/newString and resolves leading indentation drift in-place before EditTool runs. On failure, appends a 4-hex FNV-1a <near-miss-anchor> slice so Muse 1.3 can immediately issue file_hash_edit. |
PatchTool Envelope & Hunk Prefix Auto-Repair |
tool.hook("execute.before") |
Wraps bare *** (Update|Add|Delete) File: hunks in *** Begin Patch / *** End Patch markers and strips accidental 12: / 12#a3f2| prefixes inside hunk lines before Patch.parse runs. |
| Cross-File Import & Export Contract Verifier | tool.hook("execute.after") (collectFileDiagnostics) |
Resolves relative TS/JS imports (.js -> .ts/.tsx, /index.ts) and verifies every named import against the target module's exports (including export * from re-exports), catching hallucinated imports or broken paths in <10ms. |
| Pre/Post-Edit Contract Impact Analyzer | tool.hook("execute.before" | "execute.after") |
Diffs exported symbol signatures (extractOutline) before and after every file mutation; when an exported signature changes, appends <contract-impact> listing downstream importers, symbol callers, and affected test files. |
| Head+Tail Anti-Truncation Output Compactor | tool.hook("execute.after") |
Compacts middle lines of oversized tool outputs (>1,400 lines or >38 KiB) into a 35% head + 65% tail window before ToolOutput.truncate (2,000 lines / 50 KiB) runs, ensuring error tails and appended <diagnostics> / <fault-context> / <circuit-breaker> blocks are never sliced off. |
Dual Direct + Code Mode (tools.harness.*) Bridge |
tool.transform (editor.namespace) |
Registers all 12 tools with options: { codemode: false } for direct calls AND registers pinned tools.harness.* companions (codemode: true, pinned: true) so Code Mode (execute({ code })) scripts can batch-query repo_map, blast_radius, symbol_references, file_outline, and file_hash_read. |
ReadTool Fuzzy Path Resolver & Outline Header |
tool.hook("execute.before" | "execute.after") |
Auto-resolves unambiguous moved/mis-pathed filenames in the workspace before ReadTool fails, and appends <file-outline-summary> on windowed reads of large files. |
ShellTool Non-Zero Exit <fault-context> Localizer & Env Hardener |
shell.hook("create.before"), tool.hook("execute.after") |
Injects CI=1, GIT_TERMINAL_PROMPT=0, and PAGER=cat; detects non-zero exit codes inside ShellTool's status: "completed" (result.output.exit !== 0) and appends 4-hex FNV-1a hash-anchored <fault-context> stack frames. |
SubagentTool SHA-256 <mutation-receipt> Verifier |
tool.hook("execute.before" | "execute.after") |
Captures pre/post workspace SHA-256 digests around subagent calls, appending <mutation-receipt> and running syntax/import diagnostics on every file touched by the subagent. |
MetaPlugin (meta.txt) Calibration & Compaction Decontaminator |
session.hook("context" | "generate" | "compaction") |
Replaces meta.txt's subagent over-trigger in-place, appends static Muse 1.3 tool guidance to event.system[0], sanitizes <recent-context> [Assistant tool call]: pseudo-transcripts, and strips coding-agent, # Your Model, and worktree prompt/tool contamination from compaction requests. |
Multi-Hop Root promptCacheKey Affinity |
session.hook("model.request") |
Tracks childSessionID -> parentSessionID across unlimited subagent/fork hops and rewrites x-session-affinity / X-Session-Id headers to the true root session ID. |
Tools (HARNESS_TOOL_NAMES & EXTENDED_HARNESS_TOOL_NAMES)
| Tool | Module | Behaviour |
|---|---|---|
file_hash_read |
src/editors/hashline-tools.ts |
Reads a file as <lineNo>#<4-hex-hash>| <content> lines; 1-based offset/limit windows. |
file_hash_edit |
src/editors/hashline-tools.ts |
Applies hash-anchored hunks; anchors resolve across ±25 shifted lines; any mismatch fails closed with no disk write. |
ast_structural_search |
src/editors/ast-codemod.ts |
Structural search with $VAR / $$$ARGS metavariables (@ast-grep/napi + deterministic fallback). |
ast_structural_rewrite |
src/editors/ast-codemod.ts |
Substitutes metavariable bindings into the rewrite template; writes only when at least one match is replaced. |
ui_geometry_audit |
src/ui-auditor/dom-auditor.ts |
Pure DOM geometry audit (overflow-x, <24px targets, descender-clip risk, sibling collision, baseline jitter) or headless Chromium + WCAG 2.2 axe audit. |
repo_map |
src/repomap/repomap.ts |
Lexer-aware TS/JS/Py/Go/Rust dependency graph with PageRank centrality ranking and exported symbol summaries. |
blast_radius |
src/repomap/repomap.ts |
Computes direct importers, transitive dependents, symbol callers, and affected test files for any target file/symbol. |
file_outline |
src/repomap/repomap.ts |
Extracts exported functions, classes, interfaces, types, and structs with 1-based line numbers without reading full file bodies. |
symbol_references |
src/repomap/repomap.ts |
Lexer-verified definitions, imports, exports, and call sites of a symbol across the workspace with 1-based line numbers and 4-hex FNV-1a anchors. |
verify_scoped |
src/verify/verifier.ts |
Runs blast-radius-scoped incremental verification (typecheck, lint, and affected tests) with structured file:line:col extraction. |
architecture_audit |
src/verify/architecture-advisor.ts |
Detects circular module dependencies (Tarjan SCC), oversized god-files (>650 lines), empty catch blocks, and high-arity functions. |
checkpoint_create / checkpoint_rollback |
src/transactions/edit-transaction.ts |
Creates and restores in-memory file checkpoints prior to multi-step refactors. |