DSH VERTICAL KIT · 运维手册检查 / runbook 检查

运维手册检查清单

它决定一件事:这份手册是否给了读者前置、步骤、退路、确认方式,以及危险命令旁的警告。

检查规则

规则判定
prereq-missing没有前置条件段 → error
steps-missing没有编号步骤 → error
destructive-unwarned编号步骤里有危险命令但同行没写注意/备份/不可逆 → error,报行号
rollback-missing没有回滚段 → error
verify-missing没有验证段 → error
steps-thin / shell-unspecified步骤数少于下限 / 没说用哪个 shell → warn

用法

npx ops-runbook-check runbook.md --json
npx ops-runbook-check runbook.md --min-steps 5

真实输入输出

输入
# 发布手册

1. 停服务
2. rm -rf /data
3. 起服务
$ ops-runbook-check runbook-sample.md
error prereq-missing 第0行 没有前置条件段(认得:## 前置条件、需要先…、Prerequisites)——没有前置的手册让人在半路发现缺权限
error rollback-missing 第0行 没有回滚段(认得:## 回滚、回滚:…、Rollback)——出问题时读者没有退路
error verify-missing 第0行 没有验证段(认得:## 验证、确认:…、Verify)——没写怎么确认,读者不知道做完了没有
error destructive-unwarned 第4行 第 4 行含 rm -rf 但没有在同一行写明注意/备份/不可逆——这条命令在压力下会被照抄
warn shell-unspecified 第0行 没有说明用什么 shell(认得:bash、zsh、PowerShell)——同一条命令在不同 shell 里行为不同
fail: 3 steps, 4 errors, 1 warnings

出口码:1。输出为真实 CLI 运行的逐字结果,由测试与工具保持同步。

出口码:0 干净、1 有发现、2 用法或读文件错误。--json 输出机器可读结果。DSH 内同样的函数在 POST /ops-runbook-check/api({"text":"…"} 或 {"path":"…"}),面板与 CI 调同一实现。

这是清单,不是专业人士。合同检查不是法律意见,发票检查不判税务合规,listing 检查不判商业价值。每条发现都是文本里可判定的结构缺陷,带行号。
认的九类危险命令:rm -rf、DROP、TRUNCATE、DELETE FROM、kubectl delete、terraform apply/destroy、git push --force、docker rm/prune、mkfs/dd。只验手册形状,不验步骤是否正确:第 3 步是不是错命令、回滚路径本身是不是早坏了、验证是不是因为错误原因通过——这些要 game day 才知道。 · dsh-vertical-kit · 通用检查(哈希/引用/结构/表格/数字)在 dsh-verify-kit