@pageai/ralph-loop 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +16 -4
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -4,6 +4,9 @@ A long-running AI agent loop. Ralph automates software development tasks by iter
|
|
|
4
4
|
|
|
5
5
|
This is a hackable script so you can configure it to your env and favorite agentic AI CLI. It's set up by default to use Claude Code in a Docker sandbox.
|
|
6
6
|
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
7
10
|
## Quick Start
|
|
8
11
|
|
|
9
12
|
```bash
|
|
@@ -51,9 +54,18 @@ Besides that:
|
|
|
51
54
|
|
|
52
55
|
## Getting Started
|
|
53
56
|
|
|
54
|
-
### Step 1:
|
|
57
|
+
### Step 1: Install Ralph
|
|
58
|
+
|
|
59
|
+
Run this in your project's directory to install Ralph.
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
npx @pageai/ralph-loop
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
### Step 2: Create a PRD + task list
|
|
55
66
|
|
|
56
|
-
Use the `prd-creator` skill to generate a PRD from your requirements
|
|
67
|
+
Use the `prd-creator` skill to generate a PRD from your requirements.<br/>
|
|
68
|
+
Open up Claude Code and prompt it with **your requirements**. Like so:
|
|
57
69
|
|
|
58
70
|
```
|
|
59
71
|
Use the prd-creator skill to help me create a PRD and task list for these requirements:
|
|
@@ -74,7 +86,7 @@ Use the prd-creator skill to help me create a PRD and task list for these requir
|
|
|
74
86
|
// etc.
|
|
75
87
|
```
|
|
76
88
|
|
|
77
|
-
|
|
89
|
+
Then follow the Skill's instructions and verify the PRD and then tasks.<br/>
|
|
78
90
|
**It is highly recommended that you review individual task requirements before starting the loop. Review EACH TASK INDIVIDUALLY.**
|
|
79
91
|
|
|
80
92
|
### Step 3: Set up the agent inside Docker sandbox
|
|
@@ -95,7 +107,7 @@ And follow the instructions to log in into Claude Code.
|
|
|
95
107
|
./ralph.sh -n 50 # Run Ralph Loop with 50 iterations
|
|
96
108
|
```
|
|
97
109
|
|
|
98
|
-
### Adjusting to your language/framework
|
|
110
|
+
### (optional) Adjusting to your language/framework
|
|
99
111
|
|
|
100
112
|
This script assumes the following are installed:
|
|
101
113
|
- [Playwright](https://playwright.dev/) for e2e testing
|