Skip to content

Commit dd468e6

Browse files
Kasper JungeRalphify
authored andcommitted
docs: add ralph add source formats table to quick reference
The quick reference had ralph add in the CLI commands section but only as example lines — users had to jump to cli.md for the format details. Added a dedicated table so the "bookmarkable" page covers all formats. Co-authored-by: Ralphify <noreply@ralphify.co>
1 parent 80132f9 commit dd468e6

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

docs/quick-reference.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,17 @@ Each iteration:
148148
- The prompt body is re-read from disk every iteration — edit the prompt while the loop runs (frontmatter is parsed once at startup)
149149
- HTML comments (`<!-- ... -->`) are stripped from the prompt — use them for notes to yourself
150150

151+
## `ralph add` source formats
152+
153+
| Format | Example | What it does |
154+
|---|---|---|
155+
| Shorthand | `owner/repo` | Installs all ralphs in the repo (or the repo itself if root has `RALPH.md`) |
156+
| Subpath | `owner/repo/my-ralph` | Installs the ralph named `my-ralph` from the repo |
157+
| Full URL | `https://github.com/owner/repo` | Same as shorthand |
158+
| GitHub tree URL | `https://github.com/owner/repo/tree/main/my-ralph` | Extracts the path from the URL — works when you copy a URL from the GitHub browser UI |
159+
160+
Installed ralphs go to `.ralphify/ralphs/<name>/`. Re-running `ralph add` overwrites without warning (that's how you update).
161+
151162
## Common patterns
152163

153164
### Minimal ralph

0 commit comments

Comments
 (0)