Runme 运行手册执行器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/turn-markdown-runbooks-into-executable-parameterized-procedures-with-runme。
技能介绍
问题:运行手册容易退化成静态文档
Markdown 运行手册常用 fenced code block 承载命令,但这也带来一个常见后果:读者会复制粘贴、手动改参数、凭记忆判断顺序,文档里的命令逐渐和真实执行路径脱节。需要处理的是 drift:说明还在,可执行性已经丢失。
工作方式:把文档变成可执行流程
该技能围绕 Runme CLI 展开,核心思路是让 Markdown 中的代码块不只是“参考文本”,而是可发现的执行单元。
- 识别步骤:从 Markdown runbook 的 fenced code block 中提取命名步骤,保留命令原文与文档上下文。
- 直接运行:执行指定步骤,而不是先复制到临时终端;适合
runbooks、docs、README中已有的命令块。 - 参数化:将需要变化的值抽离为运行时参数或环境输入,避免每次手动改写命令。
- 按流程执行:按文档描述的顺序串联步骤,让
command、script或受支持运行时的片段按预期运行。
它支持常见运行时,包括 Shell/Bash、Python、Ruby、JavaScript/TypeScript、Lua、PHP、Perl 等;前提是本地具备 Runme CLI、含 fenced code block 的 Markdown runbook,以及对应的 shell 或运行时。
适用边界与注意点
适合步骤明确、可重复的运维/开发流程,例如部署检查、环境验证、故障排查手册。若流程依赖交互式登录、GUI 操作、多系统审批或无法用代码表达的状态转换,直接执行的收益会下降。
敏感凭据不应硬编码进 runbook;参数化不等于安全存储,密钥、令牌和账号仍需走 secret 管理。执行失败、回滚和审计策略仍需在文档与流程中显式定义。具体语法与运行器支持以上游文档为准。
使用场景
- 在维护部署文档时,希望直接从 Markdown runbook 执行 named steps,避免命令和说明逐渐脱节。
- 在编写 README 或内部 SOP 时,需要让代码块按参数运行,减少手动复制和临时改写。
- 在验证脚本流程时,希望从 Markdown 中提取命令并按顺序执行,确认步骤是否可复现。
- 在整理多语言运行手册时,希望 shell、Python、JavaScript 等命令块保持可执行状态。
适合人员
- 编写或维护部署、运维 runbook 的工程师,希望降低手册与实际命令不一致的风险。
- 管理 README、CONTRIBUTING 或内部 SOP 的技术作者,需要把示例代码变成可验证步骤。
- 负责自动化脚本和开发流程的开发者,想把 Markdown 中的命令块纳入可重复执行流程。
- 支持多运行时环境的团队,需要在统一文档里维护 shell、Python、JavaScript 等命令。