使用手册 · 效率

Runbooks

将日常运维操作编排为基于 OpenClaw-native 的版本化自动化流程——支持手动触发、定时调度、Webhook 和事件驱动。

/runbooks

概述#

Runbooks 允许你将重复性的运维操作——Agent 重启、配置发布、批量审批、健康修复——编纂为版本化的自动化定义。无需每次手动执行相同步骤,只需定义一次,由 ClawButler 负责编排、重试和审计日志记录。

现在的 Runbook 主路径收敛到 OpenClaw-native。typed steps、审批门、校验与 evidence 让运维自动化回到主治理链路,而不再把多个 runtime backend 当作同权的一等路径来宣传。

前置条件#

前置条件
  • 至少配置并同步了一个连接器(参见「连接器」)

使用反馈#

创建 Runbook 并触发执行后,你将看到:

  • -Runbook 注册表,列出所有定义及其名称、版本、后端和触发类型
  • -每个 Runbook 的版本历史,展示各修订版之间的变更
  • -执行时间线,包含逐步进度、时间戳和输出日志
  • -运行状态指示器(待处理、运行中、已完成、失败、已取消)

Web 端操作#

从侧边栏「效率」分组进入 Runbooks 页面。

Runbook 注册表

注册表展示组织中所有 Runbook 定义。每张卡片显示名称、当前版本、执行路径和触发类型。点击任意 Runbook 可查看其定义、版本历史和历史执行记录。使用「创建」按钮定义新的 Runbook,包含 typed steps、触发配置,以及审批或校验控制。

触发配置

每个 Runbook 支持一种或多种触发类型。手动触发可从 Web 界面或 CLI 按需启动执行。定时触发按 cron 表达式运行(例如每天 UTC 09:00)。Webhook 触发提供唯一 URL,供外部系统 POST 调用。事件触发在匹配的审计事件发生时自动触发(例如 Agent 健康降级)。

执行视图

Runbook 运行时,执行视图实时展示事件时间线。每个步骤显示为一行,包含名称、状态(待处理、运行中、已完成、失败)、起止时间戳和输出内容。默认按顺序执行步骤。如果某步骤失败,Runbook 将停止并标记为失败,除非配置了重试策略。

审批与验证

Runbook 步骤可以要求人工审批后才继续执行(TCC 第 04 步)。当步骤标记为需要审批时,执行将暂停并创建审批请求。指定的审批人可以查看步骤上下文后批准或拒绝。最后一步完成后,你可以将执行标记为已验证,确认结果符合预期。

CLI 端操作#

列出组织中所有 Runbook

Terminal
$ ap runbook list

查看 Runbook 定义、步骤和版本历史

Terminal
$ ap runbook show <id>

触发 Runbook 的一次新执行

Terminal
$ ap runbook trigger <id>

查看 Runbook 的执行历史和运行详情

Terminal
$ ap runbook runs <id>

常见问题#

Q:Runbook 某个步骤执行失败会怎样?
A:执行将在失败的步骤处停止,运行状态变为「失败」。你可以检查步骤输出来排查问题,然后重新触发 Runbook。失败前已完成的步骤不会自动回滚——每个步骤应设计为幂等操作。
Q:可以取消正在运行的 Runbook 吗?
A:可以。在执行视图中点击「取消」按钮。当前正在运行的步骤会执行完毕,但后续步骤不再派发。运行状态变为「已取消」。
Q:如何选择后端?
A:默认推荐路径是 openclaw_native。当步骤需要直接调用 OpenClaw 网关、进入审批链和 evidence 链时,应走这条路径。底层可能仍保留少量兼容性 shim,但它们不再是推荐的产品主路径。
运行手册 — ClawButler 用户手册