You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: add GitHub tree URL format to ralph add examples
Users browsing a GitHub repo and copying the URL get a /tree/branch/path
format. This is supported by the parser but wasn't shown in any docs
examples, making it a hidden feature. Added it to CLI reference, quick
reference, and troubleshooting.
Co-authored-by: Ralphify <noreply@ralphify.co>
Copy file name to clipboardExpand all lines: docs/cli.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -138,19 +138,21 @@ The command detects your agent and installs a skill to guide the creation proces
138
138
Add a ralph from a GitHub repository. Installs it to `.ralphify/ralphs/<name>/` so you can run it by name.
139
139
140
140
```bash
141
-
ralph add owner/repo # Install repo as a ralph (or all ralphs in the repo)
142
-
ralph add owner/repo/ralph-name # Install a specific ralph by name
143
-
ralph add https://github.com/owner/repo # Full GitHub URL also works
141
+
ralph add owner/repo # Install all ralphs in the repo
142
+
ralph add owner/repo/ralph-name # Specific ralph by name
143
+
ralph add https://github.com/owner/repo # Full GitHub URL
144
+
ralph add https://github.com/owner/repo/tree/main/my-ralph # URL copied from GitHub browser
144
145
```
145
146
146
147
| Argument | Default | Description |
147
148
|---|---|---|
148
-
|`SOURCE`| required | GitHub source: `owner/repo` or `owner/repo/ralph-name`|
149
+
|`SOURCE`| required | GitHub source — shorthand (`owner/repo`), subpath (`owner/repo/path`), or full GitHub URL|
149
150
150
151
**How it resolves:**
151
152
152
153
-`owner/repo` — if the repo root contains `RALPH.md`, installs it as a single ralph named after the repo. Otherwise, finds and installs all ralphs in the repo.
153
154
-`owner/repo/ralph-name` — searches the repo for a directory named `ralph-name` containing `RALPH.md`. If multiple matches are found, prints the paths and asks you to use the full subpath to disambiguate.
155
+
-`https://github.com/owner/repo/tree/branch/path` — extracts the path from the URL. This is the format you get when you copy a URL from the GitHub web UI while browsing a directory. The branch name is used only to locate the path — `ralph add` always clones the default branch.
0 commit comments