📦 运行手册生成器
v1.0.0从项目文件生成运维手册。扫描 Dockerfile、docker-compose.yml、systemd 单元、Makefile、package.json 及配置文件，生成...
0· 21·0 当前·0 累计
by 运行时依赖
无特殊依赖
安装命令
点击复制官方npx clawhub@latest install cm-runbook-generator
镜像加速npx clawhub@latest install cm-runbook-generator --registry https://cn.longxiaskill.com镜像同步中
技能文档
Runbook Generator 扫描项目基础设施文件，一键生成运维手册。输出结构化 Markdown 格式的常用运维步骤。
快速生成
python3 scripts/generate_runbook.py /path/to/project
输出格式
# Markdown（默认） python3 scripts/generate_runbook.py /path/to/project# JSON（结构化） python3 scripts/generate_runbook.py /path/to/project --format json
# 指定输出文件 python3 scripts/generate_runbook.py /path/to/project -o RUNBOOK.md
扫描内容
| 文件 | 提取信息 |
|---|---|
| Dockerfile | 基础镜像、暴露端口、入口、构建步骤 |
| docker-compose.yml | 服务、端口、卷、依赖、环境变量 |
| systemd units (.service) | ExecStart/Stop/Reload、依赖、重启策略 |
| Makefile | 目标（build、test、deploy、clean 等） |
| package.json | 脚本（start、build、test、dev、deploy） |
| .env / .env.example | 必需环境变量 |
| nginx.conf | 上游服务器、监听端口、location |
- Overview — 服务名、描述、技术栈
- Prerequisites — 所需工具、权限、凭据
- Environment Variables — 必需变量及说明
- Build — 项目构建方法
- Deploy — 逐步部署流程
- Start/Stop/Restart — 服务生命周期命令
- Health Check — 验证服务运行状态
- Rollback — 回滚到旧版本步骤
- Troubleshooting — 常见问题与解决方案
- Monitoring — 日志、指标、告警
- Contacts — 值班、升级路径（模板）
工作流
- 用户指向项目目录
- 脚本扫描基础设施文件
- 提取运维信息
- 生成结构化 runbook
- 呈现给用户审阅与自定义