What is docs-auditor?

A read-only documentation auditor for the Shiki codebase. It compares documentation and website files with the code and produces a numbered report that points to mismatches by file and line.

Use it to check documented commands, configuration defaults, keybindings, themes, changelog entries, and operational claims against the implementation.

Documentation can become inaccurate when commands, settings, keybindings, themes, or release notes change. This finds that drift without altering the project.

How sazardev/shiki configures OpenCode

Reuse

Borrowing it

Nothing to install: this file belongs to sazardev/shiki. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file

curl -O https://raw.githubusercontent.com/sazardev/shiki/main/.opencode/agent/docs-auditor.md

Clone the repo

git clone --depth 1 https://github.com/sazardev/shiki

Made for: OpenCode.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

README.md

[![agentmods](https://agentmods.dev/badge/agents/sazardev/shiki/docs-auditor/github.svg)](https://agentmods.dev/agents/sazardev/shiki/docs-auditor)

Your own site

<a href="https://agentmods.dev/agents/sazardev/shiki/docs-auditor"><img src="https://agentmods.dev/badge/agents/sazardev/shiki/docs-auditor/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

Your own site · 80×15

<a href="https://agentmods.dev/agents/sazardev/shiki/docs-auditor"><img src="https://agentmods.dev/badge/agents/sazardev/shiki/docs-auditor.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 77 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.

When invoked 352 The whole file, excluding the scripts and references it only reads on demand.

Security scan A 0 findings. A grade says what 26 rules found in the file — not that it is safe.

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.

Model	Per session	Once invoked
Fable 5.1	$0.00077	$0.00352
Opus 5.5	$0.00031	$0.00141
Sonnet 5.5	$0.00015	$0.00070
Haiku 4.5	$0.00008	$0.00035

Measured 1mo ago against content hash 81269592a0c7, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade A, and why

docs-auditor 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 1mo ago.

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.

.opencode/agent/docs-auditor.md · 24 lines

What it actually says

You are the documentation-coherence auditor for the shiki codebase.

Load the docs-coherence skill with the skill tool and follow its checklist exactly.
Audit every class in the checklist: version coherence, CLI commands, keybindings, config schema, themes, CHANGELOG [Unreleased] → code, and CLAUDE.md operational claims.
Use rg/read to cross-reference. For config defaults, read the #[serde(default = "...")] fn body. For keybinding defaults, compare shiki-config/src/config.rs default fns against the documented key in IDEA.md / docs/documentation.html tables.
Return a single report:
- For each checklist class: one line — "OK" or a numbered list of findings.
- Each finding: severity (HIGH/MED/LOW), file:line, what the code does vs what the doc says, and the minimal fix.
- End with a one-line summary: how many total drifts found, and which class is worst. Do NOT edit or fix anything — you only report.
If a class is genuinely clean, say so. Do not pad the report.

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.

1mo ago First seen · 24 lines · 77 tokens per session scan A 81269592a0c7

Subscribe to this mod's changes

docs-auditor is an agent published in the GitHub repository sazardev/shiki (335 stars, last pushed yesterday), licensed MIT. It adds 77 tokens to every session and 352 once invoked, about $0.0003 per session on Opus 5.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-09-10.

Code review Git and workflow Productivity Writing and docs cli markdown note-taking notes

docs-auditor next to 6 agents from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
docs-auditorsazardev/shiki	Agent	335	yesterday	MIT	A	77	OpenCode
release-reviewercoo1white/cool-workflow	Agent	2	2d ago	BSD-2-Clause	A	47	Claude Code
lint-rule-handlerboykush/scraps	Agent	45	yesterday	MIT	A	53	Claude Code
pr-creatoraxiomantic/spellbook	Agent	11	2d ago	MIT	A	75	Claude Code
Exploredean0x/devflow	Agent	21	yesterday	MIT	A	71	Claude Code
git-historianrestarter/lets-workflow	Agent	17	3d ago	MIT	A	46	Claude Code
God Agent Calliope — Email Design AgentHolley-Studio/thesmos-governance	Agent	2	10d ago	none	A	44	Claude Code

shiki: Agent for OpenCode