gh-aw交互式向导教程:TUI界面3步生成你的专属工作流
【免费下载链接】gh-awGitHub Agentic Workflows项目地址: https://gitcode.com/GitHub_Trending/gha/gh-aw
gh-aw(GitHub Agentic Workflows)让开发者用 Markdown 编写 AI 驱动的仓库自动化,而它的交互式向导gh aw add-wizard是新手最友好的入口:在终端 TUI 界面中依次完成「选 AI 引擎 → 配置密钥 → 生成并推送工作流」3 个步骤,无需手写一行 YAML,就能把 AI Agent 装进你的 GitHub Actions。本教程带你从零跑通全流程。
什么是 gh-aw 交互式向导
传统 GitHub Actions 需要你手写 YAML 定义构建、测试、部署等确定性流程;当任务需要"推理"(如 Issue 分诊、PR 审查、CI 失败排查)时,gh-aw 用YAML frontmatter 配置触发器与权限 + Markdown 正文描述任务目标的方式,让 AI Agent 在沙箱中安全执行。
add-wizard命令把这套机制封装成了三步式引导界面(源码位于pkg/cli/add_wizard_command.go与pkg/cli/add_interactive_orchestrator.go):
- 选择 AI 引擎:Copilot、Claude、Codex、Gemini 或 Pi
- 配置 API 密钥与 Secrets:向导会自动检测仓库中已存在的密钥
- 写入工作流:本地保存或直接创建 Pull Request,并可立即触发一次运行
💡 提示:该向导必须运行在交互式终端中,CI 环境请使用非交互的
gh aw add命令。
第一步:安装 gh aw CLI 扩展
先确认是否已安装:
gh aw version如果还没有,执行官方安装脚本(仓库根目录提供 install-gh-aw.sh):
curl -sL <安装脚本地址> | bash想直接体验完整流程?克隆源码仓库即可:https://gitcode.com/GitHub_Trending/gha/gh-aw
安装后,add-wizard会带你走完整引导;如果你偏好让编程 Agent(如 Claude Code、Copilot CLI)代劳,也可以参考仓库根目录的 create.md 中的自动化创建流程。
第二步:在 TUI 界面选择 AI 引擎
进入你的项目目录,执行:
gh aw add-wizard <workflow-name>TUI 表单会先弹出问题:"Which coding agent would you like to use?"。引擎选择逻辑(见pkg/cli/add_interactive_engine.go)会智能推荐:
- 若工作流 frontmatter 指定了引擎,会优先高亮
- 若仓库已配置某引擎的密钥,则推荐对应引擎
- 支持
--engine copilot参数预选,跳过选择界面
选中后,向导会引导你配置对应的认证方式与 API Key(组织级密钥已配置时可用--no-secret跳过此步)。
第三步:生成专属工作流并发布
确认配置后,向导完成最后动作:
- 在
.github/workflows/下生成工作流 Markdown 文件 - 运行编译,产出 GitHub Actions 可执行的
.lock.yml - 可选直接创建 Pull Request,并把变更推到远端
- 询问是否立即
workflow_dispatch触发一次试跑
之后只需在 GitHub Actions 页面观察运行。以官方的每日仓库报告工作流为例,Agent 会像这样自动生成包含发布动态、PR 统计的高亮日报:
向导命令速查表
| 命令 / 参数 | 作用 |
|---|---|
gh aw add-wizard <source> | 交互式添加工作流(TUI 引导) |
--engine <name> | 预选 AI 引擎,跳过选择步骤 |
--no-secret | 跳过密钥输入(组织/仓库级已配置时) |
--dir <path> | 指定工作流目录,默认.github/workflows |
--stop-after <时间> | 覆盖工作流的停止时间 |
--append <文本> | 安装时追加自定义内容 |
--no-security-scanner | 跳过安全扫描 |
支持的来源形式:本地文件./my-workflow.md、owner/repo/workflow-name@version简写,或任意 HTTPS 工作流地址(JSON 定义也会自动转换)。
常见问题
Q:向导提示 "requires an interactive terminal" 怎么办?A:你在 CI 或非 TTY 环境运行了add-wizard,请改用gh aw add(非交互模式),或在本地终端中执行。
Q:gh aw new和add-wizard有什么区别?A:new生成空白模板;add-wizard面向已有工作流(本地、仓库或 URL 来源),提供从引擎选择到 PR 创建的完整引导。
Q:编译后的文件要提交吗?A:是的,提交.github/workflows/<name>.md和<name>.lock.yml两个文件即可,后者可标记为自动生成。
总结
gh-aw 的add-wizard用 3 步 TUI 交互把"AI 工作流"的落地门槛降到最低:装扩展、选引擎、发布工作流。配合沙箱执行与safe-outputs权限收敛,新手也能安全地让 AI 接管仓库中的分诊、审查、日报等需要"判断力"的自动化任务。🚀
【免费下载链接】gh-awGitHub Agentic Workflows项目地址: https://gitcode.com/GitHub_Trending/gha/gh-aw
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考