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
Copy file name to clipboardExpand all lines: docs/quick-reference.md
+13-6Lines changed: 13 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,28 +48,35 @@ That's it. A ralph is a directory with a `RALPH.md` file. See [Getting Started](
48
48
49
49
```markdown
50
50
---
51
-
agent: claude -p --dangerously-skip-permissions # Required: agent command
52
-
commands: # Optional: run each iteration
51
+
agent: claude -p --dangerously-skip-permissions # (1)!
52
+
commands: # (2)!
53
53
- name: tests
54
54
run: uv run pytest -x
55
55
- name: lint
56
56
run: uv run ruff check .
57
57
- name: git-log
58
58
run: git log --oneline -10
59
-
args: [dir, focus] # Optional: declared user arguments
59
+
args: [dir, focus]# (3)!
60
60
---
61
61
62
-
# Prompt body
62
+
# Prompt body<!-- (4) -->
63
63
64
-
{{ commands.git-log }}
64
+
{{ commands.git-log }}<!-- (5) -->
65
65
66
66
{{ commands.tests }}
67
67
68
68
{{ commands.lint }}
69
69
70
-
Your instructions here. Use {{ args.dir }} for user arguments.
70
+
Your instructions here. Use {{ args.dir }} for user arguments.<!-- (6) -->
71
71
```
72
72
73
+
1.**Required.** The full shell command to pipe the prompt to. `-p` enables non-interactive mode, `--dangerously-skip-permissions` lets the agent work autonomously.
74
+
2.**Optional.** Each command runs every iteration and its output fills the matching `{{ commands.<name> }}` placeholder.
75
+
3.**Optional.** Declares positional argument names. Named flags (`--dir`, `--focus`) work without this — `args` is only needed for positional usage.
76
+
4. Everything below the `---` frontmatter is the prompt body. It's re-read from disk every iteration, so you can edit it while the loop runs.
77
+
5. Replaced with the command's stdout + stderr. Only commands with a matching placeholder appear in the assembled prompt.
78
+
6. Replaced with the `--dir` value from the CLI. Missing args resolve to an empty string.
0 commit comments