Skip to content

Commit eda128a

Browse files
committed
Update README.md
1 parent 4120210 commit eda128a

1 file changed

Lines changed: 20 additions & 12 deletions

File tree

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
Dead simple Bun CLI that runs `codex` and `claude` in a loop. The [main loop](https://github.com/axeldelafosse/loop/blob/main/src/loop/main.ts#L14) is ~50 lines of easy-to-read code.
44

5+
```bash
6+
curl -fsSL https://raw.githubusercontent.com/axeldelafosse/loop/main/install.sh | bash
7+
```
8+
9+
```bash
10+
loop --prompt "Implement {feature}" --proof "Use {skill} to verify your changes" --worktree
11+
```
12+
513
## What this is
614

715
This _is_ a "meta agent loop" to help coding agents become long-running agents. Stop baby sitting your agents: let them iterate on tasks with clear proof requirements until they are done. Run multiple reviews to continue the feedback loop.
@@ -52,22 +60,22 @@ Installer currently supports macOS and Linux and installs to `~/.local/bin/loop`
5260

5361
```bash
5462
# run from source
55-
./loop.ts --prompt "Implement feature X" --proof "Use X skill to verify your changes"
63+
./loop.ts --prompt "Implement {feature}" --proof "Use {skill} to verify your changes"
5664

5765
# open live panel of running claude/codex instances
5866
./loop.ts
5967

6068
# build executable
6169
bun run build
62-
./loop --prompt "Implement feature X" --proof "Use X skill to verify your changes"
70+
./loop --prompt "Implement {feature}" --proof "Use {skill} to verify your changes"
6371

6472
# same live panel behavior on built binary
6573
./loop
6674
```
6775

6876
Some notes:
6977

70-
- You can pass prompt text positionally (`loop "Implement feature X"`) or via `--prompt`.
78+
- You can pass prompt text positionally (`loop "Implement {feature}"`) or via `--prompt`.
7179
- `--proof` is required and should describe how to prove the task works (tests, commands, and checks to run). You should be super specific based on the prompt.
7280
- If the input is plain text (not a `.md` path), `loop` first runs a planning step to create `PLAN.md`, then uses `PLAN.md` for the main loop.
7381
- Running with no args opens the live panel. To run the loop with `PLAN.md`, pass at least `--proof`.
@@ -145,31 +153,31 @@ When running from source (`bun src/loop.ts`), auto-update is disabled — use `g
145153

146154
```bash
147155
# use PLAN.md automatically
148-
./loop --proof "Use X skill to verify your changes"
156+
./loop --proof "Use {skill} to verify your changes"
149157

150158
# two iteration, raw JSON/event output
151-
./loop -m 2 --proof "Use X skill to verify your changes" "Implement feature X" --format raw
159+
./loop -m 2 --proof "Use {skill} to verify your changes" "Implement {feature}" --format raw
152160

153161
# plain text prompt: auto-creates PLAN.md, then runs from PLAN.md
154-
./loop --proof "Use X skill to verify your changes" "Implement feature X"
162+
./loop --proof "Use {skill} to verify your changes" "Implement {feature}"
155163

156164
# run with claude
157-
./loop --proof "Use X skill to verify your changes" --agent claude --prompt PLAN.md
165+
./loop --proof "Use {skill} to verify your changes" --agent claude --prompt PLAN.md
158166

159167
# run review with a single reviewer
160-
./loop --proof "Use X skill to verify your changes" "Implement feature X" --review codex
168+
./loop --proof "Use {skill} to verify your changes" "Implement {feature}" --review codex
161169

162170
# run claudex reviewers when done (default behavior)
163-
./loop --proof "Use X skill to verify your changes" "Implement feature X" --review claudex
171+
./loop --proof "Use {skill} to verify your changes" "Implement {feature}" --review claudex
164172

165173
# run in detached tmux session (good for SSH)
166-
./loop --tmux --proof "Use X skill to verify your changes" "Implement feature X"
174+
./loop --tmux --proof "Use {skill} to verify your changes" "Implement {feature}"
167175

168176
# run in a fresh git worktree automatically
169-
./loop --worktree --proof "Use X skill to verify your changes" "Implement feature X"
177+
./loop --worktree --proof "Use {skill} to verify your changes" "Implement {feature}"
170178

171179
# run in detached tmux session in a fresh git worktree automatically
172-
./loop --tmux --worktree --proof "Use X skill to verify your changes" "Implement feature X"
180+
./loop --tmux --worktree --proof "Use {skill} to verify your changes" "Implement {feature}"
173181
```
174182

175183
## License

0 commit comments

Comments
 (0)