ralph-teams 1.0.12 → 1.0.13
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/LICENSE +21 -0
- package/README.md +9 -18
- package/package.json +1 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Tuan Son Dinh
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,22 +1,24 @@
|
|
|
1
1
|
# ralph-teams
|
|
2
2
|
|
|
3
|
-
Ralph-Teams loops epics not User stories! It leverages the inbuilt Agent Teams of Claude/Codex/Copilot. Each epic gets tackled by a Team with in a new Session (Iteration).
|
|
4
3
|
|
|
5
|
-
`ralph-teams` is a CLI for running Ralph Teams: a shell-based orchestrator that reads a `prd.json`, loops through epics, and spawns AI coding agent teams to implement work story by story.
|
|
6
|
-
|
|
7
|
-
Experimental: Ralph-Teams can work on epic in parallel for epics, which are not interdependent
|
|
4
|
+
`ralph-teams` is a CLI for running Ralph Teams: a shell-based orchestrator that initializes and reads a `prd.json`, loops through epics (not user stories), and spawns AI coding agent teams to implement work story by story. One Agent Team per Epic with fresh context. Ralph-Teams can even work on multiple epics in parallel, if there are no dependencies
|
|
8
5
|
```bash
|
|
9
|
-
ralph-teams run --parallel=
|
|
6
|
+
ralph-teams run --parallel={max_parallel_epics}
|
|
10
7
|
```
|
|
11
8
|
|
|
12
9
|
## Quickest Start
|
|
13
10
|
|
|
14
11
|
```bash
|
|
15
|
-
|
|
12
|
+
npm install -g ralph-teams
|
|
13
|
+
|
|
14
|
+
# discuss with an agent and create the prd.json (epics and user stories)
|
|
16
15
|
ralph-teams init
|
|
17
16
|
|
|
18
17
|
# start the loop, by default uses claude
|
|
19
18
|
ralph-teams run
|
|
19
|
+
|
|
20
|
+
# optionally before run, you can also plan epics before hand, otherwise this will be done automatically by the planner:
|
|
21
|
+
ralph-teams plan
|
|
20
22
|
```
|
|
21
23
|
|
|
22
24
|
## Flow
|
|
@@ -45,16 +47,6 @@ flowchart TB
|
|
|
45
47
|
Q -->|No| R[Finish run]
|
|
46
48
|
```
|
|
47
49
|
|
|
48
|
-
# Quick Start:
|
|
49
|
-
```bash
|
|
50
|
-
npm install -g ralph-teams
|
|
51
|
-
|
|
52
|
-
ralph-teams init
|
|
53
|
-
|
|
54
|
-
ralph-teams run --backend claude
|
|
55
|
-
ralph-teams run --backend codex
|
|
56
|
-
ralph-teams run --backend copilot
|
|
57
|
-
```
|
|
58
50
|
## What It Does
|
|
59
51
|
|
|
60
52
|
The system has two layers:
|
|
@@ -64,7 +56,7 @@ The system has two layers:
|
|
|
64
56
|
- `team-lead` coordinates the epic
|
|
65
57
|
- `planner` creates the implementation plan
|
|
66
58
|
- `builder` makes changes and runs tests
|
|
67
|
-
- `validator` verifies the result independently
|
|
59
|
+
- `validator` verifies the result independently, pushes backes (by default: 1 pushback max )
|
|
68
60
|
|
|
69
61
|
Across all backends, `builder` and `validator` are one-shot story-scoped workers. The Team Lead must spawn a fresh Builder for each story attempt, spawn a fresh Validator when verification needs an independent agent, and never treat idle/task-lifecycle output as completion. A build attempt only counts when the Builder returns a concrete commit SHA and the Team Lead persists the story result to the epic state file at `.ralph-teams/state/{epic-id}.json`.
|
|
70
62
|
|
|
@@ -93,7 +85,6 @@ The runtime is file-based. During a run, Ralph treats these files as the working
|
|
|
93
85
|
- `.ralph-teams/ralph-state.json`: interrupt/resume state
|
|
94
86
|
|
|
95
87
|
|
|
96
|
-
|
|
97
88
|
## Requirements
|
|
98
89
|
|
|
99
90
|
- Node.js 18+
|