Files

314 lines
14 KiB
Markdown
Raw Permalink Normal View History

2026-05-19 02:12:30 +08:00
# auto-tmux Script Automation
`scripts/auto-tmux.sh``auto-tmux` 的安全执行层:把高频 tmux 操作封装为可审计命令,减少手写 `capture-pane` / `send-keys` 时的误控风险。
## 设计目标
- **先观察再控制**:所有发送动作都要求目标 pane 存在,并优先输出最近上下文。
- **默认脱敏**:读取 pane 输出时自动遮蔽常见 token、API key、password、Bearer token。
- **拒绝危险动作**`rm -rf``git reset --hard``git clean -fd``tmux kill-server` 等命令默认拒绝,必须显式 `--force`
- **批量动作可解释**scan/rescue 都基于明确 session、pane、pattern 和 reply,不做无条件广播。
2026-05-19 02:49:16 +08:00
- **交接报告只读**brief 汇总 doctor、topology、scan 和 state report,不发送按键、不改变 tmux 状态。
- **远程默认只读**:SSH 场景使用 `remote-readonly.sh` 采集证据,远程控制规则见 `session-safety.md`
2026-05-19 02:12:30 +08:00
- **不改用户配置**:脚本只操作 tmux server,不写 `~/.tmux.conf`oh-my-tmux 配置仍走 `assets/oh-my-tmux` 参考入口。
## 子命令总览
| 子命令 | 用途 | 风险控制 |
|:---|:---|:---|
| `doctor` | 检查 tmux、脚本、资产、session 健康状态 | 只读诊断 |
2026-05-19 02:12:30 +08:00
| `topology` | 列出 session/window/pane 拓扑 | 只读 |
2026-05-19 03:26:58 +08:00
| `inspect` | 输出单个 pane 元信息和最近输出 | 默认脱敏,只读 |
2026-05-19 02:12:30 +08:00
| `capture` | 读取指定 pane 最近输出 | 默认脱敏,可保存到文件 |
| `send` | 向指定 pane 发送文本或按键 | 先打印上下文,危险文本需 `--force` |
| `paste` | 通过 tmux buffer 粘贴文件内容 | 适合长 prompt,多行内容先 `--dry-run` |
| `broadcast` | 向指定 session 全部 pane 发送文本或按键 | 必须显式 session,支持 `--dry-run` |
2026-05-19 02:12:30 +08:00
| `rescue` | pattern 命中后发送确认 | 不命中不发送 |
| `scan` | 批量巡检 pane 输出 | 可按 session 限定范围 |
| `record` | 开启/停止 pane 输出审计日志 | 文件写入到显式目录 |
| `snapshot` | 导出拓扑和 pane 输出证据包 | 默认脱敏,写入显式目录 |
| `safety-check.sh` | 检查待发送文本或文件 | 发现危险命令失败,敏感信息按 strict 策略告警或失败 |
2026-05-19 02:12:30 +08:00
| `hub` | 初始化 AI 多终端工作台 | 已存在 session 不覆盖 |
| `cleanup` | 清理指定 tmux session | 真实 kill 必须显式 `--force` |
2026-05-19 02:12:30 +08:00
| `wait` | 等待 pane 输出出现某个 pattern | 超时失败 |
2026-05-19 02:49:16 +08:00
| `swarm-brief.sh` | 生成只读交接报告 | 不发送按键,只汇总证据 |
2026-05-19 03:05:45 +08:00
| `swarm-watch.sh` | 有限轮次巡检 pane 输出和状态 | 不默认无限循环 |
| `swarm-archive.sh` | 打包 brief、snapshot 和 state | 生成可交接 `.tar.gz` |
2026-05-19 03:58:32 +08:00
| `swarm-board.sh` | 渲染任务、依赖、锁和状态日志 | 只读生成 Markdown 看板 |
| `swarm-deps-graph.sh` | 渲染任务依赖图 | 只读生成 Mermaid |
2026-05-19 13:21:24 +08:00
| `swarm-export.sh` | 导出 JSONL 状态包 | 只读读取 state,写显式输出目录 |
| `swarm-timeline.sh` | 渲染状态日志时间线 | 只读生成 Markdown |
| `swarm-blockers.sh` | 聚合阻塞、失败、锁和异常状态 | 只读生成 Markdown |
| `swarm-results.sh` | 汇总 DONE/FAIL/BLOCKED worker 结果 | 只读生成 Markdown 和 JSONL |
| `swarm-report-pack.sh` | 聚合多个只读报告、附件与 JSONL 导出 | 生成 `index.md``manifest.json` |
| `swarm-assign.sh` | 生成 ready task 到 worker pane 的分配建议 | 只读,不 claim,不发送 |
| `swarm-health.sh` | 汇总 tmux 与 swarm state 健康报告 | 只读,不自动修复 |
| `remote-readonly.sh` | SSH 只读采集远端 tmux 证据 | 不发送按键,输出默认脱敏,生成 `metadata.jsonl` |
2026-05-19 04:08:21 +08:00
| `record-summary.sh` | 汇总 pane 录制日志 | 只读,输出默认脱敏 |
2026-05-19 14:15:08 +08:00
| `check-jsonl.sh` | 轻量检查 JSONL 行和必需字段 | 无 jq 依赖,不替代完整 JSON parser |
| `review-checklist.sh` | 为 report pack 生成 reviewer 审计清单 | 只读报告包目录 |
| `verify-report-pack.sh` | 统一验证 report pack | 组合 manifest、JSONL 和审计清单门禁 |
| `completion.bash` | Bash 子命令和常用参数补全 | 只定义 shell completion |
| `swarm-dispatch.sh` | 渲染并可选下发提示词 | 默认只写文件,发送需 `--send` |
| `validate-auto-tmux.sh` | 执行技能专属质量门禁 | 覆盖脚本、文档索引、strict 和 smoke |
2026-05-19 02:12:30 +08:00
## 典型流程
### 0. 诊断环境
```bash
skills/auto-tmux/scripts/auto-tmux.sh doctor --session ai-hub
```
2026-05-19 02:12:30 +08:00
### 1. 建立 AI 工作台
```bash
skills/auto-tmux/scripts/auto-tmux.sh hub --session ai-hub --workers 3 --cmd "codex"
```
验收:
```bash
skills/auto-tmux/scripts/auto-tmux.sh topology --session ai-hub
skills/auto-tmux/scripts/auto-tmux.sh cleanup --session ai-hub --dry-run
2026-05-19 02:12:30 +08:00
```
### 2. 巡检全部 worker
```bash
skills/auto-tmux/scripts/auto-tmux.sh scan --session ai-hub -n 100
```
只看错误:
```bash
skills/auto-tmux/scripts/auto-tmux.sh scan --session ai-hub --pattern "ERROR|Traceback|failed"
```
保存巡检日志:
```bash
skills/auto-tmux/scripts/auto-tmux.sh scan --session ai-hub --save-dir /tmp/auto-tmux-scan
```
受控广播前先预览:
```bash
skills/auto-tmux/scripts/auto-tmux.sh broadcast --session ai-hub --text "pwd" --enter --dry-run
```
生成完整证据快照:
```bash
skills/auto-tmux/scripts/auto-tmux.sh snapshot --session ai-hub --dir /tmp/auto-tmux-snapshot -n 120
```
2026-05-19 02:49:16 +08:00
生成可交接的蜂群报告:
```bash
skills/auto-tmux/scripts/swarm-brief.sh --session ai-hub --swarm-dir /tmp/ai_swarm --out /tmp/auto-tmux-brief -n 80
```
2026-05-19 03:05:45 +08:00
采集连续巡检证据:
```bash
skills/auto-tmux/scripts/swarm-watch.sh --session ai-hub --swarm-dir /tmp/ai_swarm --iterations 3 --interval 10 -n 80
skills/auto-tmux/scripts/swarm-archive.sh --session ai-hub --swarm-dir /tmp/ai_swarm --out /tmp/ai-hub-handoff.tar.gz
2026-05-19 03:58:32 +08:00
skills/auto-tmux/scripts/swarm-board.sh --dir /tmp/ai_swarm --out /tmp/ai-swarm-board.md
skills/auto-tmux/scripts/swarm-deps-graph.sh --dir /tmp/ai_swarm --out /tmp/ai-swarm-deps.md
2026-05-19 13:21:24 +08:00
skills/auto-tmux/scripts/swarm-export.sh --dir /tmp/ai_swarm --out /tmp/ai-swarm-export
skills/auto-tmux/scripts/swarm-timeline.sh --dir /tmp/ai_swarm --out /tmp/ai-swarm-timeline.md
skills/auto-tmux/scripts/swarm-blockers.sh --dir /tmp/ai_swarm --out /tmp/ai-swarm-blockers.md
skills/auto-tmux/scripts/swarm-results.sh --dir /tmp/ai_swarm --out /tmp/ai-swarm-results.md
skills/auto-tmux/scripts/swarm-results.sh --dir /tmp/ai_swarm --out /tmp/ai-swarm-results.md --jsonl /tmp/ai-swarm-results.jsonl
skills/auto-tmux/scripts/swarm-report-pack.sh --dir /tmp/ai_swarm --session ai-hub --out /tmp/ai-swarm-report-pack
skills/auto-tmux/scripts/swarm-report-pack.sh --dir /tmp/ai_swarm --out /tmp/ai-swarm-report-pack --attach /tmp/auto-tmux-remote
skills/auto-tmux/scripts/swarm-report-pack.sh --dir /tmp/ai_swarm --out /tmp/ai-swarm-report-pack --tar
skills/auto-tmux/scripts/swarm-assign.sh --swarm-dir /tmp/ai_swarm --session ai-hub --out /tmp/ai-swarm-assign.md
skills/auto-tmux/scripts/swarm-health.sh --session ai-hub --swarm-dir /tmp/ai_swarm --out /tmp/auto-tmux-health
skills/auto-tmux/scripts/remote-readonly.sh --host user@example.com --session ai-hub --out /tmp/auto-tmux-remote --dry-run
2026-05-19 03:05:45 +08:00
```
发送前对 payload 做安全预检:
```bash
skills/auto-tmux/scripts/safety-check.sh --text "make test"
skills/auto-tmux/scripts/safety-check.sh --file /tmp/prompt.md --strict
```
执行 auto-tmux 专属质量门禁:
```bash
skills/auto-tmux/scripts/validate-auto-tmux.sh
skills/auto-tmux/scripts/validate-auto-tmux.sh --no-smoke
```
渲染并预演下发 worker prompt
```bash
target="$(tmux list-panes -t ai-hub:worker1 -F '#S:#I.#P' | head -n 1)"
skills/auto-tmux/scripts/swarm-dispatch.sh --role worker --target "$target" --task "只运行 make test" --send --dry-run
```
2026-05-19 02:12:30 +08:00
### 3. 安全发送命令
```bash
target="$(tmux list-panes -t ai-hub:worker1 -F '#S:#I.#P' | head -n 1)"
2026-05-19 03:26:58 +08:00
skills/auto-tmux/scripts/auto-tmux.sh inspect -t "$target" -n 40
2026-05-19 02:12:30 +08:00
skills/auto-tmux/scripts/auto-tmux.sh send -t "$target" --text "make test" --enter
skills/auto-tmux/scripts/auto-tmux.sh paste -t "$target" --file /tmp/prompt.md --enter --dry-run
2026-05-19 02:12:30 +08:00
```
如果要清空当前输入行后发送:
```bash
target="$(tmux list-panes -t ai-hub:worker1 -F '#S:#I.#P' | head -n 1)"
skills/auto-tmux/scripts/auto-tmux.sh send -t "$target" --clear --text "make lint" --enter
```
### 4. 自动救援等待确认的 pane
```bash
target="$(tmux list-panes -t ai-hub:worker1 -F '#S:#I.#P' | head -n 1)"
skills/auto-tmux/scripts/auto-tmux.sh rescue -t "$target" --pattern "(y/n)" --reply y
```
先演练不发送:
```bash
target="$(tmux list-panes -t ai-hub:worker1 -F '#S:#I.#P' | head -n 1)"
skills/auto-tmux/scripts/auto-tmux.sh rescue -t "$target" --pattern "(y/n)" --reply y --dry-run
```
### 5. 等待任务完成信号
```bash
target="$(tmux list-panes -t ai-hub:worker1 -F '#S:#I.#P' | head -n 1)"
skills/auto-tmux/scripts/auto-tmux.sh wait -t "$target" --pattern "BUILD SUCCESS|Tests passed" --timeout 300
```
### 6. 开启审计日志
```bash
target="$(tmux list-panes -t ai-hub:worker1 -F '#S:#I.#P' | head -n 1)"
skills/auto-tmux/scripts/auto-tmux.sh record start -t "$target" --dir /tmp/auto-tmux-records
```
停止:
```bash
target="$(tmux list-panes -t ai-hub:worker1 -F '#S:#I.#P' | head -n 1)"
skills/auto-tmux/scripts/auto-tmux.sh record stop -t "$target"
2026-05-19 04:08:21 +08:00
skills/auto-tmux/scripts/record-summary.sh --dir /tmp/auto-tmux-records --out /tmp/auto-tmux-record-summary.md
2026-05-19 14:15:08 +08:00
skills/auto-tmux/scripts/check-jsonl.sh /tmp/ai-swarm-results.jsonl --require-key type --require-key id --require-key status
skills/auto-tmux/scripts/review-checklist.sh --pack /tmp/ai-swarm-report-pack --out /tmp/ai-swarm-report-pack/review-checklist.md
skills/auto-tmux/scripts/review-checklist.sh --pack /tmp/ai-swarm-report-pack --strict
skills/auto-tmux/scripts/verify-report-pack.sh --pack /tmp/ai-swarm-report-pack
2026-05-19 02:12:30 +08:00
```
## AI 蜂群协作建议
推荐结构:
```text
ai-hub
├── commander # 人类或主 Agent:分配任务、巡检、验收、回收证据
├── worker1 # 子任务 1
├── worker2 # 子任务 2
└── worker3 # 子任务 3
```
最小协议:
1. commander 只通过明确 pane 目标发送任务,不盲发广播。
2. worker 输出完成状态、失败原因、修改文件和验证结果。
3. commander 用 `scan` 收集状态,用 `capture` 保留证据。
4. 需要确认输入时,用 `rescue --dry-run` 先验证 pattern,再真实发送。
5. 长任务用 `record start` 留日志,结束后 `record stop`
6. 多 worker 修改同一文件、目录或服务前,用 `swarm-state.sh lock-acquire` 声明锁。
## 状态与锁脚本
初始化状态目录:
```bash
skills/auto-tmux/scripts/swarm-state.sh init --dir /tmp/ai_swarm
```
添加并认领任务:
```bash
skills/auto-tmux/scripts/swarm-state.sh task-add --id task-001 --text "检查 README 链接"
2026-05-19 03:16:52 +08:00
skills/auto-tmux/scripts/swarm-state.sh task-import --file /tmp/tasks.txt --prefix batch
skills/auto-tmux/scripts/swarm-state.sh task-depend --id batch-002 --blocked-by batch-001
skills/auto-tmux/scripts/swarm-state.sh task-ready
skills/auto-tmux/scripts/swarm-state.sh task-claim --id task-001 --owner "ai-hub:2.1"
2026-05-19 02:49:16 +08:00
skills/auto-tmux/scripts/swarm-state.sh task-next --owner "ai-hub:2.1"
```
标记阻塞或失败:
```bash
skills/auto-tmux/scripts/swarm-state.sh task-block --id task-001 --owner "ai-hub:2.1" --reason "等待用户确认"
skills/auto-tmux/scripts/swarm-state.sh task-fail --id task-001 --owner "ai-hub:2.1" --reason "make test failed"
skills/auto-tmux/scripts/swarm-state.sh task-list --status FAIL
skills/auto-tmux/scripts/swarm-state.sh task-reopen --id task-001 --owner "ai-hub:2.1" --reason "修复后重试"
```
获取文件锁:
```bash
skills/auto-tmux/scripts/swarm-state.sh lock-acquire --name README.md --owner "ai-hub:2.1"
```
回收过期锁前先 dry-run
```bash
skills/auto-tmux/scripts/swarm-state.sh lock-prune --older-than 3600 --dry-run
```
完成任务并生成报告:
```bash
skills/auto-tmux/scripts/swarm-state.sh task-done --id task-001 --owner "ai-hub:2.1" --result "make test passed"
2026-05-19 03:23:52 +08:00
skills/auto-tmux/scripts/swarm-state.sh metrics
skills/auto-tmux/scripts/swarm-state.sh validate
skills/auto-tmux/scripts/swarm-state.sh report
```
2026-05-19 02:12:30 +08:00
## 验证命令
```bash
bash -n skills/auto-tmux/scripts/auto-tmux.sh
bash -n skills/auto-tmux/scripts/swarm-state.sh
2026-05-19 02:49:16 +08:00
bash -n skills/auto-tmux/scripts/swarm-brief.sh
2026-05-19 03:05:45 +08:00
bash -n skills/auto-tmux/scripts/swarm-watch.sh
bash -n skills/auto-tmux/scripts/swarm-archive.sh
2026-05-19 03:58:32 +08:00
bash -n skills/auto-tmux/scripts/swarm-board.sh
bash -n skills/auto-tmux/scripts/swarm-deps-graph.sh
2026-05-19 13:21:24 +08:00
bash -n skills/auto-tmux/scripts/swarm-export.sh
bash -n skills/auto-tmux/scripts/swarm-timeline.sh
bash -n skills/auto-tmux/scripts/swarm-blockers.sh
bash -n skills/auto-tmux/scripts/swarm-results.sh
bash -n skills/auto-tmux/scripts/swarm-report-pack.sh
bash -n skills/auto-tmux/scripts/swarm-assign.sh
bash -n skills/auto-tmux/scripts/swarm-health.sh
bash -n skills/auto-tmux/scripts/remote-readonly.sh
2026-05-19 04:08:21 +08:00
bash -n skills/auto-tmux/scripts/record-summary.sh
2026-05-19 14:15:08 +08:00
bash -n skills/auto-tmux/scripts/check-jsonl.sh
bash -n skills/auto-tmux/scripts/review-checklist.sh
bash -n skills/auto-tmux/scripts/verify-report-pack.sh
bash -n skills/auto-tmux/scripts/completion.bash
bash -n skills/auto-tmux/scripts/safety-check.sh
bash -n skills/auto-tmux/scripts/render-swarm-prompt.sh
bash -n skills/auto-tmux/scripts/swarm-dispatch.sh
bash -n skills/auto-tmux/scripts/validate-auto-tmux.sh
2026-05-19 02:12:30 +08:00
skills/auto-tmux/scripts/auto-tmux.sh help
skills/auto-tmux/scripts/swarm-state.sh help
2026-05-19 02:49:16 +08:00
skills/auto-tmux/scripts/swarm-brief.sh --help
skills/auto-tmux/scripts/validate-auto-tmux.sh --no-smoke
skills/auto-tmux/scripts/render-swarm-prompt.sh commander --session ai-hub --task "smoke"
skills/auto-tmux/scripts/auto-tmux-smoke-test.sh
2026-05-19 02:12:30 +08:00
skills/auto-skill/scripts/validate-skill.sh skills/auto-tmux --strict
```