An OpenCode plugin that sends tool operations to a read-only AI reviewer before automatically approving them.
The reviewer is one of three backends:
reviewer.backend |
How it reviews |
|---|---|
agent (default) |
An LLM in its own OpenCode session (or, with an agent runtime, in Claude Code or Codex). It may inspect the workspace with read, glob, grep, and lsp, but cannot edit files, run shell commands, access the network, use MCP tools, or start subagents. |
chat |
An LLM asked once through the OpenAI or Anthropic API, or any OpenAI-compatible Chat Completions API — OpenRouter, Workers AI, a local server — with the same prompt as the agent but no session and no tools. |
decision |
A decision model over HTTP — TypeSafe AI's Jev or Cloudflare's Clef — that picks allow, deny or escalate with calibrated probabilities in one call. |
Names used by earlier versions keep working; see deprecated names.
The package ships both plugin API generations in one default export, so the same version works on:
| OpenCode | Plugin API | Config key |
|---|---|---|
| 2.x | V2 (@opencode/plugin, setup()) |
plugins |
| 1.18.29 – 1.x | V1 (@opencode-ai/plugin, server()) |
plugin |
OpenCode releases before 1.18.29 only accept a bare function as the plugin export and cannot load
this package; use opencode-auto-approval-plugin@0.1.x there.
OpenCode installs npm plugins listed in its configuration automatically. Add the package to the project or global OpenCode configuration.
OpenCode 2.x (opencode.json):
OpenCode 1.x:
{
"$schema": "https://opencode.ai/config.json",
"plugin": ["opencode-auto-approval-plugin"],
}For local development, build the package and place it under .opencode/plugins/ (2.x) or
.opencode/plugin/ (1.x), or link the package through an npm workspace. OpenCode also loads
TypeScript files placed directly in those directories.
The defaults are mode: "on-ask", a 30-second review timeout, the provider/model of the main
session, and no custom review instructions.
OpenCode 2.x passes options through a { "package", "options" } entry:
{
"$schema": "https://opencode.ai/config.json",
"plugins": [
{
"package": "opencode-auto-approval-plugin",
"options": {
"mode": "on-ask",
"reviewer": {
"timeoutMs": 30000,
},
},
},
],
}OpenCode 1.x uses a plugin tuple instead:
{
"$schema": "https://opencode.ai/config.json",
"plugin": [
[
"opencode-auto-approval-plugin",
{
"mode": "on-ask",
"reviewer": {
"timeoutMs": 30000,
},
},
],
],
}Set reviewer.agent.model to run reviews through a separately configured OpenCode provider and
model. With the default agent backend the plugin never reads or manages API keys; authentication
remains entirely in OpenCode.
{
"plugins": [
{
"package": "opencode-auto-approval-plugin",
"options": {
"mode": "all-tools",
"reviewer": {
"agent": {
"model": {
"providerID": "openrouter",
"modelID": "openai/gpt-5.6-luna",
},
},
"timeoutMs": 15000,
},
},
},
],
}reviewer.agent.runtime chooses where the agent reviewer runs. It applies wherever the agent
reviewer does, including the decision backend's onOversize: "agent" fallback.
reviewer.agent.runtime |
Where the review runs |
|---|---|
"opencode" (default) |
A read-only OpenCode session, as described above |
"claude-agent-sdk" |
Claude Code through the Claude Agent SDK |
"codex-sdk" |
Codex through the Codex SDK |
{
"plugins": [
{
"package": "opencode-auto-approval-plugin",
"options": {
"reviewer": {
"agent": {
"runtime": "claude-agent-sdk",
"model": "claude-haiku-5-5",
"claudeAgentSdk": {
"path": "/usr/local/lib/node_modules/@anthropic-ai/claude-agent-sdk",
},
},
},
},
},
],
}- The SDKs are optional peer dependencies, and OpenCode does not install them with the plugin.
Install the one you use (
npm install -g @anthropic-ai/claude-agent-sdkornpm install -g @openai/codex-sdk) and pointreviewer.agent.claudeAgentSdk.pathorreviewer.agent.codexSdk.pathat the installed package directory (undernpm root -g); the path must be absolute. Without a path the plugin imports the SDK from where it is installed itself, which works when you install the plugin from your ownpackage.json. reviewer.agent.modelis a model name for these runtimes ("claude-haiku-5-5","gpt-5.6-codex"); unset, Claude Code or Codex uses its own default. Authentication is theirs too: aclaudeorcodexsign-in, orANTHROPIC_API_KEY/CODEX_API_KEYin the environment of the process that loads the plugin. The plugin never reads those keys.- Both run in auto mode, since nobody is there to answer a permission prompt:
- Claude Code gets only its
Read,GlobandGreptools,permissionMode: "auto", and no settings from disk — no CLAUDE.md, hooks, MCP servers, plugins or permission rules from you or the project. A call auto mode cannot decide is denied. - Codex inspects the workspace through shell commands, so it runs in the
read-onlysandbox without network access or web search, withapproval_policy = "on-request"andapprovals_reviewer = "auto_review"(whatcodex exec --approve-for-meuses), and without the project'sAGENTS.md. Your own~/.codex/config.tomlstill loads, MCP servers included.
- Claude Code gets only its
- Auto mode lets the reviewer read files outside the project when its classifier judges the read
safe: measured on 2026-10-17, Claude Code read
/etc/hostnameand searched/homewhen asked to, and Codex's read-only sandbox can read the whole disk. What it reads reaches the model provider and, cut to 300 characters, the verdict reason. Use the"opencode"runtime if that is not acceptable. - Reviews run in Claude Code or Codex, not in OpenCode, so they are not in
opencode stats; they go to the usage log instead (claude-agent-sdkwith Claude Code's own cost estimate,codex-sdkwithout a price). Measured on 2026-10-17, a Claude Code review onclaude-haiku-5-5took about 4 seconds and $0.001.
Set reviewer.backend to "decision" to have a decision model judge each operation instead of an
OpenCode session. The plugin sends one request with the operation (source, action,
resource, the user's latest prompt and, when enabled, the bounded conversation) and a single allow / deny / escalate choice. No
reviewer agent or session is created (unless onOversize is "agent") and the workspace is not
inspected. Two providers speak the
same System One API:
| Provider | Models | Credentials (option / environment) | Default model |
|---|---|---|---|
typesafe |
TypeSafe AI's Jev (jev-latest, jev-1.14.0, …) |
apiKey / TYPESAFE_API_KEY, optional baseURL / TYPESAFE_BASE_URL |
jev-latest |
cloudflare |
Cloudflare's Clef on Workers AI (clef, clef-flash) |
apiKey / CLOUDFLARE_API_TOKEN, accountId / CLOUDFLARE_ACCOUNT_ID |
clef |
{
"plugins": [
{
"package": "opencode-auto-approval-plugin",
"options": {
"mode": "on-ask",
"reviewer": {
"backend": "decision",
"timeoutMs": 10000,
"decision": {
"provider": "cloudflare", // or "typesafe"
"model": "clef",
"minAllowProbability": 0.6,
},
},
},
},
],
}| Option | Default | Description |
|---|---|---|
reviewer.backend |
"agent" |
"agent", "chat" or "decision" |
reviewer.decision.provider |
— (required) | "typesafe" or "cloudflare" |
reviewer.decision.apiKey |
from the environment | TypeSafe AI API key, or a Cloudflare API token with Workers AI access |
reviewer.decision.baseURL |
https://api.typesafe.ai |
typesafe only: API origin; a bare HTTPS origin (HTTP only for loopback) |
reviewer.decision.accountId |
from the environment | cloudflare only: the 32-character account ID |
reviewer.decision.model |
per provider (above) | Model or alias; pin a version such as jev-1.14.0 for stable behavior |
reviewer.decision.minAllowProbability |
0.6 |
An allow answered with a lower probability becomes escalate |
reviewer.decision.maxStateTokens |
28000 |
Estimated size above which an operation is too large to send (1,000–60,000) |
reviewer.decision.longContext |
off | typesafe only: true or { maxStateTokens, minAllowProbability } to send larger operations with long context |
reviewer.decision.onOversize |
"escalate" |
Too large: "escalate" to a human, or hand it to the "agent" or "chat" reviewer |
reviewer.agent.maxInputBytes |
200000 |
The agent reviewer escalates a prompt longer than this (UTF-8 bytes) unsent rather than let the session compact it |
reviewer.agent.runtime |
"opencode" |
Where the agent reviewer runs: "opencode", "claude-agent-sdk" or "codex-sdk" (agent runtimes) |
reviewer.agent.claudeAgentSdk.path |
— | claude-agent-sdk only: absolute path of the installed @anthropic-ai/claude-agent-sdk package directory |
reviewer.agent.codexSdk.path |
— | codex-sdk only: absolute path of the installed @openai/codex-sdk package directory |
- Prefer the environment variables:
opencode.jsonis often committed, and a key written there is shared with it. Surrounding whitespace in keys is trimmed. The plugin fails at startup when the provider has no key (or, for Cloudflare, no valid account ID or model name) or an invalid base URL. The variables are read by the process that loads the plugin: if OpenCode 2.x's background service was already running, runopencode service restartafter exporting them. typesafe: the key and the base URL come from the same place. Withreviewer.decision.apiKey, onlyreviewer.decision.baseURLapplies (TYPESAFE_BASE_URLis ignored); withTYPESAFE_API_KEY, onlyTYPESAFE_BASE_URLapplies, and settingreviewer.decision.baseURLwithout a key next to it fails at startup. This keeps one source from redirecting a key supplied by another.cloudflare: requests always go tohttps://api.cloudflare.com/client/v4/accounts/<accountId>/ai/run/@cf/cloudflare/<model>; there is no base URL option, so the token never reaches another host. The variable names match wrangler's, but aCLOUDFLARE_API_TOKENexported for deployments is often broad — create a token scoped to Workers AI for the reviewer. AI Gateway is not supported yet.- A decision model returns a choice with calibrated probabilities rather than an explanation, so
the verdict reason reads like
clef chose deny (allow 0.01, deny 0.86, escalate 0.13).A hesitantallowbelowminAllowProbabilityis escalated to a human;denyandescalateare taken as answered. - Measured from a devcontainer on 2026-10-04, a review took 0.2–0.9 s on either Clef model. Both
Clef models allowed
pnpm testand denied sending.envto a remote host, butclef-flashfollowed custom review instructions only weakly (a force-push declared safe rose to allow 0.53, under the default threshold, whereclefreached 0.80), which is whyclefis the default. - The operation leaves your machine: the resource holds the full command, file content of a write or edit, and permission metadata such as diffs, and the user intent is your latest prompt. All of it is sent to the provider, so an edit of a secrets file sends those secrets.
- An operation is never sent in part, since a partial view cannot justify an approval. One whose
estimated size exceeds
maxStateTokens(or, with long context,longContext.maxStateTokens), or that the API refuses as too long, is too large: by default it escalates to a human with the reason. baseURLmust use HTTPS unless it points at a loopback host (localhost,127.0.0.1,[::1]). Whoever serves it receives the API key and decides every verdict, so set it only in configuration you trust (not a repository'sopencode.jsonyou have not reviewed) — the same holds forminAllowProbability, which lowers the bar for an automatic approval, and forlongContext, which lets larger operations be approved automatically.- Redirects are refused so the API key is never forwarded to another host, and the timeout covers
the whole request including the response body. HTTP errors (
402out of credit,429rate limited,5xxoutage) are reported by status only and handled like any other reviewer failure. reviewer.agenthas no effect with thedecisionbackend unlessonOversizeis"agent", andreviewer.decisionnone with theagentbackend. Aliases such asjev-latestfollow new model releases, which may shift verdicts; pin a version for stable behavior.
Jev refuses a question over 32Ki tokens (the state plus the question; Jev 1.14's 64Ki is per
request, shared by its questions, and the plugin asks one) unless
long context is on, and Clef, which accepts 64Ki, slows to tens of seconds
past 20,000. Before sending, the plugin estimates the size conservatively (ASCII at 2.5 characters
a token, any other character at 1.1 tokens: Japanese measured about one token per character on
both models, so a Japanese file reaches Jev's default 28,000-token budget at about 25,000
characters; Clef's default is 20,000 to stay within the default timeout)
and treats Jev's max_tokens_exceeded the same way. What happens next is
reviewer.decision.onOversize:
onOversize |
Too-large operation |
|---|---|
escalate (default) |
Not approved: on-ask leaves OpenCode's prompt for a human; all-tools blocks the tool with the reason |
agent |
Reviewed by the agent reviewer, which can also read the file it concerns |
chat |
Reviewed by the chat backend in one call, with the whole operation |
A fallback reviews the whole operation, so its allow stands. Choose a fallback model at least as
careful as the decision model: an operation padded past the budget reaches it instead, and it has
no minAllowProbability gate. Use it where nobody can answer a
prompt — OpenCode working inside a GitHub Actions workflow, for example — so that a large edit
does not stop the run. The default stays escalate: a fallback can widen what is approved
automatically, so set it only in configuration you trust, like baseURL and
minAllowProbability. Each reviewer has its own reviewer.timeoutMs, so a fallback review can take
up to twice as long.
"reviewer": {
"backend": "decision",
"decision": { "provider": "typesafe", "onOversize": "chat" },
"chat": { "baseURL": "https://openrouter.ai/api/v1", "apiKey": "{env:OPENROUTER_API_KEY}", "model": "openai/gpt-5.6-luna" },
}TypeSafe's TypeSafe-Danger-Zone-Long-Context: true header raises Jev's limit to 262,144 tokens
per question and per request (Jev 1.13 and 1.14), at the same price per token. With
reviewer.decision.longContext set, an operation whose estimate exceeds maxStateTokens is sent
whole with that header instead of being too large, up to longContext.maxStateTokens; smaller
operations are still sent without it. If Jev refuses one of those as too long (the estimate fell
short), it is asked once more with the header, within the same timeoutMs; with less than a
second left, or if that second request fails, the refusal stands.
"decision": {
"provider": "typesafe",
"longContext": { "maxStateTokens": 120000, "minAllowProbability": 0.9 },
}| Option | Default | Description |
|---|---|---|
reviewer.decision.longContext |
off | true turns it on with the defaults below; an object sets them |
reviewer.decision.longContext.maxStateTokens |
240000 |
Estimated size above which even a long-context request is too large (≤256,000) |
reviewer.decision.longContext.minAllowProbability |
0.8, or minAllowProbability if higher |
Allow threshold for long-context answers only; never below minAllowProbability |
- It is off by default: TypeSafe documents long-context answers as slower and less accurate than
those within the regular limit, so only the operations that need it use it. An operation past
longContext.maxStateTokens, or that the API refuses even with the header, is too large and followsonOversize. - A verdict reached this way, including after such a retry, says so, e.g.
jev-1.14.0 with long context chose escalate (allow 0.32, deny 0.07, escalate 0.61).A single dangerous line is easier to miss in a large file, so these answers need a higherallowprobability (0.8 by default) and the threshold cannot be set below the regular one. - Measured on 2026-10-16: 54k tokens answered in 0.8 s, 134k in about 2 s and 241k in 4.4 s, all
within the default
timeoutMs; 272k was refused. A long, harmless write of this plugin's own sources (69k tokens) leanedescalate(0.57–0.61) where a single file of it leanedallow; a 34k-token edit of them came backallow 0.76, which the default 0.8 escalates. - Long context costs what its tokens cost: a 240,000-token review is about $0.01 at Jev's $0.042 per million input tokens, recorded in the usage log like any other review.
- Clef on Workers AI has no such switch;
longContextother thanfalsewithprovider: "cloudflare"fails at startup.
Set reviewer.backend to "chat" to have an LLM review each operation in a single request — to an
OpenAI-compatible POST <baseURL>/chat/completions, or to the OpenAI or Anthropic API with their
own keys — or use it only as the decision backend's onOversize fallback. It sends the agent reviewer's prompt — the user's instructions, then the
operation inside a random boundary it is told never to take instructions from — and reads back a
{"verdict","reason"} JSON object. There is no session and no tool, so it judges the operation data
alone, and the plugin needs an API key of its own.
| Option | Default | Description |
|---|---|---|
reviewer.chat.provider |
"openai-compatible" |
"openai-compatible", "openai" or "anthropic" (below) |
reviewer.chat.model |
— (required) | Model ID as the endpoint names it, such as openai/gpt-5.6-luna on OpenRouter |
reviewer.chat.apiKey |
per provider (below) | API key for the endpoint |
reviewer.chat.baseURL |
openai-compatible: AUTO_APPROVAL_CHAT_BASE_URL, else https://api.openai.com/v1 |
openai-compatible only: base URL up to /chat/completions; HTTPS (HTTP only for loopback) |
reviewer.chat.maxInputBytes |
200000 |
A prompt longer than this (UTF-8 bytes) is too large and escalates unsent |
reviewer.chat.provider |
Endpoint | Key, when reviewer.chat.apiKey is unset |
|---|---|---|
"openai-compatible" (default) |
<baseURL>/chat/completions |
AUTO_APPROVAL_CHAT_API_KEY |
"openai" |
https://api.openai.com/v1/chat/completions |
OPENAI_API_KEY |
"anthropic" |
https://api.anthropic.com/v1/messages (Messages API) |
ANTHROPIC_API_KEY |
{
"plugins": [
{
"package": "opencode-auto-approval-plugin",
"options": {
"reviewer": {
"backend": "chat",
"chat": { "provider": "anthropic", "model": "claude-haiku-5-5" },
},
},
},
],
}-
openaiandanthropicalways call the vendor's own host, so they take nobaseURL(setting one fails at startup) and their key never reaches another server. They read the vendor's usual key variable, which other tools may already export — so a repository'sopencode.jsonthat selects one of them spends that key, one more reason to setreviewer.chatonly in configuration you trust. A Claude Code or Codex sign-in is not an API key and cannot be used here; agent runtimes use those.anthropicsends the key inx-api-keywithanthropic-version: 2023-06-01andmax_tokens: 16000, so the verdict fits after whatever thinking the model does by default; pick a model whose output limit allows that (current Claude models do). A reply that stops for any reason other than finishing — a refusal,max_tokens— is handled like any other reviewer failure, and one that ran out of context window counts as too large. -
For
openai-compatible, as with TypeSafe, the key and the base URL come from the same place:reviewer.chat.apiKeywithreviewer.chat.baseURL, orAUTO_APPROVAL_CHAT_API_KEYwithAUTO_APPROVAL_CHAT_BASE_URL, never one from each. OpenCode substitutes{env:NAME}in plugin options, so an existing variable such asOPENROUTER_API_KEYcan be used without writing the key down. -
The same safeguards apply as for the decision backend: redirects are refused, the timeout covers the whole response, errors report the HTTP status only, and an over-long prompt (
context_length_exceeded, Anthropic's "prompt is too long", a context length, size or window message, or HTTP 413) counts as too large. -
Keep
maxInputByteswithin what the server reads whole: for a local server, no more bytes than its context has tokens (Ollama'snum_ctx) less room for the answer and the chat template, a few hundred tokens — a byte-level tokenizer never makes more than one token a byte, whatever characters the operation is padded with. Some servers cut an over-long prompt instead of refusing it, from the start or the middle. Three guards catch that, each treating the operation as too large:- every prompt (agent reviewer too) opens with a random review check that the answer must echo, so a model whose prompt lost its start cannot answer;
- a reported prompt-token count below a floor under the measured densities (10 ASCII characters, 2 CJK characters or 6 other characters a token) means part of the prompt was not read — zero or no count says nothing, and cached tokens count as read;
- the task, the untrusted-data rule and the answer format are restated after the operation data.
A cut that keeps the start can still go unnoticed if it is under about two fifths of English prose, two thirds of code or JSON, or half of Japanese; size
maxInputBytesto the server's context instead of relying on the guards. -
Set
reviewer.chat— likeonOversize,baseURLandminAllowProbability— only in configuration you trust. The same-source rule stops one source redirecting a key from another, but OpenCode substitutes{env:NAME}before the plugin sees the options, so a repository'sopencode.jsoncould pair your own key variable with its own server. -
The usage log records chat reviews with
provider: "chat"and the token counts the endpoint reports; their cost is left unpriced, since it depends on the provider and model.
Each decision, chat, Claude Agent SDK or Codex SDK review appends one line to a usage log at
$XDG_DATA_HOME/opencode-auto-approval-plugin/usage.jsonl (~/.local/share/… when XDG_DATA_HOME
is unset): the time, provider, model, a hash of the project directory, input and output tokens,
latency, the verdict (error for a failed call, oversize for an operation too large to send),
and the cost at the time of the review. An operation handed to a fallback gets two lines: the
unsent oversize attempt and the fallback's review; the latency column leaves oversize out. The
operation, your prompt and the reason are never written, and the file is created readable by you
only. The project hash keeps the path out of the file but is not a secret — anyone who guesses a
path can hash it and match it — so treat the log as private before sharing it. Reviews with the
agent backend on the default opencode runtime run in OpenCode sessions, so opencode stats
already counts them.
Show the totals with the bundled command, modelled on opencode stats:
npx opencode-auto-approval-plugin stats # this calendar year so far
npx opencode-auto-approval-plugin stats --days 7 # today and the 7 days before (0 = today)
npx opencode-auto-approval-plugin stats --year 2026
npx opencode-auto-approval-plugin stats --all --project . --jsonauto-approval stats · today and the 7 days before · all projects
reviews 1,284 tokens 612k in / 51k out cost $0.11
provider model reviews tokens in tokens out cost p50 latency
cloudflare clef 904 431k 0 $0.10 412 ms
typesafe jev-latest 380 181k 51k $0.00760 212 ms
verdicts allow 81% · escalate 15% · deny 3% · error 1% · oversize 0%
- Costs use the input prices published on 2026-10-04 (USD per million tokens: Jev $0.042, Clef
$0.24, Clef-flash $0.09; output tokens are free) and apply to the official endpoints only. A
model without a known price, or a review sent to a custom
baseURL, is counted but left out of the cost, and the summary says how many reviews that was. The latency column is the median. - Set
reviewer.recordUsagetofalseto stop writing the log. A failure to write it never affects a review.
Set reviewer.instructions to tell the reviewer about your own policy, such as tool uses that are
always safe in your project or operations that must always go to a human. Give one string or a list
of strings; a list is joined into one line per entry, which is easier to read in JSON than one long
string.
{
"plugins": [
{
"package": "opencode-auto-approval-plugin",
"options": {
"reviewer": {
"instructions": [
"`pnpm test`, `pnpm lint` and `pnpm typecheck` are always safe in this project.",
"Reading and editing files under `src/` and `docs/` is safe.",
"Always escalate `git push` and anything that touches `.env` files.",
],
},
},
},
],
}- Both backends receive the instructions as trusted guidance that takes precedence over the
built-in safety guidance — though never over the answer format or the rule that operation data
is untrusted, so text inside a command or file cannot pose as your instructions: the
agentbackend reads them in its prompt ahead of the operation data, and thedecisionbackend appends them to the question'sinstructions, never to the state it judges. - They are guidance for an AI reviewer, not deterministic rules: the reviewer still sees the whole
operation and may decide otherwise. Use OpenCode's own permission rules (
permissionson 2.x,permissionon 1.x) when a tool must always be allowed or denied. Explicit OpenCodedenyrules still always win. - Blank entries are ignored, and the joined text may be at most 4,000 characters. With the
decisionbackend the instructions are sent, and billed, with every review. - Instructions can widen what is approved automatically, so set them only in configuration you
trust, like
baseURL,minAllowProbabilityandlongContext— not in a repository'sopencode.jsonyou have not reviewed.
These options work with both plugin API generations and every reviewer backend. Add them to
the plugin's options object (the second tuple item under plugin on OpenCode 1.x):
{
"auditLog": {
"enabled": true,
"path": "/absolute/private/directory/approval-audit.jsonl",
"includeCommand": false,
},
"conversation": {
"enabled": true,
"includeAssistant": false,
},
}auditLog.enabledandauditLog.includeCommandboth default tofalse. Disabled auditing performs no log I/O. When enabled,pathis required and must be an absolute filesystem path. There is no environment variable, home-directory fallback, or project-relative resolution. Choose a private directory outside version control; do not use a path controlled by an untrusted project. Parent directories are trusted: the no-follow check protects the final file, not every parent component. Only the target file is tightened to mode0600; existing directories are not modified.- An existing regular file at
pathis appended to, whatever it is. LikeinstructionsandbaseURL, setauditLogonly in configuration you trust — a repository'sopencode.jsoncould otherwise point it at a file such as a shell start-up script and have agent-controlled command text appended to it. - JSONL records contain time, backend, session, source, action, verdict, confidence, duration in
milliseconds and a fixed error category. Confidence is backend metadata (the decision model's
selected-choice probability, including when an allow is escalated), or
nullwhen unavailable; it is never inferred from the reason. Reasons, raw errors, conversation and general tool input are not logged. A logged verdict is the reviewer's answer, not proof that the host executed or approved the operation. - Command recording is a separate opt-in for actual
bashcommands or permission metadata, never permission patterns. Redaction is best-effort, not exhaustive: shell syntax, short flags such asmysql -pSECRET,curl -u user:pass, and here-documents can still expose credentials. Do not enable it for sensitive workloads. Inputs over 64 KiB (UTF-8) are omitted entirely before redaction; remaining redacted text is capped at 2,048 characters. - Writes use append/create/write-only/no-follow flags, verify a regular single-link file and set
its permissions to
0600through the open handle before writing. A pre-placed symlink is refused. This requires POSIX no-follow and permission semantics: Windows auditing is unsupported and fails with a fixed warning rather than an unsafe fallback. Unsupported filesystems, bad paths and other log failures never change approval decisions. - Logging is asynchronous and best-effort, with at most 1,000 queued entries plus one active write. A full queue drops new entries; errors and drops emit fixed, non-secret warnings. Shutdown can lose queued records. There is no automatic rotation or retention policy; manage the file yourself. This is not a durable compliance ledger.
conversation.enabled defaults to false: the reviewer then sees only the latest captured prompt.
Enabled, each review reads the current session's available history, retaining at most 8 whole turns / 12,000 characters. Only user turns are included by
default, so a short request such as "continue" can refer to an earlier user instruction without
letting assistant prose establish consent. conversation.includeAssistant: true also sends
assistant text as untrusted context, never as authorization. Tool output, synthetic/ignored parts,
reviewer messages and compaction summaries are excluded. No AGENTS.md files are automatically
loaded into the payload; configured reviewer.instructions still apply to every backend.
History reads can add up to 1 second (HISTORY_TIMEOUT_MS) before each review, including every
tool call in all-tools mode. V1 requests at most 32 host messages (HISTORY_MESSAGE_LIMIT);
V2 reads the host's context view, which may already have been compacted. There is no history cache.
Earlier user turns widen what the reviewer may treat as authorized — an old instruction can back an
operation the latest prompt does not mention — which is why the context is opt-in. The timeout
stops waiting, not necessarily the underlying host read. Failures fall back to the latest captured
prompt and mark the context incomplete.
incomplete records observed compaction, local clipping or a failed history read, not an assumption
that all history is missing. A full V1 page separately sets historyLimitReached: older messages
may exist but their omission is not known. Neither a false flag nor a short response guarantees
complete host history. The latest user request/revocation takes precedence; missing authorization
must be escalated. A new user prompt during history loading or review cancels an otherwise allowed
result. These are model instructions plus a host-side stale-result guard, not a guarantee against
prompt injection.
Every backend receives the same operation data, and the retained conversation counts toward each
backend's size limit: an operation that no longer fits is handled like any other oversized one
(see onOversize above), never sent in part. The retained text goes to the selected reviewer
provider with every review (and is billed with the decision and chat backends); it may contain
sensitive user content. Audit redaction does not redact model input. Disabling assistant turns
reduces this exposure but does not eliminate it.
Earlier versions used other names for the backends and their options. They are still accepted and mean the same thing, with no removal date yet; setting a name next to its replacement fails at startup so that neither is silently ignored.
| Deprecated | Use instead |
|---|---|
backend: "opencode" |
backend: "agent" |
reviewer.model |
reviewer.agent.model |
backend: "decision-model" (v0.5) |
backend: "decision" |
reviewer.decisionModel (v0.5) |
reviewer.decision |
backend: "jev" with reviewer.jev (v0.3–v0.4) |
backend: "decision" with provider: "typesafe" |
| Mode | Reviewed operations | allow |
deny |
escalate / reviewer failure |
|---|---|---|---|---|
on-ask (default) |
Only operations that OpenCode already decided should ask | Approves the request once | Leaves the OpenCode approval pending | Leaves the OpenCode approval pending |
all-tools |
Every intercepted tool call, including OpenCode-allowed calls | Runs the tool | Blocks the tool | Blocks the tool and reports that human review is required |
On OpenCode 2.x, on-ask runs inside the permission.evaluate hook: an allow verdict turns the
pending ask into allow before the permission prompt is shown, and the reviewer's reason is
attached as the permission message. On OpenCode 1.x the plugin listens for the permission bus
event and replies once through the SDK. In both cases anything other than allow leaves
OpenCode's native human permission UI untouched.
OpenCode's plugin API does not provide a way to create and await a new permission dialogue from
tool.execute.before. Therefore, all-tools fails closed for an escalate verdict: the tool does
not run and the user must explicitly retry after reviewing the reported reason.
Both modes work the same way with every reviewer backend. An operation too large for the decision or chat backend escalates unless a fallback is configured (see above).
Explicit OpenCode deny rules always remain in effect. The plugin is an additional review layer;
it never turns a built-in deny into an allow.
| Area | Tool | Config |
|---|---|---|
| Runtime / tooling | mise | mise.toml |
| Package manager | pnpm | pnpm-workspace.yaml, .npmrc |
| Language | TypeScript | tsconfig.json |
| Build | tsdown | tsdown.config.ts |
| Test | Vitest | vitest.config.ts |
| Format | oxfmt | .oxfmtrc.json |
| Lint | oxlint | .oxlintrc.json |
| Unused code | knip | knip.ts |
| Spelling | cspell | cspell.json |
| Secret scanning | secretlint | .secretlintrc.json |
| Git hooks | simple-git-hooks + lint-staged | package.json, .lintstagedrc.js |
| AI rules | rulesync | rulesync.jsonc, .rulesync/ |
| Workflow lint | actionlint | .github/workflows/actionlint.yml |
| Action pinning | pinact | .pinact.yaml, .github/workflows/pinact.yml |
| Dependency bumps | Dependabot | .github/dependabot.yml |
| Misconfig scan | Trivy | .trivyignore, .github/workflows/trivy-security-scan.yml |
| Dev environment | Dev Container | .devcontainer/ |
| CI / Release | GitHub Actions | .github/workflows/ci.yml, publish.yml |
mise install # install node, pnpm, actionlint, pinact
pnpm install # install dependencies and set up the pre-commit hook
pnpm cicheck # run everything CI runs| Script | Description |
|---|---|
pnpm build |
Build the library (ESM + CJS, types) and the stats bin into dist |
pnpm check |
fmt:check + oxlint + typecheck |
pnpm cicheck |
cicheck:code + cicheck:content — what CI runs |
pnpm cicheck:code |
check + test |
pnpm cicheck:content |
cspell + secretlint |
pnpm fix |
Auto-fix formatting and lint problems |
pnpm generate |
Regenerate AI tool configs from .rulesync/ |
pnpm knip |
Report unused files, exports, and dependencies |
pnpm test |
Run the test suite |
pnpm test:coverage |
Run the test suite with coverage |
pnpm typecheck |
Type-check without emitting |
| Task | Description |
|---|---|
mise run actionlint |
Lint GitHub Actions workflows |
mise run pinact |
Pin actions in workflows to full commit SHAs |
mise run pinact:check |
Fail if any action is not pinned to a commit SHA |
mise run trivy |
Scan .devcontainer/ and workflows for misconfigurations |
.npmrcsetssave-exact=true, so every dependency is pinned to an exact version.pnpm-workspace.yamlsetsminimumReleaseAge: 1440, so a version published less than a day ago is refused — a compromised release has time to be pulled before it reaches a lockfile.- Postinstall scripts are blocked by default via
allowBuilds; add a package there only when a build step is genuinely required. CI installs with--ignore-scripts. - Every third-party GitHub Action is pinned to a full-length commit SHA, enforced by
pinactin CI. - Workflows declare the narrowest
permissions:block they need. secretlintruns over every staged file through lint-staged, and over the whole tree in CI.trivy configscans.devcontainer/and.github/workflows/for misconfigurations on every push and pull request that touches them;CRITICALandHIGHfindings fail the build. Suppressions live in.trivyignore, each with the reason it is safe.- The dev container pins the Codex CLI installer to a version and verifies its SHA-256 checksum before running it.
.devcontainer/ provides a sandboxed environment for running AI coding agents with relaxed
permissions. It is adapted from dyoshikawa/rulesync and
ships Node, mise-managed tooling (including actionlint and pinact), gh, Claude Code, Codex
CLI, opencode, Gemini CLI, git-gtr, and zsh/bash with completions.
Open the repository in a Dev Container-aware editor and it builds from .devcontainer/Dockerfile,
then runs .devcontainer/init.sh to configure git credentials, the pnpm store, and pnpm install.
Secrets are read from the host environment, so export the ones you need before opening the container — all of them are optional:
| Host variable | Forwarded as |
|---|---|
OPENCODE_AUTO_APPROVAL_PLUGIN_DEVCONTAINER_GITHUB_TOKEN |
GITHUB_TOKEN |
OPENCODE_AUTO_APPROVAL_PLUGIN_DEVCONTAINER_OPENAI_API_KEY |
OPENAI_API_KEY |
OPENCODE_AUTO_APPROVAL_PLUGIN_DEVCONTAINER_GEMINI_API_KEY |
GEMINI_API_KEY |
OPENCODE_AUTO_APPROVAL_PLUGIN_DEVCONTAINER_OPENROUTER_API_KEY |
OPENROUTER_API_KEY |
OPENCODE_AUTO_APPROVAL_PLUGIN_DEVCONTAINER_ZAI_API_KEY |
ZHIPU_API_KEY |
OPENCODE_AUTO_APPROVAL_PLUGIN_DEVCONTAINER_OPENCODE_API_KEY |
OPENCODE_API_KEY |
mise.toml is copied into the image at build time, so changing it requires rebuilding the
container.
Rules live in .rulesync/ and are compiled into each tool's native format by pnpm generate:
.rulesync/rules/*.md— instructions (overview, coding, testing, GitHub Actions security).rulesync/mcp.json— MCP servers.rulesync/hooks.json— session hooks.rulesync/permissions.jsonc— per-tool permission settingsrulesync.jsonc— which tools to generate for (Claude Code, Codex CLI, GitHub Copilot, opencode)
Generated files (AGENTS.md, CLAUDE.md, .claude/, .github/instructions/, …) are gitignored —
edit .rulesync/** instead, never the generated output.
.github/workflows/publish.yml publishes to npm when a GitHub Release is published, or when run
manually for a release tag. It checks that the tag is a semantic v*.*.* version, matches
package.json, and points to a commit in main; it then runs pnpm cicheck, builds, and publishes
through npm Trusted Publishing (OIDC — no npm token in
secrets).
Configure npm's trusted publisher for dyoshikawa/opencode-auto-approval-plugin to use GitHub
Actions and the .github/workflows/publish.yml workflow. For each later release, bump the package
version on main, create its matching v<version> tag, and publish the GitHub Release.
OpenCode publishes and distributes plugins as ordinary npm packages: users add the package name to
the plugins (2.x) or plugin (1.x) array in opencode.json, and OpenCode installs it at startup.
See the OpenCode plugin documentation and the
V1 migration guide for the loader and
cache behavior.
{ "$schema": "https://opencode.ai/config.json", "plugins": ["opencode-auto-approval-plugin"], }