Skip to content

Commit 3c1b4e1

Browse files
authored
docs(readme): tighten intro, add promo video, table-based quick start (#44)
* docs(readme): tighten intro, add promo video, table-based quick start - Lead with what LoopForge is: installed into the agent you already use (CodeBuddy, Codex, Cursor, Claude Code, Pi), running a role-based workflow inside it - Add the 13s English promo: an animated WebP preview that plays inline on GitHub (GitHub strips <video> for repo files), linking to the full MP4 with sound (720p H.264, 2.8 MB) - Quick start, Portable Edition and maintenance commands as compact tables; add a supported-agents matrix - Keep README.md and README.zh-CN.md in sync * docs(readme): drop the 'watch with sound' caption under the video --------- Co-authored-by: Yanami-2K <330265241+Yanami-2K@users.noreply.github.com>
1 parent 96e38f9 commit 3c1b4e1

4 files changed

Lines changed: 123 additions & 343 deletions

File tree

‎README.md‎

Lines changed: 62 additions & 172 deletions
Original file line numberDiff line numberDiff line change
@@ -4,94 +4,76 @@ English | [简体中文](README.zh-CN.md)
44

55
**Make coding agents deliver through a workflow you can confirm, review, and resume—not just produce code.**
66

7-
Giving a coding agent a request is easy. The hard part is making sure it understands the goal before coding, stays within scope during implementation, and completes independent review and testing before it stops. Longer tasks also lose context, get interrupted, and leave behind a diff with little explanation of how it was produced.
7+
LoopForge installs into the coding agent you already use: CodeBuddy, Codex, Cursor, Claude Code, or Pi. Inside that agent it runs a role-based delivery workflow. The requirement is clarified and confirmed first, then the work is designed, implemented, reviewed by a different role from the one that wrote the code, and tested. Stages run one after another, each handled by its own role. You don't run several agents side by side. Decisions, review findings, and test results are saved along the way, so you can inspect the work and pick it up again after an interruption.
88

9-
LoopForge turns those concerns into a complete software delivery workflow. You describe the problem to solve; LoopForge chooses a path based on task complexity and guides agents through requirement clarification, solution design, implementation, independent review, and testing while preserving the important decisions and verification results.
10-
11-
## From one request to a verifiable result
12-
13-
1. **Understand the problem first**: the agent inspects the project and clarifies the goal, scope, and acceptance criteria instead of immediately writing code.
14-
2. **Confirm the boundaries before implementation**: medium and large tasks move into design and implementation only after you confirm the goal, scope, exclusions, key decisions, and acceptance criteria.
15-
3. **Separate delivery responsibilities**: design, implementation, review, and testing are performed in stages by agents with independent responsibilities, reducing self-review bias in a single context.
16-
4. **Show evidence, not just a diff**: requirements, plans, changes, review findings, and test results are saved for inspection, handoff, and retrospectives.
17-
5. **Continue after interruption**: workflow state is persisted so the next session can resume at the unfinished stage instead of starting over.
18-
19-
Small changes take a streamlined single-agent path. The full multi-agent workflow is reserved for medium and large tasks that benefit from it.
20-
21-
```text
22-
Your request
23-
│
24-
├─ Small change ───────> Understand → implement → verify → deliver
25-
│
26-
└─ Medium/large task ──> Clarify and confirm → design → implement
27-
→ independent review → test → deliver
28-
│
29-
└── State and artifacts are saved throughout
30-
```
9+
<p align="center">
10+
<a href="docs/assets/loopforge-promo.mp4?raw=true">
11+
<img src="docs/assets/loopforge-promo-preview.webp" alt="LoopForge in 13 seconds: one request goes through the leader, developer, code-reviewer, and test-engineer roles inside the agent you already use." width="720" />
12+
</a>
13+
</p>
3114

3215
## Quick start
3316

34-
Requires Node.js 20+ and Python 3.8+.
17+
Requires Node.js 20+ and Python 3.8+. The commands below install the default Classic Edition; choose it if you are unsure.
3518

36-
The commands below install the default Classic Edition. Choose this edition if you are unsure.
19+
| Agent | Install | Start a workflow |
20+
| --- | --- | --- |
21+
| CodeBuddy | `npx -y loopforge-cli@latest install codebuddy` | `/start-devflow "<request>"` |
22+
| Codex | `npx -y loopforge-cli@latest install codex` | `$devflow-codex "<request>"` |
23+
| Cursor | `npx -y loopforge-cli@latest install cursor` | `/start-devflow "<request>"` |
24+
| Claude Code | `npx -y loopforge-cli@latest install claude` | `/start-devflow "<request>"` |
3725

38-
### CodeBuddy
26+
For example, with Claude Code:
3927

4028
```bash
41-
npx -y loopforge-cli@latest install codebuddy
42-
npx -y loopforge-cli@latest status codebuddy
29+
npx -y loopforge-cli@latest install claude
30+
npx -y loopforge-cli@latest status claude
4331
```
4432

45-
Then start a workflow:
46-
4733
```text
4834
/start-devflow "add status filtering to the order list and cover the API with tests"
4935
```
5036

51-
### Codex
37+
Check any installation with `npx -y loopforge-cli@latest status <agent>`. If installation or execution fails, diagnose the environment:
5238

5339
```bash
54-
npx -y loopforge-cli@latest install codex
55-
npx -y loopforge-cli@latest status codex
40+
npx -y loopforge-cli@latest doctor
5641
```
5742

58-
Then start a workflow:
59-
60-
```text
61-
$devflow-codex "add status filtering to the order list and cover the API with tests"
62-
```
43+
Pi is supported through the [Portable Edition](#portable-edition).
6344

64-
### Cursor
45+
## How it works
6546

66-
```bash
67-
npx -y loopforge-cli@latest install cursor
68-
npx -y loopforge-cli@latest status cursor
69-
```
47+
1. **Understand the problem first**: the agent inspects the project and clarifies the goal, scope, and acceptance criteria instead of immediately writing code.
48+
2. **Confirm the boundaries before implementation**: medium and large tasks move into design and implementation only after you confirm the goal, scope, exclusions, key decisions, and acceptance criteria.
49+
3. **Separate responsibilities**: design, implementation, review, and testing are handled stage by stage by roles with independent responsibilities, which reduces self-review bias in a single context.
50+
4. **Show evidence, not just a diff**: requirements, plans, changes, review findings, and test results are saved for inspection, handoff, and retrospectives.
51+
5. **Continue after interruption**: workflow state is persisted so the next session can resume at the unfinished stage instead of starting over.
7052

71-
Then start a workflow:
53+
LoopForge picks the path by task complexity. Small changes take a streamlined single-role path; the full role-based workflow is reserved for medium and large tasks that benefit from it.
7254

7355
```text
74-
/start-devflow "add status filtering to the order list and cover the API with tests"
56+
Your request
57+
│
58+
├─ Small change ───────> Understand → implement → verify → deliver
59+
│
60+
└─ Medium/large task ──> Clarify and confirm → design → implement
61+
→ independent review → test → deliver
62+
│
63+
└── State and artifacts are saved throughout
7564
```
7665

77-
### Claude Code
78-
79-
```bash
80-
npx -y loopforge-cli@latest install claude
81-
npx -y loopforge-cli@latest status claude
82-
```
66+
## Supported agents
8367

84-
Then start a workflow:
68+
| Agent | Classic Edition (default) | Portable Edition |
69+
| --- | --- | --- |
70+
| CodeBuddy | ✓ | ✓ |
71+
| Codex | ✓ | ✓ |
72+
| Cursor | ✓ | ✓ |
73+
| Claude Code | ✓ | ✓ |
74+
| Pi | — | ✓ |
8575

86-
```text
87-
/start-devflow "add status filtering to the order list and cover the API with tests"
88-
```
89-
90-
If installation or execution fails, diagnose the environment:
91-
92-
```bash
93-
npx -y loopforge-cli@latest doctor
94-
```
76+
LoopForge enables only one edition per coding agent in each project. See [`EDITIONS.md`](EDITIONS.md) for the differences and directory layout.
9577

9678
## What you get
9779

@@ -117,7 +99,7 @@ Resume an interrupted Classic workflow with `/resume-devflow {task_slug}` on Cod
11799

118100
## See how agents work
119101

120-
The Classic Edition for CodeBuddy includes a local observability dashboard. It turns the workflow evidence into a view of session activity, Token and cost trends, Skill/Rule usage, multi-agent dispatch, and Devflow stage attribution—useful for finding expensive runs, checking whether automation is actually being used, and reviewing how work moved between agents.
102+
The Classic Edition for CodeBuddy includes a local observability dashboard. It turns the workflow evidence into a view of session activity, Token and cost trends, Skill/Rule usage, role dispatch, and Devflow stage attribution—useful for finding expensive runs, checking whether automation is actually being used, and reviewing how work moved between roles.
121103

122104
![LoopForge local agent observability dashboard with demonstration data](docs/assets/agent-observability-dashboard.png)
123105

@@ -151,70 +133,17 @@ LoopForge is especially useful when:
151133

152134
For one-off code completion or a tiny, fully specified edit, using a coding agent directly is often enough. Simple tasks that do enter LoopForge use its streamlined path.
153135

154-
## Use the Portable Edition
155-
156-
The quick start above installs the default Classic Edition, which is the right choice for most users. If you only want the portable Agent Skills workflow, choose the command for your coding agent below. To prevent one coding agent from loading two workflows and mixing their state or artifacts, LoopForge enables only one edition per coding agent in each project. To switch editions, run the new install command with `--force`.
157-
158-
### CodeBuddy
159-
160-
```bash
161-
npx -y loopforge-cli@latest skills install codebuddy
162-
```
163-
164-
Then start a workflow:
165-
166-
```text
167-
/devflow "add status filtering to the order list and cover the API with tests"
168-
```
169-
170-
### Codex
171-
172-
```bash
173-
npx -y loopforge-cli@latest skills install codex
174-
```
136+
## Portable Edition
175137

176-
Then start a workflow:
138+
The Classic Edition from the quick start is the right choice for most users. If you only want the portable Agent Skills workflow, use the Portable Edition. To prevent one coding agent from loading two workflows and mixing their state or artifacts, LoopForge enables only one edition per coding agent in each project. To switch editions, run the new install command with `--force`.
177139

178-
```text
179-
$devflow "add status filtering to the order list and cover the API with tests"
180-
```
181-
182-
### Cursor
183-
184-
```bash
185-
npx -y loopforge-cli@latest skills install cursor
186-
```
187-
188-
Then start a workflow:
189-
190-
```text
191-
/devflow "add status filtering to the order list and cover the API with tests"
192-
```
193-
194-
### Claude Code
195-
196-
```bash
197-
npx -y loopforge-cli@latest skills install claude
198-
```
199-
200-
Then start a workflow:
201-
202-
```text
203-
/devflow "add status filtering to the order list and cover the API with tests"
204-
```
205-
206-
### Pi
207-
208-
```bash
209-
npx -y loopforge-cli@latest skills install pi
210-
pi install npm:pi-subagents
211-
```
212-
213-
Then start a workflow:
214-
215-
```text
216-
/skill:devflow "add status filtering to the order list and cover the API with tests"
217-
```
140+
| Agent | Install | Start a workflow |
141+
| --- | --- | --- |
142+
| CodeBuddy | `npx -y loopforge-cli@latest skills install codebuddy` | `/devflow "<request>"` |
143+
| Codex | `npx -y loopforge-cli@latest skills install codex` | `$devflow "<request>"` |
144+
| Cursor | `npx -y loopforge-cli@latest skills install cursor` | `/devflow "<request>"` |
145+
| Claude Code | `npx -y loopforge-cli@latest skills install claude` | `/devflow "<request>"` |
146+
| Pi | `npx -y loopforge-cli@latest skills install pi`, then `pi install npm:pi-subagents` | `/skill:devflow "<request>"` |
218147

219148
See [`EDITIONS.md`](EDITIONS.md) for the complete boundaries and directory layout.
220149

@@ -226,57 +155,18 @@ For ongoing use, install the CLI globally:
226155
npm install --global loopforge-cli
227156
```
228157

229-
Maintenance commands for the default Classic Edition:
158+
Then maintain an installation with the same agent names as above (`codebuddy`, `codex`, `cursor`, `claude`, and `pi` for the Portable Edition):
230159

231160
```bash
232-
# CodeBuddy
233-
loopforge update codebuddy
234-
loopforge status codebuddy
235-
loopforge uninstall codebuddy
236-
237-
# Codex
238-
loopforge update codex
239-
loopforge status codex
240-
loopforge uninstall codex
241-
242-
# Cursor
243-
loopforge update cursor
244-
loopforge status cursor
245-
loopforge uninstall cursor
246-
247-
# Claude Code
248-
loopforge update claude
249-
loopforge status claude
250-
loopforge uninstall claude
251-
```
161+
# Classic Edition
162+
loopforge update <agent>
163+
loopforge status <agent>
164+
loopforge uninstall <agent>
252165

253-
Maintenance commands for the Portable Edition:
254-
255-
```bash
256-
# CodeBuddy
257-
loopforge skills update codebuddy
258-
loopforge skills status codebuddy
259-
loopforge skills uninstall codebuddy
260-
261-
# Codex
262-
loopforge skills update codex
263-
loopforge skills status codex
264-
loopforge skills uninstall codex
265-
266-
# Cursor
267-
loopforge skills update cursor
268-
loopforge skills status cursor
269-
loopforge skills uninstall cursor
270-
271-
# Claude Code
272-
loopforge skills update claude
273-
loopforge skills status claude
274-
loopforge skills uninstall claude
275-
276-
# Pi
277-
loopforge skills update pi
278-
loopforge skills status pi
279-
loopforge skills uninstall pi
166+
# Portable Edition
167+
loopforge skills update <agent>
168+
loopforge skills status <agent>
169+
loopforge skills uninstall <agent>
280170
```
281171

282172
Installation state is stored in `.devflow/install-state.json`. An update stops instead of overwriting user-modified or conflicting files. Use `--force` only when you intend to replace conflicts or switch editions, preferably after inspecting `loopforge plan`.

0 commit comments

Comments
 (0)