specrails-core 4.11.3 โ 4.12.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 +56 -20
- package/bin/specrails-core.mjs +343 -20
- package/bin/tui-installer.mjs +103 -52
- package/dist/installer/cli.js +1 -1
- package/dist/installer/cli.js.map +1 -1
- package/dist/installer/commands/doctor.js +486 -24
- package/dist/installer/commands/doctor.js.map +1 -1
- package/dist/installer/commands/framework.js +49 -7
- package/dist/installer/commands/framework.js.map +1 -1
- package/dist/installer/commands/init.js +423 -25
- package/dist/installer/commands/init.js.map +1 -1
- package/dist/installer/commands/update.js +36 -9
- package/dist/installer/commands/update.js.map +1 -1
- package/dist/installer/phases/framework-lifecycle.js +125 -0
- package/dist/installer/phases/framework-lifecycle.js.map +1 -0
- package/dist/installer/phases/install-config.js +157 -5
- package/dist/installer/phases/install-config.js.map +1 -1
- package/dist/installer/phases/manifest.js +27 -2
- package/dist/installer/phases/manifest.js.map +1 -1
- package/dist/installer/phases/prereqs.js +57 -2
- package/dist/installer/phases/prereqs.js.map +1 -1
- package/dist/installer/phases/provider-detect.js +116 -6
- package/dist/installer/phases/provider-detect.js.map +1 -1
- package/dist/installer/phases/scaffold.js +1222 -12
- package/dist/installer/phases/scaffold.js.map +1 -1
- package/dist/installer/runtime/kimi.js +255 -0
- package/dist/installer/runtime/kimi.js.map +1 -0
- package/dist/installer/util/exec.js +6 -1
- package/dist/installer/util/exec.js.map +1 -1
- package/dist/installer/util/fs.js +11 -2
- package/dist/installer/util/fs.js.map +1 -1
- package/dist/installer/util/paths.js +12 -0
- package/dist/installer/util/paths.js.map +1 -1
- package/dist/installer/util/registry.js +234 -14
- package/dist/installer/util/registry.js.map +1 -1
- package/docs/README.md +1 -0
- package/docs/deployment.md +6 -7
- package/docs/getting-started.md +11 -7
- package/docs/installation.md +34 -16
- package/docs/plugin-architecture.md +11 -8
- package/docs/updating.md +21 -3
- package/docs/user-docs/cli-reference.md +43 -22
- package/docs/user-docs/codex-vs-claude-code.md +11 -9
- package/docs/user-docs/faq.md +1 -1
- package/docs/user-docs/getting-started-codex.md +5 -8
- package/docs/user-docs/getting-started-kimi.md +423 -0
- package/docs/user-docs/installation.md +49 -14
- package/docs/user-docs/quick-start.md +11 -8
- package/docs/windows.md +29 -4
- package/integration-contract.json +85 -13
- package/package.json +9 -5
- package/schemas/profile.v1.json +67 -5
- package/templates/kimi/specrails/run-skill.mjs +3005 -0
- package/templates/kimi/specrails/vendor/js-yaml/LICENSE +21 -0
- package/templates/kimi/specrails/vendor/js-yaml/NOTICE.md +16 -0
- package/templates/kimi/specrails/vendor/js-yaml/js-yaml.mjs +3856 -0
- package/templates/profiles/kimi-default.json +15 -0
package/docs/installation.md
CHANGED
|
@@ -2,19 +2,15 @@
|
|
|
2
2
|
|
|
3
3
|
This guide covers the complete installation process in detail. For the quick version, see [Getting Started](getting-started.md).
|
|
4
4
|
|
|
5
|
-
> ## ๐งช Codex (OpenAI) Support โ Coming Soon (in Lab)
|
|
6
|
-
>
|
|
7
|
-
> OpenAI Codex integration is currently being **tested in our lab** and **cannot be installed yet**. The installer will refuse any attempt to install with `--provider codex` and will guide you to use Claude Code instead. Codex-specific sections below describe the **planned behaviour** and will be activated when the feature ships.
|
|
8
|
-
|
|
9
5
|
## Installation methods
|
|
10
6
|
|
|
11
|
-
SpecRails
|
|
7
|
+
SpecRails offers a Claude plugin and a provider-independent scaffold:
|
|
12
8
|
|
|
13
9
|
| Method | Command | Best for |
|
|
14
10
|
|--------|---------|----------|
|
|
15
11
|
| **Claude Code plugin** (recommended) | `claude plugin install sr` | Most projects โ no Node.js required, auto-updates |
|
|
16
12
|
| **Claude Code scaffold** | `npx specrails-core@latest init` | Full offline control, custom agent edits |
|
|
17
|
-
| **
|
|
13
|
+
| **Provider scaffold** | `npx specrails-core@latest init` | Claude, Codex, Gemini, or Kimi Code projects |
|
|
18
14
|
|
|
19
15
|
---
|
|
20
16
|
|
|
@@ -59,9 +55,9 @@ The plugin bundles the logic layer โ agents, skills, commands, hooks, and refe
|
|
|
59
55
|
|
|
60
56
|
| Tool | Why | Install |
|
|
61
57
|
|------|-----|---------|
|
|
62
|
-
| **Node.js 20+** | Required for the installer (macOS, Linux, Windows) | [nodejs.org](https://nodejs.org/) or via [nvm](https://github.com/nvm-sh/nvm) |
|
|
58
|
+
| **Node.js 20.19.0+** | Required for the installer and pinned OpenSpec 1.4.1 CLI (macOS, Linux, Windows) | [nodejs.org](https://nodejs.org/) or via [nvm](https://github.com/nvm-sh/nvm) |
|
|
63
59
|
| **Git** | SpecRails operates on git repositories | [git-scm.com](https://git-scm.com/) |
|
|
64
|
-
| **
|
|
60
|
+
| **Supported AI CLI** | The runtime that runs the agents | Claude, Codex, Gemini, or [Kimi Code](user-docs/getting-started-kimi.md) |
|
|
65
61
|
|
|
66
62
|
### Install
|
|
67
63
|
|
|
@@ -88,7 +84,8 @@ node bin/specrails-core.mjs init --root-dir <your-project>
|
|
|
88
84
|
The `npx specrails-core@latest init` command now includes a **TUI installer** that runs before copying files:
|
|
89
85
|
|
|
90
86
|
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`.
|
|
91
|
-
2. **Checks prerequisites** โ validates Git
|
|
87
|
+
2. **Checks prerequisites** โ validates Git and the selected provider CLI;
|
|
88
|
+
optionally installs npm and gh
|
|
92
89
|
3. **Detects existing setup** โ warns if SpecRails artifacts already exist
|
|
93
90
|
4. **Installs artifacts:**
|
|
94
91
|
- `.claude/commands/specrails/enrich.md` โ the `/specrails:enrich` wizard
|
|
@@ -105,12 +102,26 @@ The scaffold installer only copies files. It does not modify your existing code,
|
|
|
105
102
|
|
|
106
103
|
## The Enrich Wizard
|
|
107
104
|
|
|
108
|
-
After either installation method, open
|
|
105
|
+
After either installation method, open the selected AI CLI. Claude and Gemini
|
|
106
|
+
use:
|
|
109
107
|
|
|
110
108
|
```
|
|
111
109
|
/specrails:enrich
|
|
112
110
|
```
|
|
113
111
|
|
|
112
|
+
Kimi uses:
|
|
113
|
+
|
|
114
|
+
```text
|
|
115
|
+
/skill:specrails-enrich
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
That slash form is Kimi TUI syntax. Automated callers use the managed
|
|
119
|
+
`.kimi-code/specrails/run-skill.mjs` helper installed beside the skills; passing
|
|
120
|
+
the slash form directly to `kimi -p` does not activate it in Kimi 0.27.
|
|
121
|
+
Generated multi-role workflows give that helper one structured foreground
|
|
122
|
+
role wave. It owns parallel child processes and reusable worktrees, so no
|
|
123
|
+
Kimi daemon or bundled provider binary is required.
|
|
124
|
+
|
|
114
125
|
There are three modes:
|
|
115
126
|
|
|
116
127
|
| Mode | Command | When to use |
|
|
@@ -274,28 +285,35 @@ Runs a fully automated installation using `.specrails/install-config.yaml`. No i
|
|
|
274
285
|
|
|
275
286
|
```yaml
|
|
276
287
|
version: 1
|
|
277
|
-
provider: claude # claude | codex |
|
|
288
|
+
provider: claude # claude | codex | gemini | kimi
|
|
278
289
|
tier: full # full (requires /specrails:enrich) | quick (agents placed directly)
|
|
279
290
|
agents:
|
|
280
|
-
selected: #
|
|
291
|
+
selected: # unique lowercase kebab-case ids (1-64 chars)
|
|
281
292
|
- sr-architect
|
|
282
293
|
- sr-developer
|
|
283
294
|
- sr-reviewer
|
|
284
295
|
- sr-test-writer
|
|
285
296
|
- sr-product-manager
|
|
286
|
-
excluded: [] #
|
|
297
|
+
excluded: [] # unique ids to skip; must not overlap selected
|
|
287
298
|
models:
|
|
288
299
|
preset: balanced # balanced | budget | max
|
|
289
|
-
|
|
300
|
+
defaults:
|
|
301
|
+
model: sonnet # exact provider model/alias; Kimi defaults to k3
|
|
302
|
+
overrides: {} # exact per-agent models: { sr-architect: opus }
|
|
290
303
|
```
|
|
291
304
|
|
|
292
305
|
**Model presets:**
|
|
293
306
|
|
|
294
307
|
| Preset | Description |
|
|
295
308
|
|--------|-------------|
|
|
296
|
-
| `balanced` (default) |
|
|
309
|
+
| `balanced` (default) | Sonnet for all Claude agents |
|
|
297
310
|
| `budget` | Haiku for all agents |
|
|
298
|
-
| `max` | Opus for all
|
|
311
|
+
| `max` | Opus for Claude architect + PM, Sonnet for all others |
|
|
312
|
+
|
|
313
|
+
Other providers resolve the same preset names within their own catalog. Kimi
|
|
314
|
+
presets default to `k3`; exact official ids and configured aliases are retained.
|
|
315
|
+
Kimi ids must be 1โ128 characters matching
|
|
316
|
+
`[A-Za-z0-9][A-Za-z0-9._/:-]*`, the same grammar enforced at process launch.
|
|
299
317
|
|
|
300
318
|
---
|
|
301
319
|
|
|
@@ -74,19 +74,22 @@ The scaffold copies the full agent+command set into `.claude/` โ you own and v
|
|
|
74
74
|
|
|
75
75
|
**Best for:** Teams that want to version the agent prompts themselves, or projects that need full offline control.
|
|
76
76
|
|
|
77
|
-
### 3.
|
|
78
|
-
|
|
79
|
-
> **Codex installation is not yet available.** OpenAI Codex integration is being tested in our lab and will ship shortly. The block below describes the **planned behaviour** for when the feature is released.
|
|
77
|
+
### 3. Provider scaffold
|
|
80
78
|
|
|
81
79
|
```bash
|
|
82
|
-
npx specrails-core@latest init --root-dir .
|
|
83
|
-
|
|
84
|
-
|
|
80
|
+
npx specrails-core@latest init --root-dir . --provider codex
|
|
81
|
+
npx specrails-core@latest init --root-dir . --provider gemini
|
|
82
|
+
npx specrails-core@latest init --root-dir . --provider kimi
|
|
85
83
|
```
|
|
86
84
|
|
|
87
|
-
Codex
|
|
85
|
+
Codex, Gemini, and Kimi do not use the Claude Code plugin package. The
|
|
86
|
+
scaffold renders their native project surfaces under `.codex/`, `.gemini/`,
|
|
87
|
+
and `.kimi-code/` respectively. Kimi interactive workflows use
|
|
88
|
+
`/skill:specrails-*`; its headless workflows use the managed runner installed
|
|
89
|
+
under `.kimi-code/specrails/`.
|
|
88
90
|
|
|
89
|
-
**Best for
|
|
91
|
+
**Best for:** Codex, Gemini, or Kimi users and teams that version generated
|
|
92
|
+
provider artifacts.
|
|
90
93
|
|
|
91
94
|
## The `/specrails:enrich` wizard
|
|
92
95
|
|
package/docs/updating.md
CHANGED
|
@@ -8,7 +8,8 @@ The update system uses a **manifest-based approach**:
|
|
|
8
8
|
|
|
9
9
|
1. During installation, SpecRails generates `.specrails/specrails-manifest.json` โ a checksum of every installed file
|
|
10
10
|
2. On update, the new templates from the latest specrails-core release are re-applied
|
|
11
|
-
3. Reserved paths (`.specrails/profiles/**`,
|
|
11
|
+
3. Reserved paths (`.specrails/profiles/**`, provider-specific `custom-*`
|
|
12
|
+
roles, OpenSpec skills, and user MCP entries) are preserved by construction
|
|
12
13
|
|
|
13
14
|
## Running an update
|
|
14
15
|
|
|
@@ -21,9 +22,13 @@ Cross-platform (macOS, Linux, Windows). No bash, no python required โ the inst
|
|
|
21
22
|
### What happens
|
|
22
23
|
|
|
23
24
|
1. **Version check** โ reads existing `.specrails/specrails-version`; aborts if no specrails install is detected
|
|
24
|
-
2. **Provider resolution** โ detects
|
|
25
|
+
2. **Provider resolution** โ detects Claude (`.claude/`), Codex (`.codex/`),
|
|
26
|
+
Gemini (`.gemini/`), or Kimi (`.kimi-code/`). In a multi-provider workspace,
|
|
27
|
+
pass `--provider` to select the tree being refreshed.
|
|
25
28
|
3. **Re-scaffold** โ re-applies templates from the latest specrails-core into `.specrails/setup-templates/` and the provider directory
|
|
26
|
-
4. **Reserved paths** โ
|
|
29
|
+
4. **Reserved paths** โ profiles and provider-specific custom roles are skipped;
|
|
30
|
+
Kimi also preserves `openspec-*`, unknown skill directories, and existing
|
|
31
|
+
`.kimi-code/mcp.json` entries
|
|
27
32
|
5. **Manifest refresh** โ rewrites `specrails-manifest.json` and `specrails-version` to the new core version
|
|
28
33
|
|
|
29
34
|
## Selective updates (`--only`)
|
|
@@ -49,6 +54,19 @@ Prints what the update would do without writing any files. Useful for inspecting
|
|
|
49
54
|
| **Rules** (`.claude/rules/`) | Re-written from latest templates |
|
|
50
55
|
| **Agent memory** (`.claude/agent-memory/`) | Untouched (created on first install only) |
|
|
51
56
|
| **install-config.yaml** | Untouched |
|
|
57
|
+
| **Kimi workflows** (`.kimi-code/skills/specrails-*`) | Re-written from latest templates |
|
|
58
|
+
| **Kimi roles** (`.kimi-code/skills/sr-*`) | Re-written according to the selected agent set |
|
|
59
|
+
| **Kimi custom roles** (`.kimi-code/skills/custom-*`) | **Always preserved** |
|
|
60
|
+
| **Kimi OpenSpec skills** (`.kimi-code/skills/openspec-*`) | Preserved and normalized from legacy `.kimi/skills` when needed |
|
|
61
|
+
| **Kimi MCP config** (`.kimi-code/mcp.json`) | Existing entries preserved; SpecRails-owned entries merged additively |
|
|
62
|
+
| **Kimi headless runner** (`.kimi-code/specrails/`) | Runner, vendored YAML parser, MIT license, and provenance notice are re-written together from the latest trusted Core template; they are managed code, not user skills |
|
|
63
|
+
|
|
64
|
+
Kimi discovers only immediate child directories of `.kimi-code/skills`.
|
|
65
|
+
Updates therefore migrate the pre-release
|
|
66
|
+
`.kimi-code/skills/rails/custom-*` layout to direct `custom-*` children when
|
|
67
|
+
the destination is free, and regenerate managed `sr-*` roles at the direct
|
|
68
|
+
level. If both legacy and direct versions of a custom role exist, neither is
|
|
69
|
+
overwritten or deleted: `doctor` reports the conflict for manual resolution.
|
|
52
70
|
|
|
53
71
|
## Rolling back
|
|
54
72
|
|
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
# CLI Reference
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
3
|
+
SpecRails installs provider-native workflows for Claude Code, Codex CLI,
|
|
4
|
+
Gemini CLI, and Kimi Code. The workflow names and flags are shared, while each
|
|
5
|
+
provider uses its own activation syntax and project directory.
|
|
6
6
|
|
|
7
7
|
**Platform support key used in this reference:**
|
|
8
8
|
|
|
9
9
|
| Badge | Meaning |
|
|
10
10
|
|-------|---------|
|
|
11
|
-
| โ
|
|
11
|
+
| โ
Providers | Works in Claude Code, Codex CLI, Gemini CLI, and Kimi Code |
|
|
12
12
|
| ๐ต Claude Code | Claude Code only |
|
|
13
13
|
| โ ๏ธ Limited | Works, but with known limitations (see notes) |
|
|
14
14
|
|
|
@@ -17,13 +17,20 @@ Run commands inside your AI CLI from your project directory:
|
|
|
17
17
|
```bash
|
|
18
18
|
claude # Claude Code
|
|
19
19
|
codex # Codex
|
|
20
|
+
gemini # Gemini CLI
|
|
21
|
+
kimi # Kimi Code
|
|
20
22
|
```
|
|
21
23
|
|
|
24
|
+
Claude and Gemini use `/specrails:<command>`. Codex activates the generated
|
|
25
|
+
skill from `.codex/skills/`. Kimi's interactive TUI uses
|
|
26
|
+
`/skill:specrails-<command>`; headless Kimi runs must use the managed
|
|
27
|
+
`.kimi-code/specrails/run-skill.mjs` helper, not a literal `/skill:` prompt.
|
|
28
|
+
|
|
22
29
|
---
|
|
23
30
|
|
|
24
31
|
## Core workflow
|
|
25
32
|
|
|
26
|
-
### `/specrails:implement` โ
|
|
33
|
+
### `/specrails:implement` โ
Providers
|
|
27
34
|
|
|
28
35
|
Implement a feature through the full agent pipeline: design โ code โ tests โ docs โ review โ PR.
|
|
29
36
|
|
|
@@ -62,10 +69,15 @@ A single issue runs sequentially on the current branch. Multiple issues run in p
|
|
|
62
69
|
|
|
63
70
|
---
|
|
64
71
|
|
|
65
|
-
### `/specrails:telemetry` โ
|
|
72
|
+
### `/specrails:telemetry` โ
Providers
|
|
66
73
|
|
|
67
74
|
Inspect per-agent execution metrics: token usage, estimated API cost, run count, average duration, and success/failure rate.
|
|
68
75
|
|
|
76
|
+
Kimi reads persisted `usage.record` events for real input/output/cache token
|
|
77
|
+
counts and session duration. Its logs do not contain an authoritative USD rate
|
|
78
|
+
or role outcome, so the Kimi dashboard reports cost and success rate as
|
|
79
|
+
unavailable instead of applying another provider's rate card.
|
|
80
|
+
|
|
69
81
|
```
|
|
70
82
|
/specrails:telemetry
|
|
71
83
|
/specrails:telemetry --period today
|
|
@@ -81,11 +93,11 @@ Inspect per-agent execution metrics: token usage, estimated API cost, run count,
|
|
|
81
93
|
| `--period <filter>` | Time window: `today`, `week` (default), or `all` |
|
|
82
94
|
| `--agent <name>` | Focus on a single agent (e.g. `sr-developer`) |
|
|
83
95
|
| `--format <fmt>` | Output format: `markdown` (default) or `json` |
|
|
84
|
-
| `--save` | Write a snapshot
|
|
96
|
+
| `--save` | Write a snapshot under the active provider directory after display |
|
|
85
97
|
|
|
86
98
|
---
|
|
87
99
|
|
|
88
|
-
### `/specrails:merge-resolve` โ
|
|
100
|
+
### `/specrails:merge-resolve` โ
Providers
|
|
89
101
|
|
|
90
102
|
Resolve git conflict markers using AI-powered context analysis.
|
|
91
103
|
|
|
@@ -107,7 +119,7 @@ Reads OpenSpec context bundles from the features that produced each conflict, in
|
|
|
107
119
|
|
|
108
120
|
---
|
|
109
121
|
|
|
110
|
-
### `/specrails:retry` โ
|
|
122
|
+
### `/specrails:retry` โ
Providers
|
|
111
123
|
|
|
112
124
|
Resume a failed `/specrails:implement` run from the last successful phase.
|
|
113
125
|
|
|
@@ -128,7 +140,7 @@ Resume a failed `/specrails:implement` run from the last successful phase.
|
|
|
128
140
|
|
|
129
141
|
**Valid `--from` values:** `architect`, `developer`, `test-writer`, `doc-sync`, `reviewer`, `ship`, `ci`
|
|
130
142
|
|
|
131
|
-
Pipeline state is saved
|
|
143
|
+
Pipeline state is saved under the active provider directory after each phase.
|
|
132
144
|
|
|
133
145
|
---
|
|
134
146
|
|
|
@@ -148,7 +160,7 @@ Each feature gets its own worktree, its own agent pipeline, and its own PR. Use
|
|
|
148
160
|
|
|
149
161
|
## Product and backlog
|
|
150
162
|
|
|
151
|
-
### `/specrails:get-backlog-specs` โ
|
|
163
|
+
### `/specrails:get-backlog-specs` โ
Providers
|
|
152
164
|
|
|
153
165
|
View your prioritized product backlog, ranked by VPC persona fit and estimated effort.
|
|
154
166
|
|
|
@@ -161,7 +173,7 @@ Reads GitHub Issues labeled `product-driven-backlog`. Produces a ranked table pe
|
|
|
161
173
|
|
|
162
174
|
---
|
|
163
175
|
|
|
164
|
-
### `/specrails:auto-propose-backlog-specs` โ
|
|
176
|
+
### `/specrails:auto-propose-backlog-specs` โ
Providers
|
|
165
177
|
|
|
166
178
|
Generate new feature ideas through product discovery and create GitHub Issues.
|
|
167
179
|
|
|
@@ -176,7 +188,7 @@ The Product Manager researches your competitive landscape, generates 2โ4 featu
|
|
|
176
188
|
|
|
177
189
|
## Analysis and inspection
|
|
178
190
|
|
|
179
|
-
### `/specrails:refactor-recommender` โ
|
|
191
|
+
### `/specrails:refactor-recommender` โ
Providers
|
|
180
192
|
|
|
181
193
|
Scan the codebase for refactoring opportunities, ranked by impact/effort ratio.
|
|
182
194
|
|
|
@@ -188,7 +200,7 @@ Identifies duplicates, overly long functions, large files, dead code, outdated p
|
|
|
188
200
|
|
|
189
201
|
---
|
|
190
202
|
|
|
191
|
-
### `/specrails:compat-check` โ
|
|
203
|
+
### `/specrails:compat-check` โ
Providers
|
|
192
204
|
|
|
193
205
|
Analyze the backwards-compatibility impact of a proposed change.
|
|
194
206
|
|
|
@@ -205,7 +217,7 @@ The Architect runs this automatically as part of every `/specrails:implement` pi
|
|
|
205
217
|
|
|
206
218
|
---
|
|
207
219
|
|
|
208
|
-
### `/specrails:why` โ
|
|
220
|
+
### `/specrails:why` โ
Providers
|
|
209
221
|
|
|
210
222
|
Search agent explanation records in plain language.
|
|
211
223
|
|
|
@@ -215,11 +227,13 @@ Search agent explanation records in plain language.
|
|
|
215
227
|
/specrails:why "why is pagination implemented this way"
|
|
216
228
|
```
|
|
217
229
|
|
|
218
|
-
Agents write decision rationale
|
|
230
|
+
Agents write decision rationale under the active provider's `agent-memory/`
|
|
231
|
+
directory as they work. `/specrails:why` searches these records semantically.
|
|
232
|
+
Useful for onboarding, code review, and revisiting past decisions.
|
|
219
233
|
|
|
220
234
|
---
|
|
221
235
|
|
|
222
|
-
### `/specrails:vpc-drift` โ
|
|
236
|
+
### `/specrails:vpc-drift` โ
Providers
|
|
223
237
|
|
|
224
238
|
Detect when your VPC personas have drifted from what your product actually delivers.
|
|
225
239
|
|
|
@@ -234,7 +248,7 @@ Compares persona Jobs/Pains/Gains against your backlog, implemented features, an
|
|
|
234
248
|
|
|
235
249
|
---
|
|
236
250
|
|
|
237
|
-
### `/specrails:memory-inspect` โ
|
|
251
|
+
### `/specrails:memory-inspect` โ
Providers
|
|
238
252
|
|
|
239
253
|
Inspect and clean up agent memory directories.
|
|
240
254
|
|
|
@@ -252,11 +266,18 @@ Inspect and clean up agent memory directories.
|
|
|
252
266
|
| `--stale <days>` | Flag files older than N days |
|
|
253
267
|
| `--prune` | Delete stale files (prompts for confirmation) |
|
|
254
268
|
|
|
255
|
-
Agent memory lives
|
|
269
|
+
Agent memory lives below the provider root:
|
|
270
|
+
|
|
271
|
+
| Provider | Memory root |
|
|
272
|
+
|----------|-------------|
|
|
273
|
+
| Claude Code | `.claude/agent-memory/` |
|
|
274
|
+
| Codex CLI | `.codex/agent-memory/` |
|
|
275
|
+
| Gemini CLI | `.gemini/agent-memory/` |
|
|
276
|
+
| Kimi Code | `.kimi-code/agent-memory/` |
|
|
256
277
|
|
|
257
278
|
---
|
|
258
279
|
|
|
259
|
-
### `/specrails:propose-spec` โ
|
|
280
|
+
### `/specrails:propose-spec` โ
Providers
|
|
260
281
|
|
|
261
282
|
Explore a feature idea and produce a structured proposal ready for the OpenSpec pipeline.
|
|
262
283
|
|
|
@@ -272,7 +293,7 @@ Produces: problem statement, proposed solution, out-of-scope items, acceptance c
|
|
|
272
293
|
|
|
273
294
|
OpenSpec is the structured design-to-code workflow. Use these commands when you want explicit control over each artifact: proposal โ design โ tasks โ implementation.
|
|
274
295
|
|
|
275
|
-
|
|
296
|
+
OpenSpec commands are generated for all four providers (โ
Providers).
|
|
276
297
|
|
|
277
298
|
### `/opsx:ff` โ Fast Forward
|
|
278
299
|
|
|
@@ -400,7 +421,7 @@ The `npx specrails-core@latest init` command accepts:
|
|
|
400
421
|
|------|--------|
|
|
401
422
|
| `--root-dir <path>` | Install into this directory (default: current directory) |
|
|
402
423
|
| `--yes` / `-y` | Skip confirmation prompts |
|
|
403
|
-
| `--provider <claude\|codex>` | Force a specific AI CLI (default: auto-detect) |
|
|
424
|
+
| `--provider <claude\|codex\|gemini\|kimi>` | Force a specific AI CLI (default: auto-detect) |
|
|
404
425
|
|
|
405
426
|
---
|
|
406
427
|
|
|
@@ -1,10 +1,8 @@
|
|
|
1
1
|
# Codex vs Claude Code
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
SpecRails supports **Anthropic Claude Code** as an AI agent runtime, with **OpenAI Codex** support coming soon. This page explains the differences so you can choose the right setup for your team when Codex ships.
|
|
3
|
+
SpecRails supports both **Anthropic Claude Code** and **OpenAI Codex** as AI
|
|
4
|
+
agent runtimes. Gemini CLI and Kimi Code are also supported; this page focuses
|
|
5
|
+
only on the Claude/Codex comparison.
|
|
8
6
|
|
|
9
7
|
---
|
|
10
8
|
|
|
@@ -12,7 +10,7 @@ SpecRails supports **Anthropic Claude Code** as an AI agent runtime, with **Open
|
|
|
12
10
|
|
|
13
11
|
| | Claude Code | Codex |
|
|
14
12
|
|--|-------------|-------|
|
|
15
|
-
| **Support status** |
|
|
13
|
+
| **Support status** | Supported | Supported |
|
|
16
14
|
| **CLI** | `claude` | `codex` |
|
|
17
15
|
| **Config directory** | `.claude/` | `.codex/` |
|
|
18
16
|
| **Agent instructions** | `CLAUDE.md` | `AGENTS.md` |
|
|
@@ -113,7 +111,11 @@ Skills themselves are the same โ only the CLI invocation differs.
|
|
|
113
111
|
- Different team members use different tools
|
|
114
112
|
- You want to benchmark agents across platforms
|
|
115
113
|
|
|
116
|
-
When
|
|
114
|
+
When several CLIs are installed, pass `--provider` to choose explicitly:
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
npx specrails-core@latest init --provider codex
|
|
118
|
+
```
|
|
117
119
|
|
|
118
120
|
---
|
|
119
121
|
|
|
@@ -129,8 +131,8 @@ Generating config in .codex/
|
|
|
129
131
|
To override:
|
|
130
132
|
|
|
131
133
|
```bash
|
|
132
|
-
|
|
133
|
-
|
|
134
|
+
npx specrails-core@latest init --provider codex --root-dir .
|
|
135
|
+
npx specrails-core@latest init --provider claude --root-dir .
|
|
134
136
|
```
|
|
135
137
|
|
|
136
138
|
---
|
package/docs/user-docs/faq.md
CHANGED
|
@@ -12,7 +12,7 @@ The plugin method (`claude plugin install sr`) installs logic into Claude Code's
|
|
|
12
12
|
|
|
13
13
|
**Do I need Node.js if my project is not JavaScript?**
|
|
14
14
|
|
|
15
|
-
Not for the plugin method (`claude plugin install sr`). Node.js 20+ is only required for the scaffold method (`npx specrails-core@latest init`). Once installed, SpecRails works with any language or framework, on macOS, Linux, or Windows.
|
|
15
|
+
Not for the plugin method (`claude plugin install sr`). Node.js 20.19.0+ is only required for the scaffold method (`npx specrails-core@latest init`), because its pinned OpenSpec 1.4.1 CLI uses that runtime floor. Once installed, SpecRails works with any language or framework, on macOS, Linux, or Windows.
|
|
16
16
|
|
|
17
17
|
**Do I need GitHub Issues?**
|
|
18
18
|
|
|
@@ -1,12 +1,9 @@
|
|
|
1
1
|
# Getting Started with SpecRails + Codex
|
|
2
2
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
> **Current status:** Preview / documentation only. For now, use [Claude Code](https://claude.ai/download) โ see the [standard installation guide](installation.md).
|
|
8
|
-
|
|
9
|
-
This guide gets you running SpecRails using OpenAI Codex as your AI agent. If you are using Claude Code instead, see the [standard installation guide](installation.md).
|
|
3
|
+
This guide gets you running SpecRails using OpenAI Codex as your AI agent.
|
|
4
|
+
Claude Code, Gemini CLI, and Kimi Code are also supported; see the
|
|
5
|
+
[standard installation guide](installation.md) or the
|
|
6
|
+
[Kimi-specific guide](getting-started-kimi.md).
|
|
10
7
|
|
|
11
8
|
---
|
|
12
9
|
|
|
@@ -14,7 +11,7 @@ This guide gets you running SpecRails using OpenAI Codex as your AI agent. If yo
|
|
|
14
11
|
|
|
15
12
|
| Tool | Version | Notes |
|
|
16
13
|
|------|---------|-------|
|
|
17
|
-
| **Node.js** |
|
|
14
|
+
| **Node.js** | 20.19.0+ | Required for the installer and pinned OpenSpec 1.4.1 CLI |
|
|
18
15
|
| **Codex CLI** | Latest | `npm i -g @openai/codex` |
|
|
19
16
|
| **Git** | Any | Your project must be a git repository |
|
|
20
17
|
|