Skip to content

Commit 0baf280

Browse files
Kasper JungeRalphify
authored andcommitted
docs: add ralph add to quick reference and ralph.* placeholders to CLI reference
Closes two gaps from recent features: the quick reference was missing ralph add commands, and the CLI reference placeholders table was missing ralph.name, ralph.iteration, and ralph.max_iterations. Co-authored-by: Ralphify <noreply@ralphify.co>
1 parent fff8d23 commit 0baf280

2 files changed

Lines changed: 8 additions & 0 deletions

File tree

docs/cli.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -213,5 +213,10 @@ If a command exceeds its timeout, the process is killed and the captured output
213213
|---|---|
214214
| `{{ commands.<name> }}` | Output of the named command |
215215
| `{{ args.<name> }}` | Value of the named user argument |
216+
| `{{ ralph.name }}` | Ralph directory name (e.g. `my-ralph`) |
217+
| `{{ ralph.iteration }}` | Current iteration number (1-based) |
218+
| `{{ ralph.max_iterations }}` | Total iterations if `-n` was set, empty otherwise |
219+
220+
`ralph.*` placeholders are automatically available — no frontmatter configuration needed.
216221

217222
Unmatched placeholders resolve to an empty string.

docs/quick-reference.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ ralph init # Scaffold in current directory
2626
ralph new # AI-guided ralph creation
2727
ralph new docs # AI-guided creation with name pre-filled
2828

29+
ralph add owner/repo # Install ralph(s) from a GitHub repo
30+
ralph add owner/repo/my-ralph # Install a specific ralph by name
31+
2932
ralph --version # Show version
3033
```
3134

0 commit comments

Comments
 (0)