Skip to content

Commit 1403d11

Browse files
Kasper JungeRalphify
authored andcommitted
docs: add ralph add callout to getting-started guide
New users following the tutorial had no way to discover `ralph add` for installing shared ralphs from GitHub. Added a tip callout after Step 2 pointing to the feature and CLI reference. Co-authored-by: Ralphify <noreply@ralphify.co>
1 parent 94c46f4 commit 1403d11

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

docs/getting-started.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,15 @@ This creates `my-ralph/RALPH.md` with a ready-to-customize template including an
3838

3939
Alternatively, use `ralph new` for AI-guided setup, or create the file manually as shown below.
4040

41+
!!! tip "Installing an existing ralph?"
42+
If someone has shared a ralph on GitHub, skip the manual setup and install it directly:
43+
44+
```bash
45+
ralph add owner/repo
46+
```
47+
48+
This installs to `.ralphify/ralphs/` so you can run it by name with `ralph run <name>`. See the [CLI reference](cli.md#ralph-add) for all source formats.
49+
4150
### Manual setup
4251

4352
Create a ralph directory and `RALPH.md` with the agent field — this is the only required frontmatter:

0 commit comments

Comments
 (0)