Skip to content

Commit 2534a27

Browse files
Kasper Jungeclaude
authored andcommitted
docs: fix broken ralph new check/context commands that no longer exist
The getting-started guide and README referenced `ralph new check <name>`, `ralph new context <name>`, and `ralph new ralph <name>` β€” subcommands that were removed in v0.1.8 when `ralph new` was redesigned as an AI-guided session. New users following the getting-started tutorial would hit errors at step 5. Replaced with manual `mkdir` + file creation instructions, which are predictable and copy-pasteable. Added a tip about `ralph new` as the AI-guided alternative. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent fdda67e commit 2534a27

2 files changed

Lines changed: 15 additions & 12 deletions

File tree

β€ŽREADME.mdβ€Ž

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,10 @@ The simple loop works, but ralphify's real power comes from three primitives tha
115115
Checks validate the agent's work after each iteration. When one fails, its output automatically feeds into the next iteration so the agent can fix its own mistakes.
116116

117117
```bash
118-
ralph new check tests
118+
mkdir -p .ralphify/checks/tests
119119
```
120120

121-
Edit `.ralphify/checks/tests/CHECK.md`:
121+
Create `.ralphify/checks/tests/CHECK.md`:
122122

123123
```markdown
124124
---
@@ -143,10 +143,10 @@ You define what "valid" means. Ralphify feeds failures back automatically.
143143
Contexts inject fresh data into the prompt each iteration β€” git history, test status, anything a shell command can produce.
144144

145145
```bash
146-
ralph new context git-log
146+
mkdir -p .ralphify/contexts/git-log
147147
```
148148

149-
Edit `.ralphify/contexts/git-log/CONTEXT.md`:
149+
Create `.ralphify/contexts/git-log/CONTEXT.md`:
150150

151151
```markdown
152152
---
@@ -162,8 +162,8 @@ The command runs before each iteration. Use `{{ contexts.git-log }}` in your `RA
162162
Keep multiple ralphs for different jobs and switch between them at run time:
163163

164164
```bash
165-
ralph new ralph docs
166-
ralph new ralph refactor
165+
ralph new docs
166+
ralph new refactor
167167
```
168168

169169
Edit `.ralphify/ralphs/docs/RALPH.md` with your documentation-focused prompt, then:

β€Ždocs/getting-started.mdβ€Ž

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -103,10 +103,10 @@ Checks run **after** each iteration to validate the agent's work. If a check fai
103103
Create a check that runs your test suite:
104104

105105
```bash
106-
ralph new check tests
106+
mkdir -p .ralphify/checks/tests
107107
```
108108

109-
This creates `.ralphify/checks/tests/CHECK.md`. Edit it:
109+
Create `.ralphify/checks/tests/CHECK.md`:
110110

111111
```markdown
112112
---
@@ -125,10 +125,10 @@ The text below the frontmatter is the **failure instruction** β€” it gets includ
125125
Add a second check for linting:
126126

127127
```bash
128-
ralph new check lint
128+
mkdir -p .ralphify/checks/lint
129129
```
130130

131-
Edit `.ralphify/checks/lint/CHECK.md`:
131+
Create `.ralphify/checks/lint/CHECK.md`:
132132

133133
```markdown
134134
---
@@ -144,10 +144,10 @@ Fix all lint errors. Do not suppress warnings with noqa comments.
144144
Contexts inject dynamic data into the prompt before each iteration. A useful default is recent git history β€” it helps the agent understand what's already been done.
145145

146146
```bash
147-
ralph new context git-log
147+
mkdir -p .ralphify/contexts/git-log
148148
```
149149

150-
Edit `.ralphify/contexts/git-log/CONTEXT.md`:
150+
Create `.ralphify/contexts/git-log/CONTEXT.md`:
151151

152152
```markdown
153153
---
@@ -160,6 +160,9 @@ enabled: true
160160

161161
The command runs each iteration and its output is appended to the prompt. The body text ("## Recent commits") appears above the command output as a label.
162162

163+
!!! tip "Use `ralph new` for AI-guided setup"
164+
Instead of creating primitive files manually, you can run `ralph new` to launch an AI-guided session that creates a complete ralph β€” prompt, checks, and contexts β€” via conversation with your agent.
165+
163166
### Declare your primitives and place the context
164167

165168
Checks and contexts must be **declared** in your ralph file's frontmatter before they'll run. Now that you've created all three primitives, update `RALPH.md` to declare them and place the context:

0 commit comments

Comments
Β (0)