specrails-core 3.3.1 → 3.4.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 +76 -48
- package/bin/doctor.sh +1 -1
- package/commands/doctor.md +1 -1
- package/commands/setup.md +70 -70
- package/docs/README.md +3 -2
- package/docs/agents.md +15 -15
- package/docs/changelog.md +20 -20
- package/docs/concepts.md +3 -3
- package/docs/customization.md +18 -5
- package/docs/deployment.md +20 -5
- package/docs/getting-started.md +16 -27
- package/docs/installation.md +81 -48
- package/docs/local-tickets.md +11 -12
- package/docs/migration-guide.md +9 -9
- package/docs/playbook-parallel-dev.md +8 -8
- package/docs/playbook-product-discovery.md +1 -1
- package/docs/plugin-architecture.md +137 -0
- package/docs/research/codex-compatibility-analysis.md +11 -11
- package/docs/research/mcp-feasibility-analysis.md +5 -5
- package/docs/testing/test-matrix-codex.md +1 -1
- package/docs/user-docs/cli-reference.md +57 -57
- package/docs/user-docs/codex-vs-claude-code.md +7 -7
- package/docs/user-docs/faq.md +32 -26
- package/docs/user-docs/getting-started-codex.md +7 -7
- package/docs/user-docs/installation.md +47 -38
- package/docs/user-docs/quick-start.md +20 -26
- package/docs/workflows.md +62 -62
- package/install.sh +3 -3
- package/package.json +1 -1
- package/templates/agents/sr-merge-resolver.md +1 -1
- package/templates/claude-md/CLAUDE-quickstart.md +2 -2
- package/templates/commands/{sr → specrails}/batch-implement.md +18 -18
- package/templates/commands/{sr → specrails}/implement.md +8 -8
- package/templates/commands/{sr → specrails}/memory-inspect.md +3 -3
- package/templates/commands/{sr → specrails}/merge-resolve.md +1 -1
- package/templates/commands/{sr → specrails}/opsx-diff.md +1 -1
- package/templates/commands/{sr → specrails}/product-backlog.md +7 -7
- package/templates/commands/{sr → specrails}/propose-spec.md +1 -1
- package/templates/commands/{sr → specrails}/refactor-recommender.md +1 -1
- package/templates/commands/{sr → specrails}/retry.md +13 -13
- package/templates/commands/{sr → specrails}/team-debug.md +5 -5
- package/templates/commands/{sr → specrails}/team-review.md +4 -4
- package/templates/commands/{sr → specrails}/telemetry.md +2 -2
- package/templates/commands/{sr → specrails}/update-product-driven-backlog.md +2 -2
- package/templates/commands/{sr → specrails}/vpc-drift.md +4 -4
- package/templates/commands/{sr → specrails}/why.md +5 -5
- package/templates/commands/test.md +2 -2
- package/templates/skills/sr-batch-implement/SKILL.md +18 -18
- package/templates/skills/sr-implement/SKILL.md +8 -8
- package/templates/skills/sr-product-backlog/SKILL.md +7 -7
- package/templates/skills/sr-refactor-recommender/SKILL.md +1 -1
- package/templates/skills/sr-update-backlog/SKILL.md +2 -2
- package/templates/skills/sr-why/SKILL.md +5 -5
- package/update.sh +2 -2
- /package/templates/commands/{sr → specrails}/compat-check.md +0 -0
- /package/templates/commands/{sr → specrails}/health-check.md +0 -0
package/docs/agents.md
CHANGED
|
@@ -21,7 +21,7 @@ The result: better quality at every stage, with clear accountability.
|
|
|
21
21
|
|-|-|
|
|
22
22
|
| **Color** | Blue |
|
|
23
23
|
| **Model** | Opus (creative reasoning) |
|
|
24
|
-
| **Trigger** | `/opsx:explore`, `/
|
|
24
|
+
| **Trigger** | `/opsx:explore`, `/specrails:update-product-driven-backlog` |
|
|
25
25
|
| **Role** | Feature ideation and product strategy |
|
|
26
26
|
|
|
27
27
|
The Product Manager is the **starting point** of the pipeline. It researches your competitive landscape (via web search), evaluates ideas against your user personas using the VPC framework, and produces prioritized feature recommendations.
|
|
@@ -42,7 +42,7 @@ The Product Manager is the **starting point** of the pipeline. It researches you
|
|
|
42
42
|
|-|-|
|
|
43
43
|
| **Color** | Cyan |
|
|
44
44
|
| **Model** | Haiku (fast, read-only) |
|
|
45
|
-
| **Trigger** | `/
|
|
45
|
+
| **Trigger** | `/specrails:product-backlog` |
|
|
46
46
|
| **Role** | Backlog analysis and reporting |
|
|
47
47
|
|
|
48
48
|
The Product Analyst is a **read-only** agent. It reads your backlog, specs, and archived changes to produce structured reports. It never writes code or makes decisions — it just gives you the data.
|
|
@@ -62,7 +62,7 @@ The Product Analyst is a **read-only** agent. It reads your backlog, specs, and
|
|
|
62
62
|
|-|-|
|
|
63
63
|
| **Color** | Green |
|
|
64
64
|
| **Model** | Sonnet |
|
|
65
|
-
| **Trigger** | `/opsx:ff`, `/opsx:continue`, `/
|
|
65
|
+
| **Trigger** | `/opsx:ff`, `/opsx:continue`, `/specrails:implement` (Phase 3a) |
|
|
66
66
|
| **Role** | System design and task breakdown |
|
|
67
67
|
|
|
68
68
|
The Architect translates **what to build** into **how to build it**. It reads the relevant specs, analyzes the codebase, and produces a detailed implementation design with ordered tasks.
|
|
@@ -76,7 +76,7 @@ The Architect translates **what to build** into **how to build it**. It reads th
|
|
|
76
76
|
- Risks and considerations
|
|
77
77
|
- Backwards compatibility impact report (Phase 6 auto-check against API surface)
|
|
78
78
|
|
|
79
|
-
The Architect also records decision rationale in `.claude/agent-memory/explanations/` — queryable later with `/
|
|
79
|
+
The Architect also records decision rationale in `.claude/agent-memory/explanations/` — queryable later with `/specrails:why`.
|
|
80
80
|
|
|
81
81
|
---
|
|
82
82
|
|
|
@@ -86,7 +86,7 @@ The Architect also records decision rationale in `.claude/agent-memory/explanati
|
|
|
86
86
|
|-|-|
|
|
87
87
|
| **Color** | Purple |
|
|
88
88
|
| **Model** | Sonnet |
|
|
89
|
-
| **Trigger** | `/opsx:apply`, `/
|
|
89
|
+
| **Trigger** | `/opsx:apply`, `/specrails:implement` (Phase 3b) |
|
|
90
90
|
| **Role** | Full-stack implementation |
|
|
91
91
|
|
|
92
92
|
The Developer is the **workhorse**. It reads the Architect's design, loads the relevant layer conventions, and writes production-quality code across all layers. It follows a strict process: understand, plan, implement, verify.
|
|
@@ -106,7 +106,7 @@ Before starting implementation, the Developer reads any **failure records** from
|
|
|
106
106
|
|-|-|
|
|
107
107
|
| **Colors** | Purple (backend), Blue (frontend) |
|
|
108
108
|
| **Model** | Sonnet |
|
|
109
|
-
| **Trigger** | `/
|
|
109
|
+
| **Trigger** | `/specrails:implement` with parallel pipeline |
|
|
110
110
|
| **Role** | Layer-specific implementation |
|
|
111
111
|
|
|
112
112
|
For large full-stack features, SpecRails can split work between **Backend Developer** and **Frontend Developer** running in **parallel git worktrees**. Each has a lighter prompt focused on their stack and runs only the relevant CI checks.
|
|
@@ -121,7 +121,7 @@ For large full-stack features, SpecRails can split work between **Backend Develo
|
|
|
121
121
|
|-|-|
|
|
122
122
|
| **Color** | Cyan |
|
|
123
123
|
| **Model** | Sonnet |
|
|
124
|
-
| **Trigger** | `/
|
|
124
|
+
| **Trigger** | `/specrails:implement` (Phase 3c) |
|
|
125
125
|
| **Role** | Automated test generation |
|
|
126
126
|
|
|
127
127
|
After the Developer finishes, the Test Writer generates comprehensive tests for the new code. It auto-detects your test framework, reads 3 existing tests to learn your patterns, and targets >80% coverage of new code.
|
|
@@ -143,7 +143,7 @@ After the Developer finishes, the Test Writer generates comprehensive tests for
|
|
|
143
143
|
|-|-|
|
|
144
144
|
| **Color** | Yellow |
|
|
145
145
|
| **Model** | Sonnet |
|
|
146
|
-
| **Trigger** | `/
|
|
146
|
+
| **Trigger** | `/specrails:implement` (Phase 3d) |
|
|
147
147
|
| **Role** | Keep documentation in sync with code |
|
|
148
148
|
|
|
149
149
|
Doc Sync detects and updates your project's documentation after implementation:
|
|
@@ -162,7 +162,7 @@ Doc Sync detects and updates your project's documentation after implementation:
|
|
|
162
162
|
|-|-|
|
|
163
163
|
| **Color** | Cyan |
|
|
164
164
|
| **Model** | Sonnet |
|
|
165
|
-
| **Trigger** | `/
|
|
165
|
+
| **Trigger** | `/specrails:implement` (Phase 4b, parallel) |
|
|
166
166
|
| **Role** | Frontend-specific quality audit |
|
|
167
167
|
|
|
168
168
|
The Frontend Reviewer runs in parallel with the Backend Reviewer during Phase 4b, specializing in client-side concerns that a generalist reviewer might miss.
|
|
@@ -180,7 +180,7 @@ The Frontend Reviewer runs in parallel with the Backend Reviewer during Phase 4b
|
|
|
180
180
|
|-|-|
|
|
181
181
|
| **Color** | Cyan |
|
|
182
182
|
| **Model** | Sonnet |
|
|
183
|
-
| **Trigger** | `/
|
|
183
|
+
| **Trigger** | `/specrails:implement` (Phase 4b, parallel) |
|
|
184
184
|
| **Role** | Backend-specific quality audit |
|
|
185
185
|
|
|
186
186
|
The Backend Reviewer runs in parallel with the Frontend Reviewer during Phase 4b, specializing in server-side concerns.
|
|
@@ -199,7 +199,7 @@ The Backend Reviewer runs in parallel with the Frontend Reviewer during Phase 4b
|
|
|
199
199
|
|-|-|
|
|
200
200
|
| **Color** | Orange |
|
|
201
201
|
| **Model** | Sonnet |
|
|
202
|
-
| **Trigger** | `/
|
|
202
|
+
| **Trigger** | `/specrails:implement` (Phase 4) |
|
|
203
203
|
| **Role** | Security audit |
|
|
204
204
|
|
|
205
205
|
The Security Reviewer scans new code for:
|
|
@@ -221,7 +221,7 @@ You can suppress known false positives via `.claude/security-exemptions.yaml`.
|
|
|
221
221
|
|-|-|
|
|
222
222
|
| **Color** | Red |
|
|
223
223
|
| **Model** | Sonnet |
|
|
224
|
-
| **Trigger** | `/
|
|
224
|
+
| **Trigger** | `/specrails:implement` (Phase 4b), after all developers complete |
|
|
225
225
|
| **Role** | Final quality gate |
|
|
226
226
|
|
|
227
227
|
The Reviewer is the **last agent before ship**. It:
|
|
@@ -251,7 +251,7 @@ The Reviewer is the **last agent before ship**. It:
|
|
|
251
251
|
|-|-|
|
|
252
252
|
| **Color** | Yellow |
|
|
253
253
|
| **Model** | Sonnet |
|
|
254
|
-
| **Trigger** | `/
|
|
254
|
+
| **Trigger** | `/specrails:merge-resolve`, `/specrails:implement` (Phase 4a, after worktree merge) |
|
|
255
255
|
| **Role** | AI-powered merge conflict resolution |
|
|
256
256
|
|
|
257
257
|
When a multi-feature pipeline merges worktrees and produces conflict markers, the Merge Resolver analyzes each conflict block using the OpenSpec context bundles from both features. It applies resolutions where confidence is high enough and leaves clean markers for the conflicts it cannot safely resolve.
|
|
@@ -273,7 +273,7 @@ When a multi-feature pipeline merges worktrees and produces conflict markers, th
|
|
|
273
273
|
|-|-|
|
|
274
274
|
| **Color** | Yellow |
|
|
275
275
|
| **Model** | Sonnet |
|
|
276
|
-
| **Trigger** | `/
|
|
276
|
+
| **Trigger** | `/specrails:implement` (Phase 4, after Security Reviewer) |
|
|
277
277
|
| **Role** | Performance regression detection |
|
|
278
278
|
|
|
279
279
|
The Performance Reviewer benchmarks modified code paths after implementation, compares metrics against configured thresholds, and outputs a structured report. It never fixes code — findings above the threshold trigger the Developer to address them before the pipeline continues.
|
|
@@ -301,7 +301,7 @@ Every agent stores observations in `.claude/agent-memory/<agent>/MEMORY.md`. Thi
|
|
|
301
301
|
└── ...
|
|
302
302
|
```
|
|
303
303
|
|
|
304
|
-
Memory is automatic — you don't need to manage it. Agents read relevant memories at the start of each task and write new observations as they work. Use `/
|
|
304
|
+
Memory is automatic — you don't need to manage it. Agents read relevant memories at the start of each task and write new observations as they work. Use `/specrails:why` to search the explanations directory in plain language.
|
|
305
305
|
|
|
306
306
|
## What's next?
|
|
307
307
|
|
package/docs/changelog.md
CHANGED
|
@@ -8,8 +8,8 @@ All notable changes to SpecRails are listed here, newest first.
|
|
|
8
8
|
|
|
9
9
|
### New commands
|
|
10
10
|
|
|
11
|
-
- **`/
|
|
12
|
-
- **`/
|
|
11
|
+
- **`/specrails:merge-conflict`** — Smart merge conflict resolver. Analyzes conflict context, understands intent of both sides, and proposes the correct resolution with an explanation.
|
|
12
|
+
- **`/specrails:refactor-recommender` (enhanced)** — Now includes VPC context-aware scoring: debt items are ranked against persona Jobs/Pains/Gains for product-aligned prioritization.
|
|
13
13
|
|
|
14
14
|
### Agents
|
|
15
15
|
|
|
@@ -41,8 +41,8 @@ All notable changes to SpecRails are listed here, newest first.
|
|
|
41
41
|
|
|
42
42
|
### New commands
|
|
43
43
|
|
|
44
|
-
- **`/
|
|
45
|
-
- **`/
|
|
44
|
+
- **`/specrails:opsx-diff`** — Change diff visualizer. Shows a structured, human-readable diff of what changed between two points in time across agents, commands, and templates.
|
|
45
|
+
- **`/specrails:telemetry`** — Agent telemetry and cost tracking. Reports per-agent token usage, run counts, and cost estimates with trend analysis.
|
|
46
46
|
|
|
47
47
|
### Agents
|
|
48
48
|
|
|
@@ -54,8 +54,8 @@ All notable changes to SpecRails are listed here, newest first.
|
|
|
54
54
|
|
|
55
55
|
### New commands
|
|
56
56
|
|
|
57
|
-
- **`/
|
|
58
|
-
- **`/
|
|
57
|
+
- **`/specrails:vpc-drift`** — Detects when your VPC personas have drifted from what your product actually delivers. Compares persona Jobs/Pains/Gains against the backlog and agent memory; produces per-persona alignment scores and concrete update recommendations.
|
|
58
|
+
- **`/specrails:memory-inspect`** — Inspect and manage agent memory directories. Shows per-agent stats, recent entries, and stale file detection with optional pruning.
|
|
59
59
|
|
|
60
60
|
---
|
|
61
61
|
|
|
@@ -63,7 +63,7 @@ All notable changes to SpecRails are listed here, newest first.
|
|
|
63
63
|
|
|
64
64
|
### New commands
|
|
65
65
|
|
|
66
|
-
- **`/
|
|
66
|
+
- **`/specrails:retry`** — Smart failure recovery. Resumes a failed `/specrails:implement` pipeline from the last successful phase without restarting from scratch. Reads saved pipeline state to identify what completed, then re-executes only the remaining phases.
|
|
67
67
|
|
|
68
68
|
### Agents
|
|
69
69
|
|
|
@@ -75,7 +75,7 @@ All notable changes to SpecRails are listed here, newest first.
|
|
|
75
75
|
|
|
76
76
|
### Improvements
|
|
77
77
|
|
|
78
|
-
- **`/
|
|
78
|
+
- **`/specrails:health-check` extended with static code analysis** — Now includes complexity metrics, dead code detection, and architectural pattern analysis in addition to test coverage and dependency health.
|
|
79
79
|
|
|
80
80
|
---
|
|
81
81
|
|
|
@@ -107,7 +107,7 @@ Initial stable release.
|
|
|
107
107
|
|
|
108
108
|
### ⚠ Breaking changes
|
|
109
109
|
|
|
110
|
-
All commands renamed from `/<name>` to `/
|
|
110
|
+
All commands renamed from `/<name>` to `/specrails:<name>`. All agent files renamed from `<name>.md` to `sr-<name>.md`. Existing installations are auto-migrated by `update.sh`.
|
|
111
111
|
|
|
112
112
|
### What shipped in 1.0
|
|
113
113
|
|
|
@@ -117,17 +117,17 @@ All commands renamed from `/<name>` to `/sr:<name>`. All agent files renamed fro
|
|
|
117
117
|
- Security Reviewer, Doc Sync, Product Analyst
|
|
118
118
|
|
|
119
119
|
**11 commands**
|
|
120
|
-
- `/
|
|
121
|
-
- `/
|
|
122
|
-
- `/
|
|
123
|
-
- `/
|
|
124
|
-
- `/
|
|
125
|
-
- `/
|
|
126
|
-
- `/
|
|
127
|
-
- `/
|
|
128
|
-
- `/
|
|
129
|
-
- `/
|
|
130
|
-
- `/
|
|
120
|
+
- `/specrails:implement` — full 8-phase pipeline (architecture → code → tests → docs → review → PR)
|
|
121
|
+
- `/specrails:batch-implement` — parallel multi-feature orchestrator using git worktrees
|
|
122
|
+
- `/specrails:health-check` — codebase quality dashboard with regression detection
|
|
123
|
+
- `/specrails:compat-check` — backwards compatibility analyzer and migration guide generator
|
|
124
|
+
- `/specrails:product-backlog` — VPC-scored backlog view with safe implementation ordering
|
|
125
|
+
- `/specrails:update-product-driven-backlog` — AI-powered product discovery via personas
|
|
126
|
+
- `/specrails:refactor-recommender` — tech debt scanner ranked by impact/effort
|
|
127
|
+
- `/specrails:why` — semantic search over agent decision records
|
|
128
|
+
- `/specrails:retry` — smart failure recovery (added in 1.3)
|
|
129
|
+
- `/specrails:vpc-drift` — persona drift detection (added in 1.4)
|
|
130
|
+
- `/specrails:propose-spec` — structured feature proposal generator
|
|
131
131
|
|
|
132
132
|
**Pipeline Monitor (web-manager)**
|
|
133
133
|
- Real-time job queue dashboard
|
package/docs/concepts.md
CHANGED
|
@@ -153,17 +153,17 @@ Before starting implementation, the Developer reads matching failure records as
|
|
|
153
153
|
|
|
154
154
|
The Architect, Developer, and Reviewer record **decision rationale** in `.claude/agent-memory/explanations/` as they work. These records capture the "why" behind implementation choices — which library was chosen and why, which trade-off was accepted, which alternative was rejected.
|
|
155
155
|
|
|
156
|
-
Use `/
|
|
156
|
+
Use `/specrails:why` to search this memory in plain language:
|
|
157
157
|
|
|
158
158
|
```
|
|
159
|
-
/
|
|
159
|
+
/specrails:why "why did we switch to event sourcing"
|
|
160
160
|
```
|
|
161
161
|
|
|
162
162
|
This gives you an audit trail from product decision to implementation choice, without digging through git history or asking the original author.
|
|
163
163
|
|
|
164
164
|
## Dependency-Aware Ordering
|
|
165
165
|
|
|
166
|
-
When `/
|
|
166
|
+
When `/specrails:product-backlog` is run, the Product Analyst parses `Prerequisites:` fields from GitHub Issue bodies and builds a **dependency DAG** (directed acyclic graph). It then:
|
|
167
167
|
|
|
168
168
|
1. Detects cycles and reports them as errors (circular dependencies block ordering)
|
|
169
169
|
2. Computes a safe implementation order via topological sort
|
package/docs/customization.md
CHANGED
|
@@ -4,7 +4,20 @@ Everything SpecRails generates is editable markdown. Here's how to adapt it to y
|
|
|
4
4
|
|
|
5
5
|
## What gets generated
|
|
6
6
|
|
|
7
|
-
After running `/setup`, your `.
|
|
7
|
+
After running `/specrails:setup`, your project data lives in `.specrails/` (plugin method) or `.claude/` (scaffold method):
|
|
8
|
+
|
|
9
|
+
**Plugin method — `.specrails/`**
|
|
10
|
+
|
|
11
|
+
```
|
|
12
|
+
.specrails/
|
|
13
|
+
├── config.yaml # Stack, CI commands, git workflow
|
|
14
|
+
├── personas/ # VPC user personas
|
|
15
|
+
├── rules/ # Per-layer conventions
|
|
16
|
+
├── agent-memory/ # Persistent agent memory
|
|
17
|
+
└── pipeline/ # In-flight feature state
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
**Scaffold method — `.claude/`**
|
|
8
21
|
|
|
9
22
|
```
|
|
10
23
|
.claude/
|
|
@@ -17,7 +30,7 @@ After running `/setup`, your `.claude/` directory looks like this:
|
|
|
17
30
|
└── security-exemptions.yaml
|
|
18
31
|
```
|
|
19
32
|
|
|
20
|
-
All files are standard Markdown or
|
|
33
|
+
All files are standard Markdown or YAML. Edit them directly — no special tools needed.
|
|
21
34
|
|
|
22
35
|
## Agents
|
|
23
36
|
|
|
@@ -228,13 +241,13 @@ Both agents run in parallel during Phase 4b and feed their findings into the gen
|
|
|
228
241
|
|
|
229
242
|
## Backwards compatibility baseline
|
|
230
243
|
|
|
231
|
-
Use `/
|
|
244
|
+
Use `/specrails:compat-check --save` to snapshot your current API surface as a baseline:
|
|
232
245
|
|
|
233
246
|
```
|
|
234
|
-
/
|
|
247
|
+
/specrails:compat-check --save
|
|
235
248
|
```
|
|
236
249
|
|
|
237
|
-
This writes the current API surface to `.claude/compat-baseline.json`. Future runs of `/
|
|
250
|
+
This writes the current API surface to `.claude/compat-baseline.json`. Future runs of `/specrails:compat-check` and the Architect's Phase 6 auto-check compare against this baseline to detect breaking changes. Re-run `--save` after any intentional breaking release to advance the baseline.
|
|
238
251
|
|
|
239
252
|
---
|
|
240
253
|
|
package/docs/deployment.md
CHANGED
|
@@ -6,16 +6,30 @@ SpecRails runs locally — no cloud infrastructure required. Choose the setup th
|
|
|
6
6
|
|
|
7
7
|
| Option | Best for | Setup time |
|
|
8
8
|
|--------|----------|------------|
|
|
9
|
-
| [
|
|
9
|
+
| [Plugin](#plugin-recommended) | Quick start, individual developers | ~1 minute |
|
|
10
|
+
| [Local (npx)](#local-npx) | Scaffold/Codex, full offline control | ~2 minutes |
|
|
10
11
|
| [Local (git clone)](#local-git-clone) | Customization, contributing | ~5 minutes |
|
|
11
12
|
| [Docker](#docker) | Reproducible environments, teams | ~5 minutes |
|
|
12
13
|
| [CI/CD](#cicd-github-actions) | Automated workflows, GitHub Actions | ~10 minutes |
|
|
13
14
|
|
|
14
15
|
---
|
|
15
16
|
|
|
17
|
+
## Plugin (recommended)
|
|
18
|
+
|
|
19
|
+
The fastest way to get started. No Node.js required.
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
claude plugin install sr
|
|
23
|
+
/specrails:setup
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
**Requirements:** Claude Code, git
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
16
30
|
## Local — npx
|
|
17
31
|
|
|
18
|
-
|
|
32
|
+
For Codex users or when you need full control over agent files.
|
|
19
33
|
|
|
20
34
|
```bash
|
|
21
35
|
npx specrails-core@latest init --root-dir .
|
|
@@ -23,10 +37,11 @@ npx specrails-core@latest init --root-dir .
|
|
|
23
37
|
|
|
24
38
|
This will:
|
|
25
39
|
1. Scaffold a `.claude/` directory in your project
|
|
26
|
-
2. Install the
|
|
27
|
-
|
|
40
|
+
2. Install agent templates and the `/specrails:setup` wizard
|
|
41
|
+
|
|
42
|
+
After install, open Claude Code or Codex and run `/specrails:setup` to configure.
|
|
28
43
|
|
|
29
|
-
**Requirements:** Node.js ≥18, Claude
|
|
44
|
+
**Requirements:** Node.js ≥18, Claude Code or Codex CLI
|
|
30
45
|
|
|
31
46
|
---
|
|
32
47
|
|
package/docs/getting-started.md
CHANGED
|
@@ -12,7 +12,6 @@ Think of it as hiring a full engineering team that lives inside your CLI.
|
|
|
12
12
|
|
|
13
13
|
You need:
|
|
14
14
|
|
|
15
|
-
- **Node.js 18+** — required for the installer (`node --version` to check)
|
|
16
15
|
- **Git** — your project must be a git repository
|
|
17
16
|
- **[Claude Code](https://claude.ai/claude-code)** — Anthropic's CLI tool
|
|
18
17
|
|
|
@@ -20,53 +19,43 @@ Optional (recommended):
|
|
|
20
19
|
|
|
21
20
|
- **[GitHub CLI](https://cli.github.com/)** (`gh`) — for automatic PR creation and issue tracking
|
|
22
21
|
|
|
23
|
-
> **Using OpenAI Codex instead of Claude Code?** See [
|
|
22
|
+
> **Using OpenAI Codex instead of Claude Code?** See [getting-started-codex.md](user-docs/getting-started-codex.md) for Codex-specific setup.
|
|
24
23
|
|
|
25
24
|
## Install
|
|
26
25
|
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
**npx (recommended)**
|
|
26
|
+
**Plugin method (recommended) — no Node.js required**
|
|
30
27
|
|
|
31
28
|
```bash
|
|
32
|
-
|
|
29
|
+
claude plugin install sr
|
|
33
30
|
```
|
|
34
31
|
|
|
35
|
-
**
|
|
32
|
+
**Scaffold method (for Codex users or full offline control)**
|
|
36
33
|
|
|
37
34
|
```bash
|
|
38
|
-
|
|
39
|
-
./specrails-core/install.sh --root-dir <your-project>
|
|
35
|
+
npx specrails-core@latest init --root-dir <your-project>
|
|
40
36
|
```
|
|
41
37
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
1. Check your prerequisites
|
|
45
|
-
2. Copy templates and commands into `.claude/`
|
|
46
|
-
3. Initialize OpenSpec (if available)
|
|
47
|
-
4. Track the installed version for future updates
|
|
48
|
-
|
|
49
|
-
> **Note:** Run this from the repo where you want SpecRails — not from the SpecRails source repo itself.
|
|
38
|
+
See [installation.md](installation.md) for full details on both methods and when to use each.
|
|
50
39
|
|
|
51
40
|
## Run the Setup Wizard
|
|
52
41
|
|
|
53
42
|
Open Claude Code in your project and run:
|
|
54
43
|
|
|
55
44
|
```
|
|
56
|
-
/setup
|
|
45
|
+
/specrails:setup
|
|
57
46
|
```
|
|
58
47
|
|
|
59
|
-
By default, `/setup` runs the **full 5-phase wizard** — deep stack analysis, researched user personas, and fully adapted agents.
|
|
48
|
+
By default, `/specrails:setup` runs the **full 5-phase wizard** — deep stack analysis, researched user personas, and fully adapted agents.
|
|
60
49
|
|
|
61
50
|
| Phase | What happens |
|
|
62
51
|
|-------|-------------|
|
|
63
52
|
| **1. Analyze** | Detects your tech stack, architecture layers, CI commands, and conventions |
|
|
64
53
|
| **2. Personas** | Researches your competitive landscape and generates full VPC user personas |
|
|
65
54
|
| **3. Configure** | Asks about your backlog provider, git workflow, and which agents to enable |
|
|
66
|
-
| **4. Generate** |
|
|
67
|
-
| **5. Cleanup** | Removes the wizard
|
|
55
|
+
| **4. Generate** | Generates your project data files (`.specrails/`) with project-specific context |
|
|
56
|
+
| **5. Cleanup** | Removes the wizard scaffolding, leaving only your tailored workflow files |
|
|
68
57
|
|
|
69
|
-
**In a hurry?** Run `/setup --lite` for the quick version: three questions, sensible defaults, done in under a minute.
|
|
58
|
+
**In a hurry?** Run `/specrails:setup --lite` for the quick version: three questions, sensible defaults, done in under a minute.
|
|
70
59
|
|
|
71
60
|
| Question | What it configures |
|
|
72
61
|
|----------|-------------------|
|
|
@@ -76,14 +65,14 @@ By default, `/setup` runs the **full 5-phase wizard** — deep stack analysis, r
|
|
|
76
65
|
|
|
77
66
|
Lite mode installs the four core agents (architect, developer, reviewer, product manager), all workflow commands, and local ticket storage. You can run the full wizard later to deepen the configuration.
|
|
78
67
|
|
|
79
|
-
After either mode, your
|
|
68
|
+
After either mode, your project data files are ready to use and your `/specrails:*` commands are live.
|
|
80
69
|
|
|
81
70
|
## Your first feature
|
|
82
71
|
|
|
83
72
|
Let's implement something. Pick an issue from your backlog, or describe a feature:
|
|
84
73
|
|
|
85
74
|
```
|
|
86
|
-
/
|
|
75
|
+
/specrails:implement "add a health check endpoint"
|
|
87
76
|
```
|
|
88
77
|
|
|
89
78
|
SpecRails will:
|
|
@@ -102,9 +91,9 @@ That's it. One command, full pipeline.
|
|
|
102
91
|
|
|
103
92
|
Once you have a feature running, a few commands help you understand what's happening and why:
|
|
104
93
|
|
|
105
|
-
- `/
|
|
106
|
-
- `/
|
|
107
|
-
- `/
|
|
94
|
+
- `/specrails:why "question"` — search agent explanation records in plain language. Ask why a design decision was made, why a library was chosen, or why a particular pattern is used. Agents record their reasoning as they work.
|
|
95
|
+
- `/specrails:product-backlog` — see your prioritized backlog with safe implementation ordering. Good first stop before picking what to build next.
|
|
96
|
+
- `/specrails:compat-check #N` — check whether an issue's implementation would break existing API consumers before you commit to it.
|
|
108
97
|
|
|
109
98
|
## What's next?
|
|
110
99
|
|