Skip to content

Commit 1c28290

Browse files
Kasper JungeRalphify
authored andcommitted
docs: update CLI output examples to match actual console rendering
The output examples in the landing page, getting-started guide, and README showed stale formatting that didn't match what users actually see β€” missing run header, wrong log file line format, and "iteration(s)" instead of the pluralized form the code produces. Co-authored-by: Ralphify <noreply@ralphify.co>
1 parent e6fe619 commit 1c28290

3 files changed

Lines changed: 27 additions & 15 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,9 @@ Each iteration:
8585
```
8686
$ ralph run my-ralph -n 3
8787
88+
β–Ά Running: my-ralph
89+
1 command Β· max 3 iterations
90+
8891
── Iteration 1 ──
8992
Commands: 1 ran
9093
βœ“ Iteration 1 completed (52.3s)
@@ -97,7 +100,8 @@ $ ralph run my-ralph -n 3
97100
Commands: 1 ran
98101
βœ“ Iteration 3 completed (41.7s)
99102
100-
Done: 3 iteration(s) β€” 2 succeeded, 1 failed
103+
──────────────────────
104+
Done: 3 iterations β€” 2 succeeded, 1 failed
101105
```
102106

103107
## The technique

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

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -194,22 +194,26 @@ ralph run my-ralph -n 3 --log-dir ralph_logs
194194
Watch the output. Each iteration runs the commands, assembles the prompt with the command output, and pipes it to the agent:
195195

196196
```
197+
β–Ά Running: my-ralph
198+
3 commands Β· max 3 iterations
199+
197200
── Iteration 1 ──
198201
Commands: 3 ran
199-
βœ“ Iteration 1 completed (45.2s) β†’
200-
ralph_logs/001_20250115-142301.log
202+
βœ“ Iteration 1 completed (45.2s)
203+
β†’ ralph_logs/001_20250115-142301.log
201204
202205
── Iteration 2 ──
203206
Commands: 3 ran
204-
βœ— Iteration 2 failed with exit code 1 (23.1s) β†’
205-
ralph_logs/002_20250115-142512.log
207+
βœ— Iteration 2 failed with exit code 1 (23.1s)
208+
β†’ ralph_logs/002_20250115-142512.log
206209
207210
── Iteration 3 ──
208211
Commands: 3 ran
209-
βœ“ Iteration 3 completed (38.5s) β†’
210-
ralph_logs/003_20250115-142812.log
212+
βœ“ Iteration 3 completed (38.5s)
213+
β†’ ralph_logs/003_20250115-142812.log
211214
212-
Done: 3 iteration(s) β€” 2 succeeded, 1 failed
215+
──────────────────────
216+
Done: 3 iterations β€” 2 succeeded, 1 failed
213217
```
214218

215219
If the agent breaks a test, the next iteration sees the failure output via `{{ commands.tests }}` and fixes it automatically.

β€Ždocs/index.mdβ€Ž

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -103,22 +103,26 @@ ralph run my-ralph -n 3 # Run 3 iterations
103103
```
104104
$ ralph run my-ralph -n 3 --log-dir ralph_logs
105105
106+
β–Ά Running: my-ralph
107+
2 commands Β· max 3 iterations
108+
106109
── Iteration 1 ──
107110
Commands: 2 ran
108-
βœ“ Iteration 1 completed (52.3s) β†’
109-
ralph_logs/001_20250115-142301.log
111+
βœ“ Iteration 1 completed (52.3s)
112+
β†’ ralph_logs/001_20250115-142301.log
110113
111114
── Iteration 2 ──
112115
Commands: 2 ran
113-
βœ— Iteration 2 failed with exit code 1 (23.1s) β†’
114-
ralph_logs/002_20250115-142512.log
116+
βœ— Iteration 2 failed with exit code 1 (23.1s)
117+
β†’ ralph_logs/002_20250115-142512.log
115118
116119
── Iteration 3 ──
117120
Commands: 2 ran
118-
βœ“ Iteration 3 completed (41.7s) β†’
119-
ralph_logs/003_20250115-143012.log
121+
βœ“ Iteration 3 completed (41.7s)
122+
β†’ ralph_logs/003_20250115-143012.log
120123
121-
Done: 3 iteration(s) β€” 2 succeeded, 1 failed
124+
──────────────────────
125+
Done: 3 iterations β€” 2 succeeded, 1 failed
122126
```
123127

124128
Edit `RALPH.md` while the loop is running β€” changes take effect on the next iteration.

0 commit comments

Comments
Β (0)