Skip to content
This repository was archived by the owner on May 6, 2026. It is now read-only.

Commit d0c69ff

Browse files
yysjasmineclaude
andcommitted
docs: refresh README for up-front LLM prompt, shared clone, auto-launch flow
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent b4262df commit d0c69ff

2 files changed

Lines changed: 37 additions & 15 deletions

File tree

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,34 @@ Multi-platform one-click installer for [Hermes Agent](https://github.com/NousRes
99
- Installs Hermes Agent and/or OpenClaw via each product's official installer
1010
- Configures an LLM provider (OpenRouter, OpenAI, Anthropic, or custom)
1111
- Ships with bundled Sensenova skills already placed inside each product's `skills/` directory
12+
- Launches the installed agent(s) automatically when setup finishes — no manual shell-restart step
1213

1314
## How It Works
1415

15-
Agent Pack is the source of truth for its vendored copies of Hermes Agent and OpenClaw (under `repos/`). At install time, each installer clones this monorepo fresh from GitHub, copies out the relevant subdirectory, and invokes the bundled `scripts/install.sh` with `--source-ready` so it skips its own clone/pull and uses the freshly copied source. Runtime dependencies (Python, Node.js, uv, git, build tools) are still handled by the product installer.
16+
Agent Pack is the source of truth for its vendored copies of Hermes Agent and OpenClaw (under `repos/`). At install time, each installer clones this monorepo fresh from GitHub (once, shared across products), copies out the relevant subdirectory, and invokes the bundled `scripts/install.sh` with `--source-ready` so it skips its own clone/pull and uses the freshly copied source. Runtime dependencies (Python, Node.js, uv, git, build tools) are still handled by the product installer.
1617

1718
```
18-
Step 1: Select products (Hermes / OpenClaw / Both)
19-
Step 2: Clone agent_pack, copy out repos/<product>, run its install.sh
19+
Step 1: Collect LLM provider credentials up front (one interactive pass)
20+
Step 2: Select products (Hermes / OpenClaw / Both)
21+
Step 3: Clone agent_pack once, copy out repos/<product>, run its install.sh
2022
- Hermes: install.sh --source-ready --skip-setup --dir <target>
2123
- OpenClaw: install.sh --install-method git --source-ready --git-dir <target> \
2224
--no-onboard --no-prompt
23-
Step 3: Write LLM provider config (~/.hermes/config.yaml, ~/.openclaw/openclaw.json)
25+
Step 4: Write LLM provider config per product immediately after it installs
26+
(~/.hermes/config.yaml, ~/.openclaw/openclaw.json; OpenClaw is configured
27+
via its own CLI, which also registers the model under models.providers)
28+
Step 5: Launch the installed agent(s) in the current window
29+
- Hermes only: exec hermes
30+
- OpenClaw only: exec openclaw gateway --verbose (+ opens dashboard in browser)
31+
- Both: openclaw gateway runs in the background (log at
32+
~/.openclaw/gateway.log), hermes takes over the foreground,
33+
and the OpenClaw dashboard opens in the browser
2434
```
2535

2636
Bundled skills live inside `repos/hermes-agent/skills/` and `repos/openclaw/skills/`, so they are installed as part of each product's normal install — no extra step needed.
2737

38+
The up-front LLM prompt means the user only interacts once; the long-running installs and the final product launch then run unattended. Per-product config is written as soon as each install succeeds, so a later product's failure never strands a working one without credentials.
39+
2840
### China-region mirrors
2941

3042
When the installer detects a China region (or `AGENTPACK_CN=1` is set), it prefixes the clone URL with a GitHub proxy — defaults are `https://ghproxy.cn/` then `https://ghfast.top/`, tried in order on failure. Override the list in `config/defaults.json` under `agent_pack.cn_mirrors`.
@@ -45,9 +57,9 @@ Runtime dependencies (Python, Node.js, uv, git, build tools) are auto-installed
4557

4658
| Platform | Format | How to Use |
4759
|----------|--------|------------|
48-
| Windows | `.exe` installer | Double-click and follow the wizard; installation runs inside WSL2 |
49-
| macOS | `.pkg` installer | Double-click, then complete setup in the Terminal window that opens |
50-
| Linux | bash script | `curl -fsSL https://URL/install.sh \| bash` |
60+
| Windows | `.exe` installer | Double-click and follow the wizard; installation runs inside WSL2, and the PowerShell window is taken over by the installed agent when setup finishes |
61+
| macOS | `.pkg` installer | Double-click, then complete setup in the Terminal window that opens; the same window becomes the agent's REPL / gateway once installation finishes |
62+
| Linux | bash script | `curl -fsSL https://URL/install.sh \| bash` — the shell that ran the installer is handed over to the agent via `exec` |
5163

5264
## Building from Source
5365

README.zh-CN.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,33 @@
99
- 调用各产品的官方安装脚本,安装 Hermes Agent 和/或 OpenClaw
1010
- 配置 LLM 供应商(OpenRouter、OpenAI、Anthropic 或自定义端点)
1111
- 预置 Sensenova 技能库(已直接放在各产品的 `skills/` 目录中)
12+
- 安装结束后直接在当前窗口拉起 agent,省去手动重启 shell 的步骤
1213

1314
## 工作原理
1415

15-
Agent Pack 是我们所维护的 Hermes Agent 和 OpenClaw 源码(位于 `repos/` 下)的**唯一真相源**。安装时各平台都会从 GitHub 重新克隆本 monorepo,拷出对应产品子目录,然后以 `--source-ready` 调用产品自带的 `scripts/install.sh`,让它跳过自己的 clone/pull、直接使用刚拷贝出来的源码。运行时依赖(Python、Node.js、uv、git、构建工具)仍由产品自带的安装脚本处理。
16+
Agent Pack 是我们所维护的 Hermes Agent 和 OpenClaw 源码(位于 `repos/` 下)的**唯一真相源**。安装时各平台都会从 GitHub 重新克隆本 monorepo(一次克隆、多个产品共享),拷出对应产品子目录,然后以 `--source-ready` 调用产品自带的 `scripts/install.sh`,让它跳过自己的 clone/pull、直接使用刚拷贝出来的源码。运行时依赖(Python、Node.js、uv、git、构建工具)仍由产品自带的安装脚本处理。
1617

1718
```
18-
Step 1: 选择产品 (Hermes / OpenClaw / 两者都要)
19-
Step 2: clone agent_pack、拷出 repos/<product>、运行其 install.sh
19+
Step 1: 先一次性收集 LLM 供应商凭据(提前问完所有交互问题)
20+
Step 2: 选择产品 (Hermes / OpenClaw / 两者都要)
21+
Step 3: clone agent_pack(共享一次)、拷出 repos/<product>、运行其 install.sh
2022
- Hermes: install.sh --source-ready --skip-setup --dir <target>
2123
- OpenClaw: install.sh --install-method git --source-ready --git-dir <target> \
2224
--no-onboard --no-prompt
23-
Step 3: 写入 LLM 供应商配置
24-
(~/.hermes/config.yaml, ~/.openclaw/openclaw.json)
25+
Step 4: 每个产品装完后立刻写入它自己的 LLM 配置
26+
(~/.hermes/config.yaml, ~/.openclaw/openclaw.json;OpenClaw 这边走自己
27+
的 CLI,同时把用户选的模型注册到 models.providers 里)
28+
Step 5: 在当前窗口直接拉起刚装好的 agent
29+
- 只装 Hermes: exec hermes
30+
- 只装 OpenClaw: exec openclaw gateway --verbose(顺带在浏览器打开 dashboard)
31+
- 两个都装: openclaw gateway 后台运行(日志在 ~/.openclaw/gateway.log),
32+
前台交给 hermes,OpenClaw dashboard 自动弹浏览器
2533
```
2634

2735
Bundled skills 已经直接放进 `repos/hermes-agent/skills/``repos/openclaw/skills/` 中,随产品安装一起完成,无需单独的复制步骤。
2836

37+
提前问完 LLM 配置意味着用户只需要交互一次,之后的长流程安装和最终的 agent 启动都无需看守。每装完一个产品立刻写它的配置,也保证另一个产品失败时已经装好的那个不会没凭据可用。
38+
2939
### 中国区镜像
3040

3141
安装器检测到中国区网络(或设置了 `AGENTPACK_CN=1`)时,会在 clone URL 前加上 GitHub 代理前缀:默认依次尝试 `https://ghproxy.cn/``https://ghfast.top/`,失败自动切换到下一个。镜像列表可在 `config/defaults.json``agent_pack.cn_mirrors` 中自定义。
@@ -46,9 +56,9 @@ Bundled skills 已经直接放进 `repos/hermes-agent/skills/` 和 `repos/opencl
4656

4757
| 平台 | 格式 | 使用方式 |
4858
|------|------|---------|
49-
| Windows | `.exe` 安装器 | 双击运行向导;安装过程在 WSL2 中执行 |
50-
| macOS | `.pkg` 安装器 | 双击后在自动打开的 Terminal 窗口中完成安装 |
51-
| Linux | bash 脚本 | `curl -fsSL https://URL/install.sh \| bash` |
59+
| Windows | `.exe` 安装器 | 双击运行向导;安装过程在 WSL2 中执行,安装完成后当前 PowerShell 窗口会被接管,直接跑起 agent |
60+
| macOS | `.pkg` 安装器 | 双击后在自动打开的 Terminal 窗口中完成安装;安装结束后同一个窗口会变成 agent 的 REPL / gateway |
61+
| Linux | bash 脚本 | `curl -fsSL https://URL/install.sh \| bash` — 安装结束后会在当前 shell 里 `exec` 拉起 agent |
5262

5363
## 从源码构建
5464

0 commit comments

Comments
 (0)