ralphie 1.0.0 → 1.1.0

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 CHANGED
@@ -13,8 +13,8 @@
13
13
  Ralphie runs AI in a loop until your project is done. Based on the [Ralph Wiggum technique](https://github.com/ghuntley/how-to-ralph-wiggum): describe what you want → AI builds it task by task → each task gets committed → come back to working code.
14
14
 
15
15
  ```bash
16
- ralphie spec "Todo app with auth" # AI interviews you, creates SPEC.md
17
- ralphie run --all # Builds until done
16
+ /ralphie-spec "Todo app with auth" # AI interviews you, creates spec
17
+ ralphie run --all # Builds until done
18
18
  ```
19
19
 
20
20
  ## Quick Start
@@ -33,21 +33,36 @@ curl -fsSL https://anthropic.com/install-claude.sh | sh
33
33
 
34
34
  # Or Codex
35
35
  npm install -g @openai/codex && export OPENAI_API_KEY=sk-...
36
+
37
+ # Or OpenCode
38
+ npm install -g opencode-ai && opencode auth login
39
+ ```
40
+
41
+ **3. Install Ralphie skills** (in your AI tool)
42
+
43
+ ```bash
44
+ npx add-skill skylarbarrera/ralphie
36
45
  ```
37
46
 
38
- **3. Build something**
47
+ **4. Build something**
39
48
 
40
49
  ```bash
41
- ralphie spec "REST API with JWT auth" # Creates SPEC.md
42
- ralphie run --all # Builds it
43
- git log --oneline # See what was built
50
+ # Option A: Interactive (user present) - run in Claude/Codex/OpenCode:
51
+ /ralphie-spec "REST API with JWT auth"
52
+
53
+ # Option B: Autonomous (unattended) - run from CLI:
54
+ ralphie spec "REST API with JWT auth"
55
+
56
+ # Then run the loop:
57
+ ralphie run --all # Builds it
58
+ git log --oneline # See what was built
44
59
  ```
45
60
 
46
61
  ## How It Works
47
62
 
48
63
  Each iteration:
49
64
  1. Fresh context (no accumulated confusion)
50
- 2. Reads SPEC.md → picks next unchecked task
65
+ 2. Reads spec → picks next pending task
51
66
  3. Implements, tests, commits
52
67
  4. Exits → loop restarts clean
53
68
 
@@ -55,34 +70,72 @@ Each iteration:
55
70
 
56
71
  ## Commands
57
72
 
73
+ ### CLI Commands
74
+
58
75
  | Command | Description |
59
76
  |---------|-------------|
60
- | `ralphie spec "desc"` | Generate SPEC via AI interview |
77
+ | `ralphie spec "desc"` | Generate spec autonomously (no user interaction) |
61
78
  | `ralphie run` | Run one iteration |
62
79
  | `ralphie run -n 5` | Run 5 iterations |
63
- | `ralphie run --all` | Run until SPEC complete |
80
+ | `ralphie run --all` | Run until spec complete |
64
81
  | `ralphie run --greedy` | Multiple tasks per iteration |
65
82
  | `ralphie run --headless` | JSON output for CI/CD |
66
83
  | `ralphie init` | Add to existing project |
67
- | `ralphie validate` | Check SPEC format |
84
+ | `ralphie validate` | Check spec format |
85
+ | `ralphie status` | Show progress of active spec |
86
+ | `ralphie spec-list` | List active and completed specs |
87
+ | `ralphie archive` | Move completed spec to archive |
88
+
89
+ Use `--harness codex` or `--harness opencode` to switch AI providers. See [CLI Reference](docs/cli.md) for all options.
90
+
91
+ ### Skills (installed via `npx add-skill`)
68
92
 
69
- Use `--harness codex` to switch AI providers. See [CLI Reference](docs/cli.md) for all options.
93
+ | Skill | Description |
94
+ |-------|-------------|
95
+ | `/ralphie-spec` | Generate spec through user interview (requires user) |
96
+ | `/review-spec` | Validate spec format and content |
97
+ | `/ralphie-iterate` | Execute one iteration (used by `ralphie run`) |
98
+ | `/verify` | Pre-commit verification |
70
99
 
71
- ## SPEC Format
100
+ Install all skills: `npx add-skill skylarbarrera/ralphie`
72
101
 
73
- Ralphie works from a `SPEC.md` checklist:
102
+ ## Spec Format
103
+
104
+ Ralphie works from structured specs in `specs/active/`:
74
105
 
75
106
  ```markdown
76
107
  # My Project
77
108
 
78
- - [ ] Set up Express with TypeScript
79
- - [ ] Create User model with bcrypt
80
- - [ ] Add /auth/login endpoint
81
- - [ ] Add /auth/register endpoint
82
- - [ ] Write tests
109
+ Goal: Build a REST API with authentication
110
+
111
+ ## Tasks
112
+
113
+ ### T001: Set up Express with TypeScript
114
+ - Status: pending
115
+ - Size: M
116
+
117
+ **Deliverables:**
118
+ - Initialize npm project with TypeScript
119
+ - Configure Express server
120
+ - Add basic health check endpoint
121
+
122
+ **Verify:** `npm run build && npm test`
123
+
124
+ ---
125
+
126
+ ### T002: Create User model
127
+ - Status: pending
128
+ - Size: S
129
+
130
+ **Deliverables:**
131
+ - Define User interface
132
+ - Add bcrypt password hashing
133
+
134
+ **Verify:** `npm test`
83
135
  ```
84
136
 
85
- Tasks get checked off as completed. See [SPEC Guide](docs/spec-guide.md) for best practices.
137
+ Tasks transition from `pending` `in_progress` → `passed`/`failed`. See [Spec Guide](docs/spec-guide.md) for best practices.
138
+
86
139
 
87
140
  ## Troubleshooting
88
141
 
@@ -90,19 +143,23 @@ Tasks get checked off as completed. See [SPEC Guide](docs/spec-guide.md) for bes
90
143
  |---------|----------|
91
144
  | `command not found: ralphie` | `npm install -g ralphie` |
92
145
  | `command not found: claude` | `export PATH="$HOME/.local/bin:$PATH"` |
93
- | Stuck on same task | Check `- [ ]` format. Run `ralphie validate` |
146
+ | `Missing ANTHROPIC_API_KEY` | `export ANTHROPIC_API_KEY=sk-ant-...` (add to .zshrc) |
147
+ | `Missing OPENAI_API_KEY` | `export OPENAI_API_KEY=sk-...` (add to .zshrc) |
148
+ | Stuck on same task | Check task status. Run `ralphie validate` |
149
+ | No spec found | `/ralphie-spec` (with user) or `ralphie spec` (autonomous) |
94
150
 
95
151
  ## Documentation
96
152
 
97
153
  - [CLI Reference](docs/cli.md) — All commands and options
98
- - [SPEC Guide](docs/spec-guide.md) — Writing effective SPECs
154
+ - [Spec Guide](docs/spec-guide.md) — Writing effective specs
155
+ - [Skills](skills/SKILLS.md) — Installing and using Ralphie skills
99
156
  - [Architecture](docs/architecture.md) — How the loop works
100
157
  - [Harnesses](docs/harnesses.md) — Multi-AI provider support
101
158
 
102
159
  ## Requirements
103
160
 
104
161
  - Node.js 18+
105
- - Claude Code CLI or OpenAI Codex CLI
162
+ - Claude Code CLI, OpenAI Codex CLI, or OpenCode CLI
106
163
  - Git
107
164
 
108
165
  ## License