A command that creates developer documentation from project settings and environment examples. It uses package.json, a file that defines project scripts, and .env.example, a template listing configuration variables.

Use it to generate contributor and operations guides, document available scripts and environment variables, identify old documentation, and show a summary of changes.

It reduces the work of keeping setup, testing, deployment, and troubleshooting instructions aligned with the project.

update-docs — Command for Claude Code by zhukunpenglinyutong/ai-max

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.

Clone the repo

git clone --depth 1 https://github.com/zhukunpenglinyutong/ai-max

Made for: Claude Code.

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/commands/zhukunpenglinyutong/ai-max/update-docs/github.svg)](https://agentmods.dev/commands/zhukunpenglinyutong/ai-max/update-docs)

Your own site

<a href="https://agentmods.dev/commands/zhukunpenglinyutong/ai-max/update-docs"><img src="https://agentmods.dev/badge/commands/zhukunpenglinyutong/ai-max/update-docs/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/commands/zhukunpenglinyutong/ai-max/update-docs"><img src="https://agentmods.dev/badge/commands/zhukunpenglinyutong/ai-max/update-docs.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

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 203 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.00000	$0.00203
Opus 5.5	$0.00000	$0.00081
Sonnet 5.5	$0.00000	$0.00041
Haiku 4.5	$0.00000	$0.00020

Measured 2mo ago against content hash 05abdfa2ee19, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 2mo 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.

commands/update-docs.md · 32 lines

What it actually says

更新文档

从唯一数据源同步文档：

读取 package.json 的 scripts 部分
- 生成脚本参考表
- 包含注释中的描述
读取 .env.example
- 提取所有环境变量
- 记录用途和格式
生成 docs/CONTRIB.md，包含：
- 开发工作流程
- 可用脚本
- 环境设置
- 测试流程
生成 docs/RUNBOOK.md，包含：
- 部署流程
- 监控和告警
- 常见问题及修复方法
- 回滚流程
识别过时文档：
- 查找超过 90 天未修改的文档
- 列出供人工审查
显示差异摘要

唯一数据源：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.

2mo ago First seen · 32 lines · 0 tokens per session scan A 05abdfa2ee19

Subscribe to this mod's changes

update-docs is a command published in the GitHub repository zhukunpenglinyutong/ai-max (334 stars, last pushed 8mo ago), licensed MIT. It costs nothing until one of its globs matches a file; then it loads 203 tokens. 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.

Writing and docs

update-docs next to 6 commands from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
update-docszhukunpenglinyutong/ai-max	Command	334	8mo ago	MIT	A	0	Claude Code
checklistgithub/spec-kit	Command	148k	yesterday	MIT	A	13	Claude Code
clarifygithub/spec-kit	Command	148k	yesterday	MIT	A	27	Claude Code
specifygithub/spec-kit	Command	148k	yesterday	MIT	A	13	Claude Code
analyzegithub/spec-kit	Command	148k	yesterday	MIT	A	26	Claude Code
convergegithub/spec-kit	Command	148k	yesterday	MIT	A	35	Claude Code
implementgithub/spec-kit	Command	148k	yesterday	MIT	A	14	Claude Code