Skip to content

Commit 33ac321

Browse files
author
Rex
committed
docs: switch core command docs to loopforge
1 parent 1d6838b commit 33ac321

6 files changed

Lines changed: 80 additions & 72 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ LoopForge (formerly RexOS) is a long-running agent operating system: persistent
77
## Brand update
88

99
- Public product name: **LoopForge**
10-
- Compatibility names still in use: `rexos` (CLI), `~/.rexos` (config/data dir), and `rexleimo/rexos` (repo path)
10+
- Primary CLI command: `loopforge`
11+
- Compatibility names still in use: `rexos` (CLI alias), `~/.rexos` (config/data dir), and `rexleimo/rexos` (repo path)
1112
- Existing scripts/docs using `rexos` continue to work
1213

1314
## Documentation
@@ -23,18 +24,19 @@ This repository is bootstrapped with a long-running harness (`features.json`, `i
2324

2425
### Option A: Download a prebuilt binary (recommended)
2526

26-
Download the archive for your OS from GitHub Releases, extract it, and put `rexos` (or `rexos.exe`) somewhere on your `PATH`.
27+
Download the archive for your OS from GitHub Releases, extract it, and put `loopforge` (or `loopforge.exe`) somewhere on your `PATH`.
28+
The compatibility command `rexos` is still included during migration.
2729

2830
### Option B: Build from source
2931

3032
```bash
3133
# Install to ~/.cargo/bin (recommended for dev)
3234
cargo install --path crates/rexos-cli --locked
33-
rexos --help
35+
loopforge --help
3436

3537
# Or build a local binary
3638
cargo build --release -p rexos-cli
37-
./target/release/rexos --help
39+
./target/release/loopforge --help
3840
```
3941

4042
## Quick start (dev)
@@ -51,12 +53,12 @@ LoopForge defaults to `ollama` at `http://127.0.0.1:11434/v1` in `~/.rexos/confi
5153
# 1) Start Ollama
5254
ollama serve
5355

54-
# 2) Init LoopForge (compat command: rexos)
55-
rexos init
56+
# 2) Init LoopForge (compat command: rexos init)
57+
loopforge init
5658

5759
# 3) Run an agent session in a workspace directory
5860
mkdir -p /tmp/rexos-work
59-
rexos agent run --workspace /tmp/rexos-work --prompt "Create hello.txt with the word hi"
61+
loopforge agent run --workspace /tmp/rexos-work --prompt "Create hello.txt with the word hi"
6062
```
6163

6264
To run the optional Ollama smoke test: `REXOS_OLLAMA_MODEL=<your-model> cargo test -p rexos -- --ignored`.

README.zh-CN.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ LoopForge(原 RexOS)是一个长任务的 Agent OS:持久化记忆、工
77
## 品牌更新
88

99
- 对外产品名:**LoopForge**
10-
- 兼容名仍保留:`rexos`(CLI)、`~/.rexos`(配置/数据目录)、`rexleimo/rexos`(仓库路径)
10+
- 主 CLI 命令:`loopforge`
11+
- 兼容名仍保留:`rexos`(CLI 兼容别名)、`~/.rexos`(配置/数据目录)、`rexleimo/rexos`(仓库路径)
1112
- 现有脚本和文档中的 `rexos` 命令可继续使用
1213

1314
## 文档
@@ -23,18 +24,19 @@ LoopForge(原 RexOS)是一个长任务的 Agent OS:持久化记忆、工
2324

2425
### 方案 A:下载预编译二进制(推荐)
2526

26-
从 GitHub Releases 下载对应你系统的压缩包,解压后把 `rexos`(或 `rexos.exe`)放到 `PATH` 里即可。
27+
从 GitHub Releases 下载对应你系统的压缩包,解压后把 `loopforge`(或 `loopforge.exe`)放到 `PATH` 里即可。
28+
迁移期间仍包含 `rexos` 兼容命令。
2729

2830
### 方案 B:从源码构建
2931

3032
```bash
3133
# 安装到 ~/.cargo/bin(开发推荐)
3234
cargo install --path crates/rexos-cli --locked
33-
rexos --help
35+
loopforge --help
3436

3537
# 或仅构建本地二进制
3638
cargo build --release -p rexos-cli
37-
./target/release/rexos --help
39+
./target/release/loopforge --help
3840
```
3941

4042
## 快速开始(开发)
@@ -51,12 +53,12 @@ LoopForge 默认配置会在 `~/.rexos/config.toml` 里把 `ollama` 指向 `http
5153
# 1) 启动 Ollama
5254
ollama serve
5355

54-
# 2) 初始化 LoopForge(兼容命令:rexos)
55-
rexos init
56+
# 2) 初始化 LoopForge(兼容命令:rexos init
57+
loopforge init
5658

5759
# 3) 在某个 workspace 目录里运行一次 agent session
5860
mkdir -p /tmp/rexos-work
59-
rexos agent run --workspace /tmp/rexos-work --prompt "Create hello.txt with the word hi"
61+
loopforge agent run --workspace /tmp/rexos-work --prompt "Create hello.txt with the word hi"
6062
```
6163

6264
可选的 Ollama smoke test:`REXOS_OLLAMA_MODEL=<your-model> cargo test -p rexos -- --ignored`

docs-site/reference/cli.md

Lines changed: 31 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,58 @@
11
# CLI Reference
22

3-
RexOS ships a single binary: `rexos`.
3+
LoopForge ships a primary binary: `loopforge`.
4+
Compatibility binary `rexos` remains available during migration.
45

56
## Top-level commands
67

7-
- `rexos init` — initialize `~/.rexos` (config + database)
8-
- `rexos onboard` — one-command onboarding (`init` + config validate + `doctor` + optional first task)
9-
- `rexos doctor` — diagnose common setup issues (config, providers, browser, tooling)
10-
- `rexos agent run` — run a single agent session in a workspace
11-
- `rexos channel drain` — drain queued outbox messages once
12-
- `rexos channel worker` — run a polling outbox dispatcher
13-
- `rexos acp events` — list recent ACP events (optional session filter)
14-
- `rexos acp checkpoints` — show delivery checkpoints for a session
15-
- `rexos harness init` — initialize a harness workspace (durable artifacts + git)
16-
- `rexos harness run` — run an incremental harness session
17-
- `rexos daemon start` — start the HTTP daemon
8+
- `loopforge init` — initialize `~/.rexos` (config + database)
9+
- `loopforge onboard` — one-command onboarding (`init` + config validate + `doctor` + optional first task)
10+
- `loopforge doctor` — diagnose common setup issues (config, providers, browser, tooling)
11+
- `loopforge agent run` — run a single agent session in a workspace
12+
- `loopforge channel drain` — drain queued outbox messages once
13+
- `loopforge channel worker` — run a polling outbox dispatcher
14+
- `loopforge acp events` — list recent ACP events (optional session filter)
15+
- `loopforge acp checkpoints` — show delivery checkpoints for a session
16+
- `loopforge harness init` — initialize a harness workspace (durable artifacts + git)
17+
- `loopforge harness run` — run an incremental harness session
18+
- `loopforge daemon start` — start the HTTP daemon
19+
20+
Compatibility note: all commands above also work with `rexos` during migration.
1821

1922
## Examples
2023

2124
=== "macOS/Linux"
2225
```bash
23-
rexos init
24-
rexos onboard --workspace rexos-onboard-demo
26+
loopforge init
27+
loopforge onboard --workspace rexos-onboard-demo
2528

2629
mkdir -p rexos-work
27-
rexos agent run --workspace rexos-work --prompt "Create hello.txt"
30+
loopforge agent run --workspace rexos-work --prompt "Create hello.txt"
2831

2932
mkdir -p rexos-task
30-
rexos harness init rexos-task --prompt "Initialize a features checklist for refactoring this repo"
31-
rexos harness run rexos-task --prompt "Continue"
33+
loopforge harness init rexos-task --prompt "Initialize a features checklist for refactoring this repo"
34+
loopforge harness run rexos-task --prompt "Continue"
3235

33-
rexos channel drain
34-
rexos acp events --limit 20
36+
loopforge channel drain
37+
loopforge acp events --limit 20
3538

36-
rexos daemon start --addr 127.0.0.1:8787
39+
loopforge daemon start --addr 127.0.0.1:8787
3740
```
3841

3942
=== "Windows (PowerShell)"
4043
```powershell
41-
rexos init
42-
rexos onboard --workspace rexos-onboard-demo
44+
loopforge init
45+
loopforge onboard --workspace rexos-onboard-demo
4346

4447
mkdir rexos-work
45-
rexos agent run --workspace rexos-work --prompt "Create hello.txt"
48+
loopforge agent run --workspace rexos-work --prompt "Create hello.txt"
4649

4750
mkdir rexos-task
48-
rexos harness init rexos-task --prompt "Initialize a features checklist for refactoring this repo"
49-
rexos harness run rexos-task --prompt "Continue"
51+
loopforge harness init rexos-task --prompt "Initialize a features checklist for refactoring this repo"
52+
loopforge harness run rexos-task --prompt "Continue"
5053

51-
rexos channel drain
52-
rexos acp events --limit 20
54+
loopforge channel drain
55+
loopforge acp events --limit 20
5356

54-
rexos daemon start --addr 127.0.0.1:8787
57+
loopforge daemon start --addr 127.0.0.1:8787
5558
```

docs-site/reference/config.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Config Reference (`~/.rexos/config.toml`)
22

3-
RexOS stores configuration in `~/.rexos/config.toml`.
3+
LoopForge stores configuration in `~/.rexos/config.toml` (path kept for compatibility).
44

55
## Providers
66

@@ -41,8 +41,7 @@ model = "default"
4141

4242
## Built-in presets
4343

44-
RexOS includes common provider presets (names may evolve):
44+
LoopForge includes common provider presets (names may evolve):
4545

4646
- OpenAI-compatible: `deepseek`, `kimi`, `qwen`, `glm`, `minimax`
4747
- Provider-native: `glm_native`, `minimax_native`, `qwen_native`
48-

docs-site/zh-CN/reference/cli.md

Lines changed: 27 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,54 @@
11
# CLI 参考
22

3-
RexOS 提供单个二进制:`rexos`
3+
LoopForge 的主二进制命令是 `loopforge`
4+
迁移期间保留兼容二进制 `rexos`
45

56
## 顶层命令
67

7-
- `rexos init` — 初始化 `~/.rexos`(配置 + 数据库)
8-
- `rexos onboard` — 一键 onboarding(`init` + 配置校验 + `doctor` + 可选首任务)
9-
- `rexos doctor` — 诊断常见配置问题(配置文件、providers、浏览器、基础依赖)
10-
- `rexos agent run` — 在 workspace 中运行一次 agent session
11-
- `rexos channel drain` — 执行一次 outbox drain(投递队列中的消息)
12-
- `rexos channel worker` — 运行轮询 outbox 的 dispatcher
13-
- `rexos harness init` — 初始化 harness workspace(持久化产物 + git)
14-
- `rexos harness run` — 运行一次增量 harness session
15-
- `rexos daemon start` — 启动 HTTP daemon
8+
- `loopforge init` — 初始化 `~/.rexos`(配置 + 数据库)
9+
- `loopforge onboard` — 一键 onboarding(`init` + 配置校验 + `doctor` + 可选首任务)
10+
- `loopforge doctor` — 诊断常见配置问题(配置文件、providers、浏览器、基础依赖)
11+
- `loopforge agent run` — 在 workspace 中运行一次 agent session
12+
- `loopforge channel drain` — 执行一次 outbox drain(投递队列中的消息)
13+
- `loopforge channel worker` — 运行轮询 outbox 的 dispatcher
14+
- `loopforge harness init` — 初始化 harness workspace(持久化产物 + git)
15+
- `loopforge harness run` — 运行一次增量 harness session
16+
- `loopforge daemon start` — 启动 HTTP daemon
17+
18+
兼容说明:迁移期间,上述命令都可继续使用 `rexos` 前缀执行。
1619

1720
## 示例
1821

1922
=== "macOS/Linux"
2023
```bash
21-
rexos init
22-
rexos onboard --workspace rexos-onboard-demo
24+
loopforge init
25+
loopforge onboard --workspace rexos-onboard-demo
2326

2427
mkdir -p rexos-work
25-
rexos agent run --workspace rexos-work --prompt "Create hello.txt"
28+
loopforge agent run --workspace rexos-work --prompt "Create hello.txt"
2629

2730
mkdir -p rexos-task
28-
rexos harness init rexos-task --prompt "Initialize a features checklist for refactoring this repo"
29-
rexos harness run rexos-task --prompt "Continue"
31+
loopforge harness init rexos-task --prompt "Initialize a features checklist for refactoring this repo"
32+
loopforge harness run rexos-task --prompt "Continue"
3033

31-
rexos channel drain
34+
loopforge channel drain
3235

33-
rexos daemon start --addr 127.0.0.1:8787
36+
loopforge daemon start --addr 127.0.0.1:8787
3437
```
3538

3639
=== "Windows (PowerShell)"
3740
```powershell
38-
rexos init
39-
rexos onboard --workspace rexos-onboard-demo
41+
loopforge init
42+
loopforge onboard --workspace rexos-onboard-demo
4043

4144
mkdir rexos-work
42-
rexos agent run --workspace rexos-work --prompt "Create hello.txt"
45+
loopforge agent run --workspace rexos-work --prompt "Create hello.txt"
4346

4447
mkdir rexos-task
45-
rexos harness init rexos-task --prompt "Initialize a features checklist for refactoring this repo"
46-
rexos harness run rexos-task --prompt "Continue"
48+
loopforge harness init rexos-task --prompt "Initialize a features checklist for refactoring this repo"
49+
loopforge harness run rexos-task --prompt "Continue"
4750

48-
rexos channel drain
51+
loopforge channel drain
4952

50-
rexos daemon start --addr 127.0.0.1:8787
53+
loopforge daemon start --addr 127.0.0.1:8787
5154
```

docs-site/zh-CN/reference/config.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 配置参考(`~/.rexos/config.toml`
22

3-
RexOS 把配置存放在 `~/.rexos/config.toml`
3+
LoopForge 把配置存放在 `~/.rexos/config.toml`(路径为兼容保留)
44

55
## Providers
66

@@ -41,8 +41,7 @@ model = "default"
4141

4242
## 内置 presets
4343

44-
RexOS 默认包含一些常用 provider presets(名称可能会演进):
44+
LoopForge 默认包含一些常用 provider presets(名称可能会演进):
4545

4646
- OpenAI-compatible:`deepseek``kimi``qwen``glm``minimax`
4747
- Provider-native:`glm_native``minimax_native``qwen_native`
48-

0 commit comments

Comments
 (0)