specrails-core 3.5.3 → 3.7.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 +11 -11
- package/bin/specrails-core.js +106 -13
- package/bin/tui-installer.mjs +309 -0
- package/commands/enrich.md +1565 -0
- package/docs/README.md +1 -1
- package/docs/changelog.md +17 -0
- package/docs/customization.md +37 -7
- package/docs/getting-started.md +5 -5
- package/docs/installation.md +61 -15
- package/docs/migration-guide.md +3 -3
- package/docs/plugin-architecture.md +13 -11
- package/docs/user-docs/faq.md +11 -11
- package/docs/user-docs/getting-started-codex.md +6 -6
- package/docs/user-docs/installation.md +9 -7
- package/docs/user-docs/quick-start.md +5 -3
- package/install.sh +328 -63
- package/package.json +5 -3
- package/templates/commands/specrails/enrich.md +1637 -0
- package/templates/commands/specrails/reconfig.md +89 -0
- package/templates/commands/specrails/setup.md +75 -3
- package/templates/settings/integration-contract.json +88 -0
- package/update.sh +20 -14
package/docs/README.md
CHANGED
|
@@ -13,7 +13,7 @@ Welcome to the SpecRails docs. This guide will take you from zero to a fully aut
|
|
|
13
13
|
|
|
14
14
|
| Guide | What it covers |
|
|
15
15
|
|-------|----------------|
|
|
16
|
-
| [Installation & Setup](installation.md) | Detailed setup, prerequisites, the `/specrails:
|
|
16
|
+
| [Installation & Setup](installation.md) | Detailed setup, prerequisites, the `/specrails:enrich` wizard, TUI installer |
|
|
17
17
|
| [Plugin Architecture](plugin-architecture.md) | Plugin vs scaffold, what lives where, how updates work |
|
|
18
18
|
| [Agents](agents.md) | Every agent explained — role, when it runs, why it exists |
|
|
19
19
|
| [Workflows & Commands](workflows.md) | How to use `/specrails:implement`, `/specrails:get-backlog-specs`, and more |
|
package/docs/changelog.md
CHANGED
|
@@ -4,6 +4,23 @@ All notable changes to SpecRails are listed here, newest first.
|
|
|
4
4
|
|
|
5
5
|
---
|
|
6
6
|
|
|
7
|
+
## [Unreleased]
|
|
8
|
+
|
|
9
|
+
### Breaking changes
|
|
10
|
+
|
|
11
|
+
- **`/specrails:setup` renamed to `/specrails:enrich`** — The setup wizard is now invoked as `/specrails:enrich`. The `--lite` flag is now `--quick` (both are accepted during the transition period). Update any scripts or documentation that reference `/specrails:setup`.
|
|
12
|
+
|
|
13
|
+
### New features
|
|
14
|
+
|
|
15
|
+
- **TUI installer** — `npx specrails-core@latest init` now launches an interactive terminal UI before copying files. Select which agents to install and choose a model preset (balanced/budget/max). Results are saved to `.specrails/install-config.yaml`.
|
|
16
|
+
- **`/specrails:enrich --from-config`** — Non-interactive enrichment mode. Reads `.specrails/install-config.yaml` (written by the TUI installer) and runs the full AI analysis without prompts.
|
|
17
|
+
- **`/specrails:enrich --quick`** — Quick setup mode: three questions, sensible defaults, done in under a minute.
|
|
18
|
+
- **`npx specrails-core enrich`** — New CLI subcommand that runs `/specrails:enrich` via Claude CLI directly from the terminal.
|
|
19
|
+
- **`install-config.yaml` schema** — Declarative configuration file for reproducible installations. Supports agent selection, model presets, and per-agent model overrides.
|
|
20
|
+
- **`integration-contract.json`** — Hub integration contract describing provider commands, tier configurations, checkpoint names, and model presets for hub integrations.
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
7
24
|
## [1.7.0](https://github.com/fjpulidop/specrails-core/compare/v1.6.1...v1.7.0) — 2026-03-20
|
|
8
25
|
|
|
9
26
|
### New commands
|
package/docs/customization.md
CHANGED
|
@@ -4,7 +4,7 @@ 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 `/specrails:
|
|
7
|
+
After running `/specrails:enrich`, your project data lives in `.specrails/` (plugin method) or `.claude/` (scaffold method):
|
|
8
8
|
|
|
9
9
|
**Plugin method — `.specrails/`**
|
|
10
10
|
|
|
@@ -54,20 +54,50 @@ Example — adding a constraint to the developer:
|
|
|
54
54
|
|
|
55
55
|
### Agent model selection
|
|
56
56
|
|
|
57
|
-
|
|
57
|
+
Agent models are controlled by `.specrails/agents.yaml`, generated automatically when you first run `/specrails:enrich`. The model preset can also be set ahead of time in `.specrails/install-config.yaml` (written by the TUI installer).
|
|
58
58
|
|
|
59
59
|
```yaml
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
60
|
+
# specrails agent configuration
|
|
61
|
+
# Valid models: opus, sonnet, haiku
|
|
62
|
+
|
|
63
|
+
defaults:
|
|
64
|
+
model: sonnet
|
|
65
|
+
|
|
66
|
+
agents:
|
|
67
|
+
sr-architect:
|
|
68
|
+
model: sonnet
|
|
69
|
+
sr-product-manager:
|
|
70
|
+
model: opus
|
|
71
|
+
sr-product-analyst:
|
|
72
|
+
model: haiku
|
|
73
|
+
# ... all 14 agents listed
|
|
63
74
|
```
|
|
64
75
|
|
|
65
|
-
|
|
76
|
+
**Valid models:**
|
|
66
77
|
- `opus` — best for creative/strategic tasks (Product Manager)
|
|
67
78
|
- `sonnet` — balanced for implementation tasks (most agents)
|
|
68
79
|
- `haiku` — fast and cheap for analysis tasks (Product Analyst)
|
|
69
80
|
|
|
70
|
-
|
|
81
|
+
**Precedence rules:**
|
|
82
|
+
1. Per-agent entry in `agents:` section overrides everything
|
|
83
|
+
2. `defaults.model` applies to any agent not explicitly listed
|
|
84
|
+
3. Template hard-coded value is the fallback when no config exists
|
|
85
|
+
|
|
86
|
+
**Applying config changes:** After editing `.specrails/agents.yaml`, run `/specrails:reconfig` to update the generated agent files without re-running the full setup wizard:
|
|
87
|
+
|
|
88
|
+
```
|
|
89
|
+
/specrails:reconfig
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Output example:
|
|
93
|
+
```
|
|
94
|
+
Updated 1 agent(s):
|
|
95
|
+
sr-developer: sonnet → opus
|
|
96
|
+
|
|
97
|
+
Unchanged (13): sr-architect, sr-reviewer, ...
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
**Important:** `/specrails:reconfig` wins over direct edits to `.claude/agents/sr-*.md`. If you edit an agent file directly, that change will be overwritten the next time you run reconfig or setup. For permanent per-agent overrides, edit `.specrails/agents.yaml` instead.
|
|
71
101
|
|
|
72
102
|
### Adding a new agent
|
|
73
103
|
|
package/docs/getting-started.md
CHANGED
|
@@ -37,15 +37,15 @@ npx specrails-core@latest init --root-dir <your-project>
|
|
|
37
37
|
|
|
38
38
|
See [installation.md](installation.md) for full details on both methods and when to use each.
|
|
39
39
|
|
|
40
|
-
## Run the
|
|
40
|
+
## Run the Enrich Wizard
|
|
41
41
|
|
|
42
42
|
Open Claude Code in your project and run:
|
|
43
43
|
|
|
44
44
|
```
|
|
45
|
-
/specrails:
|
|
45
|
+
/specrails:enrich
|
|
46
46
|
```
|
|
47
47
|
|
|
48
|
-
By default, `/specrails:
|
|
48
|
+
By default, `/specrails:enrich` runs the **full 5-phase wizard** — deep stack analysis, researched user personas, and fully adapted agents.
|
|
49
49
|
|
|
50
50
|
| Phase | What happens |
|
|
51
51
|
|-------|-------------|
|
|
@@ -55,7 +55,7 @@ By default, `/specrails:setup` runs the **full 5-phase wizard** — deep stack a
|
|
|
55
55
|
| **4. Generate** | Generates your project data files (`.specrails/`) with project-specific context |
|
|
56
56
|
| **5. Cleanup** | Removes the wizard scaffolding, leaving only your tailored workflow files |
|
|
57
57
|
|
|
58
|
-
**In a hurry?** Run `/specrails:
|
|
58
|
+
**In a hurry?** Run `/specrails:enrich --quick` for the quick version: three questions, sensible defaults, done in under a minute.
|
|
59
59
|
|
|
60
60
|
| Question | What it configures |
|
|
61
61
|
|----------|-------------------|
|
|
@@ -63,7 +63,7 @@ By default, `/specrails:setup` runs the **full 5-phase wizard** — deep stack a
|
|
|
63
63
|
| Who are the target users? | Persona stubs for product discovery |
|
|
64
64
|
| Git access — read-only or read-write? | Whether agents can commit |
|
|
65
65
|
|
|
66
|
-
|
|
66
|
+
Quick 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.
|
|
67
67
|
|
|
68
68
|
After either mode, your project data files are ready to use and your `/specrails:*` commands are live.
|
|
69
69
|
|
package/docs/installation.md
CHANGED
|
@@ -78,32 +78,39 @@ git clone https://github.com/fjpulidop/specrails-core.git
|
|
|
78
78
|
|
|
79
79
|
### What the scaffold installer does
|
|
80
80
|
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
81
|
+
The `npx specrails-core@latest init` command now includes a **TUI installer** that runs before copying files:
|
|
82
|
+
|
|
83
|
+
1. **TUI agent selection** — Interactive terminal UI lets you select which agents to install and choose a model preset (balanced/budget/max). Writes `.specrails/install-config.yaml`.
|
|
84
|
+
2. **Checks prerequisites** — validates Git, Claude Code; optionally installs npm and gh
|
|
85
|
+
3. **Detects existing setup** — warns if SpecRails artifacts already exist
|
|
86
|
+
4. **Installs artifacts:**
|
|
87
|
+
- `.claude/commands/specrails/enrich.md` — the `/specrails:enrich` wizard
|
|
88
|
+
- `.specrails/setup-templates/` — agent and command templates (temporary, removed after `/specrails:enrich`)
|
|
86
89
|
- `.claude/security-exemptions.yaml` — security scanner config
|
|
87
|
-
|
|
90
|
+
5. **Tracks version** — writes `.specrails/specrails-version` and `.specrails/specrails-manifest.json`
|
|
91
|
+
|
|
92
|
+
To skip the TUI and use an existing config: `npx specrails-core@latest init --from-config`
|
|
93
|
+
To skip the TUI and use all defaults: `npx specrails-core@latest init --yes`
|
|
88
94
|
|
|
89
95
|
The scaffold installer only copies files. It does not modify your existing code, create commits, or push to any remote.
|
|
90
96
|
|
|
91
97
|
---
|
|
92
98
|
|
|
93
|
-
## The
|
|
99
|
+
## The Enrich Wizard
|
|
94
100
|
|
|
95
101
|
After either installation method, open Claude Code (or Codex) in your project and run:
|
|
96
102
|
|
|
97
103
|
```
|
|
98
|
-
/specrails:
|
|
104
|
+
/specrails:enrich
|
|
99
105
|
```
|
|
100
106
|
|
|
101
|
-
There are
|
|
107
|
+
There are three modes:
|
|
102
108
|
|
|
103
109
|
| Mode | Command | When to use |
|
|
104
110
|
|------|---------|-------------|
|
|
105
|
-
| **Full wizard** (default) | `/specrails:
|
|
106
|
-
| **
|
|
111
|
+
| **Full wizard** (default) | `/specrails:enrich` | Deep stack analysis, researched personas, fully adapted agents — takes 5–10 min |
|
|
112
|
+
| **Quick** | `/specrails:enrich --quick` | Fastest path — 3 questions, sensible defaults, done in under a minute |
|
|
113
|
+
| **From-config** | `/specrails:enrich --from-config` | Non-interactive — reads `.specrails/install-config.yaml` from TUI installer |
|
|
107
114
|
|
|
108
115
|
---
|
|
109
116
|
|
|
@@ -111,6 +118,8 @@ There are two modes:
|
|
|
111
118
|
|
|
112
119
|
The full 5-phase wizard — takes 5–10 minutes and produces deeply adapted agents.
|
|
113
120
|
|
|
121
|
+
> **Note:** If the TUI installer already captured agent and model preferences, use `/specrails:enrich --from-config` to apply them non-interactively.
|
|
122
|
+
|
|
114
123
|
### Phase 1: Codebase Analysis
|
|
115
124
|
|
|
116
125
|
The wizard scans your project to detect:
|
|
@@ -209,15 +218,15 @@ The wizard fills all templates with your project-specific context:
|
|
|
209
218
|
|
|
210
219
|
The wizard removes itself:
|
|
211
220
|
|
|
212
|
-
- Deletes `.claude/commands/specrails/
|
|
221
|
+
- Deletes `.claude/commands/specrails/enrich.md`
|
|
213
222
|
- Deletes `.specrails/setup-templates/`
|
|
214
223
|
- Leaves only the final generated files
|
|
215
224
|
|
|
216
|
-
After this phase, `/specrails:
|
|
225
|
+
After this phase, `/specrails:enrich` is no longer available until re-run — your workflow is ready.
|
|
217
226
|
|
|
218
227
|
---
|
|
219
228
|
|
|
220
|
-
###
|
|
229
|
+
### Quick Mode (`/specrails:enrich --quick`)
|
|
221
230
|
|
|
222
231
|
The quick path — three questions, sensible defaults, done in under a minute.
|
|
223
232
|
|
|
@@ -238,6 +247,43 @@ You can run the full wizard later to deepen configuration: personas, stack analy
|
|
|
238
247
|
|
|
239
248
|
---
|
|
240
249
|
|
|
250
|
+
### From-Config Mode (`/specrails:enrich --from-config`)
|
|
251
|
+
|
|
252
|
+
Runs a fully automated installation using `.specrails/install-config.yaml`. No interactive prompts — all decisions come from the config file written by the TUI installer.
|
|
253
|
+
|
|
254
|
+
**Config schema** (`.specrails/install-config.yaml`):
|
|
255
|
+
|
|
256
|
+
```yaml
|
|
257
|
+
version: 1
|
|
258
|
+
provider: claude # claude | codex | auto
|
|
259
|
+
tier: full # full | quick
|
|
260
|
+
agents:
|
|
261
|
+
selected: # list of agent names to install
|
|
262
|
+
- sr-architect
|
|
263
|
+
- sr-developer
|
|
264
|
+
- sr-reviewer
|
|
265
|
+
- sr-test-writer
|
|
266
|
+
- sr-product-manager
|
|
267
|
+
excluded: [] # agent names to skip
|
|
268
|
+
models:
|
|
269
|
+
preset: balanced # balanced | budget | max
|
|
270
|
+
overrides: {} # per-agent overrides: { sr-architect: opus }
|
|
271
|
+
quick_context:
|
|
272
|
+
product_description: "" # product description seed
|
|
273
|
+
target_users: "" # target users seed
|
|
274
|
+
agent_teams: false # install team-review/team-debug commands
|
|
275
|
+
```
|
|
276
|
+
|
|
277
|
+
**Model presets:**
|
|
278
|
+
|
|
279
|
+
| Preset | Description |
|
|
280
|
+
|--------|-------------|
|
|
281
|
+
| `balanced` (default) | Opus for architect + PM, Sonnet for all others |
|
|
282
|
+
| `budget` | Haiku for all agents |
|
|
283
|
+
| `max` | Opus for all agents |
|
|
284
|
+
|
|
285
|
+
---
|
|
286
|
+
|
|
241
287
|
## Verify installation
|
|
242
288
|
|
|
243
289
|
After setup, verify everything is in place:
|
|
@@ -302,7 +348,7 @@ The installer warns if SpecRails artifacts already exist. You can:
|
|
|
302
348
|
|
|
303
349
|
### Placeholders not resolved
|
|
304
350
|
|
|
305
|
-
If you see `{{PLACEHOLDER}}` in generated files (scaffold method), the `/specrails:
|
|
351
|
+
If you see `{{PLACEHOLDER}}` in generated files (scaffold method), the `/specrails:enrich` wizard didn't complete. Re-run `/specrails:enrich` or manually fill the values.
|
|
306
352
|
|
|
307
353
|
---
|
|
308
354
|
|
package/docs/migration-guide.md
CHANGED
|
@@ -118,11 +118,11 @@ The original JIRA key is preserved in `metadata.jira_key` so you can cross-refer
|
|
|
118
118
|
|
|
119
119
|
## Step 3: Regenerate commands (optional but recommended)
|
|
120
120
|
|
|
121
|
-
Command templates are generated at `/specrails:
|
|
121
|
+
Command templates are generated at `/specrails:enrich` time with provider-specific instructions baked in. After switching providers, regenerate them so commands use the local file operations instead of GitHub/JIRA CLI calls:
|
|
122
122
|
|
|
123
123
|
```bash
|
|
124
124
|
npx specrails-core@latest init --root-dir .
|
|
125
|
-
> /specrails:
|
|
125
|
+
> /specrails:enrich --update
|
|
126
126
|
```
|
|
127
127
|
|
|
128
128
|
The `--update` flag regenerates only the backlog commands (`get-backlog-specs`, `auto-propose-backlog-specs`, `implement`) without re-running the full stack analysis.
|
|
@@ -134,7 +134,7 @@ The `--update` flag regenerates only the backlog commands (`get-backlog-specs`,
|
|
|
134
134
|
To revert to GitHub Issues:
|
|
135
135
|
|
|
136
136
|
1. Edit `.specrails/config.yaml` (or `.specrails/backlog-config.json` for scaffold installs) and set `provider: github`
|
|
137
|
-
2. Re-run `/specrails:
|
|
137
|
+
2. Re-run `/specrails:enrich --update` to regenerate commands
|
|
138
138
|
3. Your `local-tickets.json` is preserved — switch back any time
|
|
139
139
|
|
|
140
140
|
Local tickets and external provider data are independent. Switching providers does not delete tickets from either system.
|
|
@@ -12,7 +12,7 @@ SpecRails separates **logic** (the plugin) from **project data** (your repo).
|
|
|
12
12
|
│ agents · skills · hooks · refs │
|
|
13
13
|
│ updated via: claude plugin update │
|
|
14
14
|
└────────────────┬────────────────────┘
|
|
15
|
-
│ /specrails:
|
|
15
|
+
│ /specrails:enrich generates
|
|
16
16
|
▼
|
|
17
17
|
┌─────────────────────────────────────┐
|
|
18
18
|
│ .specrails/ (project data) │
|
|
@@ -36,7 +36,7 @@ You never edit these directly. To update them, run `claude plugin update sr`.
|
|
|
36
36
|
|
|
37
37
|
### What lives in your project (`.specrails/`)
|
|
38
38
|
|
|
39
|
-
`/specrails:
|
|
39
|
+
`/specrails:enrich` generates ~8–10 files adapted to your specific codebase:
|
|
40
40
|
|
|
41
41
|
| File | Description |
|
|
42
42
|
|------|-------------|
|
|
@@ -57,7 +57,7 @@ SpecRails supports three installation paths:
|
|
|
57
57
|
|
|
58
58
|
```bash
|
|
59
59
|
claude plugin install sr # install
|
|
60
|
-
/specrails:
|
|
60
|
+
/specrails:enrich # configure for your project
|
|
61
61
|
claude plugin update sr # update logic anytime
|
|
62
62
|
```
|
|
63
63
|
|
|
@@ -66,11 +66,11 @@ claude plugin update sr # update logic anytime
|
|
|
66
66
|
### 2. Claude Code scaffold
|
|
67
67
|
|
|
68
68
|
```bash
|
|
69
|
-
npx specrails-core@latest init --root-dir . # copy templates
|
|
70
|
-
/specrails:
|
|
69
|
+
npx specrails-core@latest init --root-dir . # TUI agent selection + copy templates
|
|
70
|
+
/specrails:enrich --from-config # AI analysis using your saved config
|
|
71
71
|
```
|
|
72
72
|
|
|
73
|
-
The scaffold copies the full agent+command set into `.claude/` — you own and version those files. Updates require re-running `npx` and re-running `/specrails:
|
|
73
|
+
The scaffold copies the full agent+command set into `.claude/` — you own and version those files. The `init` command now includes a TUI installer that lets you select agents and model preset. Updates require re-running `npx` and re-running `/specrails:enrich`.
|
|
74
74
|
|
|
75
75
|
**Best for:** Teams that want to version the agent prompts themselves, or projects that need full offline control.
|
|
76
76
|
|
|
@@ -79,16 +79,16 @@ The scaffold copies the full agent+command set into `.claude/` — you own and v
|
|
|
79
79
|
```bash
|
|
80
80
|
npx specrails-core@latest init --root-dir . # same as scaffold
|
|
81
81
|
codex # open Codex
|
|
82
|
-
/specrails:
|
|
82
|
+
/specrails:enrich # configure
|
|
83
83
|
```
|
|
84
84
|
|
|
85
85
|
Codex does not support the Claude Code plugin system. Use the scaffold method.
|
|
86
86
|
|
|
87
87
|
**Best for:** OpenAI Codex CLI users.
|
|
88
88
|
|
|
89
|
-
## The `/specrails:
|
|
89
|
+
## The `/specrails:enrich` wizard
|
|
90
90
|
|
|
91
|
-
`/specrails:
|
|
91
|
+
`/specrails:enrich` is a 5-phase wizard that generates your project data. It runs once (or re-runs to regenerate).
|
|
92
92
|
|
|
93
93
|
| Phase | Output |
|
|
94
94
|
|-------|--------|
|
|
@@ -98,7 +98,9 @@ Codex does not support the Claude Code plugin system. Use the scaffold method.
|
|
|
98
98
|
| **4. Generate** | Writes `.specrails/config.yaml`, personas, rules, CLAUDE.md |
|
|
99
99
|
| **5. Cleanup** | Removes wizard scaffolding |
|
|
100
100
|
|
|
101
|
-
Quick mode: `/specrails:
|
|
101
|
+
Quick mode: `/specrails:enrich --quick` — three questions, done in under a minute.
|
|
102
|
+
|
|
103
|
+
From-config mode: `/specrails:enrich --from-config` — reads `.specrails/install-config.yaml` (written by the TUI installer) and runs non-interactively.
|
|
102
104
|
|
|
103
105
|
## OpenSpec skills
|
|
104
106
|
|
|
@@ -127,7 +129,7 @@ Updates agents, skills, hooks, and references. Does not touch `.specrails/` proj
|
|
|
127
129
|
### Regenerate project data
|
|
128
130
|
|
|
129
131
|
```bash
|
|
130
|
-
/specrails:
|
|
132
|
+
/specrails:enrich
|
|
131
133
|
```
|
|
132
134
|
|
|
133
135
|
Re-runs the wizard and regenerates `.specrails/`. Useful when your stack changes significantly or you want to refresh personas.
|
package/docs/user-docs/faq.md
CHANGED
|
@@ -8,7 +8,7 @@ Yes. SpecRails runs on top of Claude Code, which requires an Anthropic account.
|
|
|
8
8
|
|
|
9
9
|
**What does the installer actually do to my project?**
|
|
10
10
|
|
|
11
|
-
The plugin method (`claude plugin install sr`) installs logic into Claude Code's plugin system — nothing is added to your project until you run `/specrails:
|
|
11
|
+
The plugin method (`claude plugin install sr`) installs logic into Claude Code's plugin system — nothing is added to your project until you run `/specrails:enrich`. The scaffold method (`npx specrails-core@latest init`) launches a TUI to select agents and model preset, writes `.specrails/install-config.yaml`, then copies templates into `.claude/`. Neither method modifies your source code, creates commits, or pushes anything.
|
|
12
12
|
|
|
13
13
|
**Do I need Node.js if my project is not JavaScript?**
|
|
14
14
|
|
|
@@ -23,11 +23,11 @@ No. SpecRails ships with a built-in local ticket system — no GitHub account re
|
|
|
23
23
|
/specrails:implement "add rate limiting to the API"
|
|
24
24
|
```
|
|
25
25
|
|
|
26
|
-
You can switch to GitHub Issues or JIRA during `/specrails:
|
|
26
|
+
You can switch to GitHub Issues or JIRA during `/specrails:enrich` (Phase 3) if you prefer.
|
|
27
27
|
|
|
28
|
-
**How long does /specrails:
|
|
28
|
+
**How long does /specrails:enrich take?**
|
|
29
29
|
|
|
30
|
-
The full wizard takes about 5 minutes — most of the time is Phase 2 (persona research via web search). For a faster start, use `/specrails:
|
|
30
|
+
The full wizard takes about 5 minutes — most of the time is Phase 2 (persona research via web search). For a faster start, use `/specrails:enrich --quick`: three questions, under a minute, no web research.
|
|
31
31
|
|
|
32
32
|
---
|
|
33
33
|
|
|
@@ -35,7 +35,7 @@ The full wizard takes about 5 minutes — most of the time is Phase 2 (persona r
|
|
|
35
35
|
|
|
36
36
|
**Can I run SpecRails on an existing project with existing code?**
|
|
37
37
|
|
|
38
|
-
Yes, that's the intended use case. The `/specrails:
|
|
38
|
+
Yes, that's the intended use case. The `/specrails:enrich` wizard analyzes your existing codebase — your tech stack, layers, CI commands, and conventions — and generates agents configured specifically for it.
|
|
39
39
|
|
|
40
40
|
**Does /specrails:implement always create a PR?**
|
|
41
41
|
|
|
@@ -77,7 +77,7 @@ For layer-specific coding conventions, edit `.specrails/rules/*.md` (plugin) or
|
|
|
77
77
|
|
|
78
78
|
**What is a VPC persona?**
|
|
79
79
|
|
|
80
|
-
VPC stands for Value Proposition Canvas. Personas are structured profiles of your target users with their Jobs (what they're trying to accomplish), Pains (what frustrates them), and Gains (what they want). The Product Manager and Architect use these to make better design decisions. They're generated during `/specrails:
|
|
80
|
+
VPC stands for Value Proposition Canvas. Personas are structured profiles of your target users with their Jobs (what they're trying to accomplish), Pains (what frustrates them), and Gains (what they want). The Product Manager and Architect use these to make better design decisions. They're generated during `/specrails:enrich` and stored in `.specrails/personas/` (plugin) or `.claude/agents/personas/` (scaffold).
|
|
81
81
|
|
|
82
82
|
---
|
|
83
83
|
|
|
@@ -85,11 +85,11 @@ VPC stands for Value Proposition Canvas. Personas are structured profiles of you
|
|
|
85
85
|
|
|
86
86
|
**Does SpecRails work with monorepos?**
|
|
87
87
|
|
|
88
|
-
Yes. During `/specrails:
|
|
88
|
+
Yes. During `/specrails:enrich`, the architect detects your monorepo structure and generates separate layer configurations for each package or service.
|
|
89
89
|
|
|
90
90
|
**Which languages and frameworks are supported?**
|
|
91
91
|
|
|
92
|
-
SpecRails works with any stack. The agents are general-purpose and adapt based on what `/specrails:
|
|
92
|
+
SpecRails works with any stack. The agents are general-purpose and adapt based on what `/specrails:enrich` detects in your codebase. It's been used with Node.js, Python, Go, Ruby, Rust, and mixed-stack projects.
|
|
93
93
|
|
|
94
94
|
**Does it work with private repositories?**
|
|
95
95
|
|
|
@@ -113,7 +113,7 @@ Scaffold method:
|
|
|
113
113
|
npx specrails-core@latest init --root-dir .
|
|
114
114
|
```
|
|
115
115
|
|
|
116
|
-
Then re-run `/specrails:
|
|
116
|
+
Then re-run `/specrails:enrich` to regenerate project data with any new templates. See the [updating guide](../updating.md) for details.
|
|
117
117
|
|
|
118
118
|
**How do I know which version is installed?**
|
|
119
119
|
|
|
@@ -125,13 +125,13 @@ cat .specrails/specrails-version
|
|
|
125
125
|
|
|
126
126
|
## Troubleshooting
|
|
127
127
|
|
|
128
|
-
**The /specrails:
|
|
128
|
+
**The /specrails:enrich command isn't available after installing.**
|
|
129
129
|
|
|
130
130
|
For the plugin method: make sure the plugin is installed (`claude plugin list` should show `sr`). For the scaffold method: Claude Code loads commands from `.claude/commands/` — make sure you opened Claude Code from inside your project directory.
|
|
131
131
|
|
|
132
132
|
**Generated files contain `{{PLACEHOLDER}}` text.**
|
|
133
133
|
|
|
134
|
-
The `/specrails:
|
|
134
|
+
The `/specrails:enrich` wizard did not complete all phases. Re-run `/specrails:enrich` — it will pick up where it left off.
|
|
135
135
|
|
|
136
136
|
**The pipeline created a PR but the CI checks failed.**
|
|
137
137
|
|
|
@@ -73,24 +73,24 @@ your-project/
|
|
|
73
73
|
|
|
74
74
|
---
|
|
75
75
|
|
|
76
|
-
## Configure with
|
|
76
|
+
## Configure with enrich
|
|
77
77
|
|
|
78
|
-
After installation, open Codex and run the
|
|
78
|
+
After installation, open Codex and run the enrich skill:
|
|
79
79
|
|
|
80
80
|
```bash
|
|
81
81
|
codex
|
|
82
82
|
```
|
|
83
83
|
|
|
84
|
-
Then invoke the
|
|
84
|
+
Then invoke the enrich skill:
|
|
85
85
|
|
|
86
86
|
```
|
|
87
|
-
/specrails:
|
|
87
|
+
/specrails:enrich
|
|
88
88
|
```
|
|
89
89
|
|
|
90
90
|
Or run it non-interactively:
|
|
91
91
|
|
|
92
92
|
```bash
|
|
93
|
-
codex exec "run /specrails:
|
|
93
|
+
codex exec "run /specrails:enrich --yes"
|
|
94
94
|
```
|
|
95
95
|
|
|
96
96
|
The wizard runs 5 phases:
|
|
@@ -186,7 +186,7 @@ The installer warns if SpecRails artifacts already exist. You can merge or abort
|
|
|
186
186
|
|
|
187
187
|
### Placeholders not resolved
|
|
188
188
|
|
|
189
|
-
If you see `{{PLACEHOLDER}}` in generated files, `/specrails:
|
|
189
|
+
If you see `{{PLACEHOLDER}}` in generated files, `/specrails:enrich` did not complete. Re-run `/specrails:enrich` or fill the values manually.
|
|
190
190
|
|
|
191
191
|
---
|
|
192
192
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Installation
|
|
2
2
|
|
|
3
|
-
Install SpecRails into any git repository in two steps: install, then run `/specrails:
|
|
3
|
+
Install SpecRails into any git repository in two steps: install, then run `/specrails:enrich` inside your AI CLI.
|
|
4
4
|
|
|
5
5
|
SpecRails supports both **Claude Code** and **OpenAI Codex**. The installer detects which CLI you have and configures accordingly. See [Codex vs Claude Code](codex-vs-claude-code.md) for a feature comparison.
|
|
6
6
|
|
|
@@ -69,7 +69,7 @@ The installer copies templates and commands into `.claude/` (Claude Code) or `.c
|
|
|
69
69
|
```
|
|
70
70
|
your-project/
|
|
71
71
|
└── .claude/
|
|
72
|
-
├── commands/specrails/
|
|
72
|
+
├── commands/specrails/enrich.md # The /specrails:enrich wizard
|
|
73
73
|
├── skills/ # Workflow skills (/specrails:*, /opsx:*)
|
|
74
74
|
├── agents/ # Agent definitions
|
|
75
75
|
├── rules/ # Per-layer coding conventions
|
|
@@ -90,7 +90,7 @@ your-project/
|
|
|
90
90
|
|
|
91
91
|
The installer also writes `.specrails/specrails-version` and `.specrails/specrails-manifest.json` to track the installed version.
|
|
92
92
|
|
|
93
|
-
## Configure with /specrails:
|
|
93
|
+
## Configure with /specrails:enrich
|
|
94
94
|
|
|
95
95
|
After either installation method, open your AI CLI in your project and run:
|
|
96
96
|
|
|
@@ -101,10 +101,10 @@ codex # Codex
|
|
|
101
101
|
```
|
|
102
102
|
|
|
103
103
|
```
|
|
104
|
-
/specrails:
|
|
104
|
+
/specrails:enrich
|
|
105
105
|
```
|
|
106
106
|
|
|
107
|
-
By default, `/specrails:
|
|
107
|
+
By default, `/specrails:enrich` runs the full 5-phase wizard:
|
|
108
108
|
|
|
109
109
|
| Phase | What happens |
|
|
110
110
|
|-------|-------------|
|
|
@@ -114,7 +114,9 @@ By default, `/specrails:setup` runs the full 5-phase wizard:
|
|
|
114
114
|
| **4. Generate** | Generates project data files (`.specrails/` or `.claude/`) with your context |
|
|
115
115
|
| **5. Cleanup** | Removes setup scaffolding, leaving only your tailored workflow |
|
|
116
116
|
|
|
117
|
-
**In a hurry?** Run `/specrails:
|
|
117
|
+
**In a hurry?** Run `/specrails:enrich --quick` instead — three questions, sensible defaults, done in under a minute.
|
|
118
|
+
|
|
119
|
+
**Already ran the TUI installer?** If you used `npx specrails-core@latest init` and completed the TUI agent selection, run `/specrails:enrich --from-config` to apply your saved configuration without re-answering the prompts.
|
|
118
120
|
|
|
119
121
|
## Verify
|
|
120
122
|
|
|
@@ -151,7 +153,7 @@ The installer warns if SpecRails artifacts already exist. You can merge (install
|
|
|
151
153
|
|
|
152
154
|
### Placeholders not resolved
|
|
153
155
|
|
|
154
|
-
If you see `{{PLACEHOLDER}}` in generated files (scaffold method), the `/specrails:
|
|
156
|
+
If you see `{{PLACEHOLDER}}` in generated files (scaffold method), the `/specrails:enrich` wizard did not complete. Re-run `/specrails:enrich` or fill the values manually.
|
|
155
157
|
|
|
156
158
|
### "No Claude API key configured"
|
|
157
159
|
|
|
@@ -29,7 +29,7 @@ npx specrails-core@latest init --root-dir .
|
|
|
29
29
|
|
|
30
30
|
Your existing code is not touched by either method.
|
|
31
31
|
|
|
32
|
-
## Step 2: Run the
|
|
32
|
+
## Step 2: Run the enrich wizard
|
|
33
33
|
|
|
34
34
|
Open Claude Code in your project:
|
|
35
35
|
|
|
@@ -40,7 +40,7 @@ claude
|
|
|
40
40
|
Then run:
|
|
41
41
|
|
|
42
42
|
```
|
|
43
|
-
/specrails:
|
|
43
|
+
/specrails:enrich
|
|
44
44
|
```
|
|
45
45
|
|
|
46
46
|
The wizard runs the full 5-phase setup (about 5 minutes). It analyzes your codebase and configures SpecRails for your specific project:
|
|
@@ -69,7 +69,9 @@ Phase 5/5 Cleanup complete.
|
|
|
69
69
|
✓ SpecRails is ready. Run /specrails:implement to start building.
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
**In a hurry?** Use `/specrails:
|
|
72
|
+
**In a hurry?** Use `/specrails:enrich --quick` for a 3-question quick setup (under a minute). You can always run the full wizard later.
|
|
73
|
+
|
|
74
|
+
**Used the TUI installer?** If the `npx specrails-core@latest init` TUI already collected your agent and model choices, run `/specrails:enrich --from-config` to apply them automatically.
|
|
73
75
|
|
|
74
76
|
## Step 3: Implement your first feature
|
|
75
77
|
|