Skip to content

Commit 087f240

Browse files
Kasper JungeRalphify
authored andcommitted
docs: mention live output streaming in getting-started tutorial
Users running `ralph run` for the first time will see the agent's output streaming live between iteration markers β€” the tutorial didn't mention this, leaving a gap between what the page shows and what users actually experience. Added a brief note about live peek and the `p` toggle in Step 6. Co-authored-by: Ralphify <noreply@ralphify.co>
1 parent 13d3658 commit 087f240

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

β€Ždocs/getting-started.mdβ€Ž

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,8 @@ Watch the output. Each iteration runs the commands, assembles the prompt with th
247247
Done: 3 iterations β€” 2 succeeded, 1 failed
248248
```
249249

250+
The agent's output streams live to your terminal between the iteration markers β€” you can watch it work in real time. Press `p` to silence the stream if you prefer a quieter loop, and `p` again to resume.
251+
250252
If the agent breaks a test, the next iteration sees the failure output via `{{ commands.tests }}` and fixes it automatically.
251253

252254
Once you're confident the loop works, drop the `-n 3` to let it run indefinitely. Press `Ctrl+C` to stop.
@@ -269,14 +271,13 @@ When you want to shift focus, change the task:
269271
Read TODO.md and focus only on the API module.
270272
```
271273

272-
This is the most powerful part of ralph loops β€” you're steering a running agent with a text file. See [Tuning a running loop](writing-prompts.md#tuning-a-running-loop) for more patterns.
274+
This is the most powerful part of ralph loops β€” you're steering a running agent with a text file.
273275

274276
!!! warning "Frontmatter changes need a restart"
275277
Only the **prompt body** is re-read each iteration. Frontmatter fields (`agent`, `commands`, `args`) are parsed once at startup. If you add a new command or change the agent, stop the loop with `Ctrl+C` and restart it.
276278

277279
## Next steps
278280

279-
- [Writing Prompts](writing-prompts.md) β€” patterns for writing effective autonomous loop prompts
280281
- [Cookbook](cookbook.md) β€” copy-pasteable setups for coding, docs, research, and more
281282
- [How it Works](how-it-works.md) β€” what happens inside each iteration
282283
- [Troubleshooting](troubleshooting.md) β€” when things don't work as expected

β€Ždocs/llms-full.txtβ€Ž

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -349,6 +349,8 @@ Watch the output. Each iteration runs the commands, assembles the prompt with th
349349
Done: 3 iterations β€” 2 succeeded, 1 failed
350350
```
351351

352+
The agent's output streams live to your terminal between the iteration markers β€” you can watch it work in real time. Press `p` to silence the stream if you prefer a quieter loop, and `p` again to resume.
353+
352354
If the agent breaks a test, the next iteration sees the failure output via `{{ commands.tests }}` and fixes it automatically.
353355

354356
Once you're confident the loop works, drop the `-n 3` to let it run indefinitely. Press `Ctrl+C` to stop.

0 commit comments

Comments
Β (0)