使用指南

  1. Bootstrap 新项目
  2. 更新已有项目
  3. 验证完整性
  4. 检查清单
  5. 查看文档

1. Bootstrap 新项目

最小项目

scripts/bootstrap_new_project.sh /path/to/my-agent-project

带常用可选模块

scripts/bootstrap_new_project.sh /path/to/my-agent-project \
  --with-eval-harness \
  --with-multi-run \
  --with-tmux

全部可用模块

scripts/bootstrap_new_project.sh /path/to/my-agent-project \
  --with-eval-harness \
  --with-multi-run \
  --with-tmux \
  --with-browser-adapter \
  --with-docs-dual-format
注意:目标目录必须不存在。脚本会:

2. 更新已有项目

向之前 bootstrap 的项目或任意仓库添加新模块:

Bootstrap 项目

scripts/update_existing_project.sh /path/to/existing-project --with-docs-dual-format

模块文件合并到项目根目录,BOOTSTRAP_ADOPTION.md 自动更新。

非 Bootstrap 项目

scripts/update_existing_project.sh /path/to/any-repo --with-docs-dual-format

模块文件隔离在 .bootstrap/modules/<name>/ 下,不影响现有目录结构。脚本会打印集成提示。

脚本行为

特性自动检测项目类型并适配策略
幂等已启用的模块会被跳过
预览--dry-run 标志预览即将执行的操作

3. 验证完整性

scripts/validate_template_integrity.sh

检查所有文档化的 Core 和 Module 模板表面在更改后仍然存在。

4. 检查清单

新项目检查清单

模块选择检查清单

5. 查看文档

启动文档服务

cd agent-bootstrap
python3 -m http.server 8080 -d docs/html/

SSH 隧道(远程服务器)

# 在本地机器执行:
ssh -L 8080:127.0.0.1:8080 -N user@<服务器地址>

# 浏览器打开 http://localhost:8080
提示:所有 HTML 页面共享同一个 style.css 和导航栏。Markdown 源文件(内容对等)位于 docs/ 的各个子目录中。