update-docs

update-docs is a command for coding agents from xu-xiang/everything-claude-code-zh. It costs 10 tokens per session (425 once invoked), scanned A, original, MIT.

A command for updating project documentation after code changes, including README files, API references, guides, and code comments.

In plain words
What is it for?
Use it after changing features, public functions, API endpoints, configuration, installation steps, or behavior that documentation describes.
Why use it?
It helps keep instructions and examples aligned with the implementation instead of leaving users with outdated or incorrect information.

Command

Part of the everything-claude-code-zh plugin — 17 skills, 26 commands, 13 agents shipped together

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/xu-xiang/everything-claude-code-zh/update-docs
Clone the repo
git clone --depth 1 https://github.com/xu-xiang/everything-claude-code-zh

Or install everything-claude-code-zh, the plugin that ships this one along with the rest of its 17 skills, 26 commands, 13 agents.

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.

agentmods badge for update-docs

README.md
[![agentmods](https://agentmods.dev/badge/commands/xu-xiang/everything-claude-code-zh/update-docs.svg)](https://agentmods.dev/commands/xu-xiang/everything-claude-code-zh/update-docs)
Your own site
<a href="https://agentmods.dev/commands/xu-xiang/everything-claude-code-zh/update-docs"><img src="https://agentmods.dev/badge/commands/xu-xiang/everything-claude-code-zh/update-docs.svg" alt="Measured on agentmods" height="20"></a>
Per session 10 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 425 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.00010 $0.00425
Opus 5 $0.00005 $0.00212
Sonnet 5 $0.00002 $0.00085
Haiku 4.5 $0.00001 $0.00042

Measured 4d ago against content hash 84da2bbdee8a, 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 4d 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/commands/update-docs.md · 68 lines

What it actually says

更新文档命令 (Update Docs Command)

根据最近的更改更新文档:$ARGUMENTS

你的任务

  1. 识别已更改的代码 - git diff --name-only
  2. 查找相关文档 - README、API 文档、指南
  3. 更新文档 - 保持与代码同步
  4. 验证准确性 - 确保文档与实现一致

文档类型

README.md

  • 安装说明
  • 快速入门指南
  • 功能概览
  • 配置选项

API 文档 (API Documentation)

  • 端点(Endpoint)描述
  • 请求/响应格式
  • 身份验证详情
  • 错误代码

代码注释

  • 公共 API 的 JSDoc
  • 复杂逻辑解释
  • TODO/FIXME 清理

指南 (Guides)

  • 操作教程 (How-to tutorials)
  • 架构决策记录 (ADRs)
  • 故障排除指南

更新自检清单

  • README 反映了当前功能
  • API 文档与端点匹配
  • 已为更改的函数更新 JSDoc
  • 示例运行正常
  • 链接有效
  • 版本号已更新

文档质量

优质文档

  • 准确且最新
  • 清晰且简洁
  • 包含可运行的示例
  • 覆盖边缘情况

避免

  • 过时的信息
  • 缺失参数
  • 错误的示例
  • 含糊不清的语言

重要提示:文档应与代码更改同步更新,而不是事后补课。

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. 4d ago First seen · 68 lines · 10 tokens per session scan A 84da2bbdee8a

Subscribe to this mod's changes

update-docs is a command published in the GitHub repository xu-xiang/everything-claude-code-zh (1,927 stars, last pushed 6mo ago), licensed MIT. It adds 10 tokens to every session and 425 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-30.