{/* This page is auto-generated from the skill's SKILL.md by website/scripts/generate-skill-docs.py. Edit the source SKILL.md, not this page. */}

Setup Wizard Generator

生成一个 bash 向导,引导真人完成手动配置。

Skill 元数据

来源可选——使用 hermes skills install official/devops/setup-wizard-generator 安装
路径optional-skills/devops/setup-wizard-generator
版本1.0.0
作者Matt Pocock (mattpocock/skills, wizard) + Hermes Agent
许可证MIT
平台linux, macos
标签wizard, setup, onboarding, credentials, secrets, migration, bash, human-in-the-loop

参考:完整 SKILL.md

INFO

以下是 Hermes 在触发此 skill 时加载的完整 skill 定义。这是 skill 激活时 agent 所看到的指令内容。

Setup Wizard Generator

生成一个交互式 bash 向导(wizard):一个脚本,一步步引导真人完成一套手动流程——这套流程手工做很繁琐,每次重新解释也很啰嗦。它会打开每个 URL,明确说明要点哪里、复制什么,捕获这些值,写到该去的地方(.env、GitHub secrets),在每个阶段确认,并显示还剩几个阶段。

移植自 mattpocock/skills 中 MIT 许可的 wizard skill。

使用时机

  • 开通基础设施或第三方服务(Stripe、Supabase、DNS、OAuth apps),其中只有真人能在 dashboard 上点选
  • 配置凭据、CI 机密或仓库变量
  • 一次性迁移或切换,其中包含不可逆、需真人把关的步骤
  • 任何用户会交给同事去运行的流程

不要用于 agent 自己能完成的步骤——那些直接做。

前提条件

  • bash;仅当阶段需要写 GitHub secrets/variables 时才需要 gh CLI
  • 库模板:本 skill 目录下的 templates/template.sh

流程

1. 界定流程范围

梳理出真人必须执行的每一个手动步骤,以及沿途捕获的每一个值。先读仓库,不要凭空猜测:

  • 配置类:.env、.env.example、README、docker-compose*、框架配置,以及 .github/workflows/*(每一处 secrets.* / vars.* 引用都是向导必须产出的值)。
  • 迁移/切换类:当前状态、目标状态,以及两者之间不可逆的动作。

把有序的阶段列表和每个阶段产出的值展示给用户;他们可能增删或重排。当每个阶段都按顺序命名、且对每个捕获的值你都清楚 (a) 真人从哪里拿到它、(b) 写到哪里(.env、GitHub secret、两者都写,或哪里都不写)、(c) 它是否机密(隐藏输入)还是公开,就算完成。

2. 规划每个阶段的路径

为每个阶段写出真人要走的确切路径:打开哪个 URL、在那里做什么、值显示在哪里——例如 "Dashboard → Developers → API keys → Reveal test key → 复制"。在你不清楚当前 UI 或确切命令的地方,如实说明并查阅文档或提问——切勿编造可能不存在的步骤。

3. 编写向导

把 templates/template.sh(来自本 skill 目录)复制到目标路径。把示例 stage 替换为每个步骤一个 stage,按依赖顺序排列。把 TOTAL_STAGES 设为你写的阶段数。

库辅助函数:stage、say/step/note/warn、open_url、ask/ask_secret、write_env、set_secret/set_var、pause/confirm、banner、finish。STAGES 标记之上的库部分在每个向导里都完全相同——切勿手工编辑;这种一致性正是目的所在。

保持模板设定的标准:先打开 URL 再索要其值;对任何机密用 ask_secret;对每个持久化值用 write_env;只对 CI 真正需要的东西用 set_secret;在任何不可逆操作前 confirm。每个 stage 会清屏——每个阶段只放一个聚焦任务,这样真人需要的内容不会滚走。

向导默认是一次性的:把它存到临时目录或 scripts/ 路径,任务完成后删除。只有当用户想要一条可重复、留在仓库里的配置路径时才提交。

4. 验证并交付

  • bash -n <script>;如可用则运行 shellcheck;chmod +x <script>。
  • 不要自己端到端运行:它会打开浏览器并阻塞等待真人输入。静态走查:第 1 步的每个值都被捕获并落到第 1 步所说的位置,每个 set_secret 名称都与 CI 中某处的 secrets.* 引用精确匹配。
  • 告诉用户如何运行。如果它可重复,提交它并从 README 链接过去。

常见陷阱

  1. 编辑库部分。 STAGES 标记之上的一切都是向导库;只在其下编写。
  2. 编造 dashboard 路径。 第三方 UI 会漂移。若不确定点击路径,对照当前文档核实,或标注为大致路径。
  3. 对 CI 不用的值也 set_secret。 只把 workflow 真正引用的东西推到 GitHub secrets。
  4. 自己运行向导。 它会阻塞等待真人输入;静态走查加 bash -n 即是验证。
  5. 一个巨型阶段。 每个阶段清屏意味着长阶段会把关键指令滚走;把它拆开。

验证

  •  编写前已与用户确认阶段列表
  •  bash -n 通过;脚本可执行
  •  每个捕获的值都追溯到其声明的目标位置
  •  每个 set_secret 名称都与某条 CI secrets.* 引用匹配
  •  库部分保持模板原样未改动