update-docs

A documentation updater creates project guides from package.json, which lists scripts, and .env.example, which lists required environment settings.

In plain words
What is it for?
Use it to generate contributor instructions and an operations runbook covering scripts, setup, testing, deployment, monitoring, troubleshooting, and rollback.
Why use it?
It keeps workflow and deployment instructions tied to project configuration and highlights older documents for review.

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/luohaothu/everything-codex/update-docs
Clone the repo
git clone --depth 1 https://github.com/Luohaothu/everything-codex
Per session 0 Only the description is in the session, so the agent can decide to use it. The body loads when it is invoked.
When invoked 210 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 100% copy Near-identical to another mod 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.00000 $0.00210
Opus 5 $0.00000 $0.00105
Sonnet 5 $0.00000 $0.00042
Haiku 4.5 $0.00000 $0.00021

Measured 2d ago against content hash 2bfc5259809d, 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 2d 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.

Origin

This is a copy

100% identical to update-docs — 38 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

docs/zh-CN/commands/update-docs.md · 32 lines

What it actually says

更新文档

从单一事实来源同步文档:

  1. 读取 package.json 的 scripts 部分

    • 生成脚本参考表
    • 包含来自注释的描述
  2. 读取 .env.example

    • 提取所有环境变量
    • 记录其用途和格式
  3. 生成 docs/CONTRIB.md,内容包含:

    • 开发工作流程
    • 可用脚本
    • 环境设置
    • 测试流程
  4. 生成 docs/RUNBOOK.md,内容包含:

    • 部署流程
    • 监控和警报
    • 常见问题及修复
    • 回滚流程
  5. 识别过时的文档:

    • 查找 90 天以上未修改的文档
    • 列出以供人工审查
  6. 显示差异摘要

单一事实来源:package.json 和 .env.example

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. 2d ago First seen · 32 lines · 0 tokens per session scan A 2bfc5259809d

Subscribe to this mod's changes

update-docs is a command published in the GitHub repository Luohaothu/everything-codex (24 stars, last pushed 21d ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 210 tokens. A static security scan graded it A with 0 findings. It is 100% identical to update-docs, differing in 38 lines, and is treated as a copy.