update-docs

A documentation-sync command that builds reference material from files treated as the codebase’s source of truth.

In plain words
What is it for?
Use it to document available commands, environment variables, API endpoints, setup files, and public programming interfaces.
Why use it?
It reduces the risk that documentation becomes outdated when scripts, environment settings, API routes, infrastructure, or public code exports change.

Command

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add commands/zhmxiaowo/opencode-simple/update-docs
Clone the repo
git clone --depth 1 https://github.com/zhmxiaowo/opencode-simple
Per session 15 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 696 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00015 $0.00696
Opus 5 $0.00008 $0.00348
Sonnet 5 $0.00003 $0.00139
Haiku 4.5 $0.00002 $0.00070

Measured yesterday against content hash c337f9909f86, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

update-docs scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured yesterday.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

Copies of this mod

1 near-identical copy found in the catalogue:

.opencode/commands/update-docs.md · 90 lines

How it starts

The opening of the file, as written. The whole thing — 90 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Update Documentation

Sync documentation with the codebase, generating from source-of-truth files.

Step 1: Identify Sources of Truth

Source Generates
package.json scripts Available commands reference
.env.example Environment variable documentation
openapi.yaml / route files API endpoint reference
Source code exports Public API documentation
Dockerfile / docker-compose.yml Infrastructure setup docs

Step 2: Generate Script Reference

  1. Read package.json (or Makefile, Cargo.toml, pyproject.toml)
  2. Extract all scripts/commands with their descriptions
  3. Generate a reference table:
| Command | Description |
|---------|-------------|
| `npm run dev` | Start development server with hot reload |
| `npm run build` | Production build with type checking |
| `npm test` | Run test suite with coverage |

Step 3: Generate Environment Documentation

  1. Read .env.example (or .env.template, .env.sample)
  2. Extract all variables with their purposes
  3. Categorize as required vs optional
  4. Document expected format and valid values
| Variable | Required | Description | Example |
|----------|----------|-------------|---------|
| `DATABASE_URL` | Yes | PostgreSQL connection string | `postgres://user:pass@host:5432/db` |
| `LOG_LEVEL` | No | Logging verbosity (default: info) | `debug`, `info`, `warn`, `error` |

Step 4: Update Contributing Guide

Generate or update docs/CONTRIBUTING.md with:

  • Development environment setup (prerequisites, install steps)
  • Available scripts and their purposes
  • Testing procedures (how to run, how to write new tests)
  • Code style enforcement (linter, formatter, pre-commit hooks)
  • PR submission checklist

Step 5: Update Runbook

Generate or update docs/RUNBOOK.md with:

  • Deployment procedures (step-by-step)
  • Health check endpoints and monitoring
  • Common issues and their fixes
  • Rollback procedures
  • Alerting and escalation paths

Read the full file on GitHub · 90 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. yesterday First seen · 90 lines · 15 tokens per session scan A c337f9909f86

Subscribe to this mod's changes

update-docs is a command published in the GitHub repository zhmxiaowo/opencode-simple (2 stars, last pushed 5mo ago), licensed MIT. It adds 15 tokens to every session and 696 once invoked, about $0.0001 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.