specsmd 0.0.0-dev.78 → 0.0.0-dev.79
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 +172 -236
- package/flows/aidlc/scripts/{artifact-validator.js → artifact-validator.cjs} +3 -3
- package/flows/aidlc/scripts/{bolt-complete.js → bolt-complete.cjs} +3 -3
- package/flows/aidlc/scripts/{status-integrity.js → status-integrity.cjs} +5 -5
- package/flows/aidlc/skills/construction/bolt-start.md +3 -3
- package/flows/aidlc/skills/construction/prototype-apply.md +6 -0
- package/flows/aidlc/skills/inception/vibe-to-spec.md +4 -0
- package/flows/fire/agents/builder/agent.md +19 -17
- package/flows/fire/agents/builder/skills/code-review/SKILL.md +9 -6
- package/flows/fire/agents/builder/skills/code-review/references/auto-fix-rules.md +6 -0
- package/flows/fire/agents/builder/skills/run-execute/SKILL.md +181 -62
- package/flows/fire/agents/builder/skills/run-execute/scripts/{complete-run.js → complete-run.cjs} +274 -75
- package/flows/fire/agents/builder/skills/run-execute/scripts/{init-run.js → init-run.cjs} +22 -19
- package/flows/fire/agents/builder/skills/run-execute/scripts/update-phase.cjs +239 -0
- package/flows/fire/agents/builder/skills/run-plan/SKILL.md +44 -46
- package/flows/fire/agents/builder/skills/run-status/SKILL.md +3 -1
- package/flows/fire/agents/builder/skills/walkthrough-generate/SKILL.md +131 -7
- package/flows/fire/agents/builder/skills/walkthrough-generate/templates/walkthrough.md.hbs +99 -0
- package/flows/fire/agents/orchestrator/agent.md +22 -5
- package/flows/fire/agents/orchestrator/skills/project-init/SKILL.md +2 -1
- package/flows/fire/agents/orchestrator/skills/route/SKILL.md +11 -6
- package/flows/fire/agents/orchestrator/skills/status/SKILL.md +609 -13
- package/flows/fire/agents/planner/agent.md +5 -0
- package/flows/fire/agents/planner/skills/design-doc-generate/SKILL.md +1 -0
- package/flows/fire/agents/planner/skills/intent-capture/SKILL.md +1 -0
- package/flows/fire/agents/planner/skills/work-item-decompose/SKILL.md +1 -0
- package/flows/fire/commands/fire-builder.md +1 -1
- package/flows/fire/commands/fire-planner.md +1 -1
- package/flows/fire/commands/fire.md +1 -1
- package/flows/fire/memory-bank.yaml +29 -12
- package/flows/fire/quick-start.md +16 -0
- package/lib/constants.js +6 -3
- package/lib/installer.js +14 -0
- package/package.json +1 -1
- package/flows/fire/agents/builder/skills/walkthrough-generate/scripts/render-walkthrough.ts +0 -755
- package/flows/fire/agents/orchestrator/skills/project-migrate/SKILL.md +0 -234
package/README.md
CHANGED
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
<img src="images/specs_md_pixel_logo.png" alt="specs.md logo" width="400" />
|
|
5
5
|
</p>
|
|
6
6
|
|
|
7
|
-
**AI-native
|
|
7
|
+
**AI-native development framework with pluggable flows for every use case.**
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Choose the flow that matches your project needs: **Simple** for quick specs, **FIRE** for adaptive execution, or **AI-DLC** for full methodology with DDD.
|
|
10
10
|
|
|
11
11
|
[](https://www.npmjs.com/package/specsmd)
|
|
12
12
|
[](https://opensource.org/licenses/MIT)
|
|
@@ -20,14 +20,29 @@ specsmd implements the [AI-Driven Development Lifecycle (AI-DLC)](https://aws.am
|
|
|
20
20
|
|
|
21
21
|
## VS Code Extension
|
|
22
22
|
|
|
23
|
-
Track your
|
|
23
|
+
Track your progress with our sidebar extension for VS Code and compatible IDEs.
|
|
24
|
+
|
|
25
|
+
**AI-DLC Flow:**
|
|
26
|
+
|
|
27
|
+
<p align="center">
|
|
28
|
+
<img src="vs-code-extension/resources/extension-preview.png" alt="AI-DLC Flow Extension Preview" width="800" />
|
|
29
|
+
</p>
|
|
30
|
+
|
|
31
|
+
**FIRE Flow:**
|
|
24
32
|
|
|
25
33
|
<p align="center">
|
|
26
|
-
<img src="
|
|
34
|
+
<img src="images/fire1.png" alt="FIRE Flow - Intents View" width="400" />
|
|
35
|
+
<img src="images/fire3.png" alt="FIRE Flow - Runs View" width="400" />
|
|
27
36
|
</p>
|
|
28
37
|
|
|
29
38
|
> **Note:** Works with any VS Code-based IDE including [Cursor](https://cursor.sh), [Google Antigravity](https://antigravity.google), [Windsurf](https://codeium.com/windsurf), and others.
|
|
30
39
|
|
|
40
|
+
**Features:**
|
|
41
|
+
- Flow switcher for AI-DLC and FIRE views
|
|
42
|
+
- Active run/bolt tracking with progress indicators
|
|
43
|
+
- Intent and work item visualization
|
|
44
|
+
- Click-to-open spec files
|
|
45
|
+
|
|
31
46
|
**Install from:**
|
|
32
47
|
- [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=fabriqaai.specsmd) — VS Code, GitHub Codespaces
|
|
33
48
|
- [Open VSX Registry](https://open-vsx.org/extension/fabriqaai/specsmd) — Cursor, Windsurf, Amazon Kiro, Google Antigravity, VSCodium, Gitpod, Google IDX
|
|
@@ -35,6 +50,18 @@ Track your AI-DLC progress with our sidebar extension for VS Code and compatible
|
|
|
35
50
|
|
|
36
51
|
---
|
|
37
52
|
|
|
53
|
+
## Three Flows, Every Use Case
|
|
54
|
+
|
|
55
|
+
| Flow | Optimized For | Agents | Checkpoints |
|
|
56
|
+
|------|---------------|--------|-------------|
|
|
57
|
+
| **[Simple](#simple-flow)** | Spec generation, prototypes | 1 | 3 (phase gates) |
|
|
58
|
+
| **[FIRE](#fire-flow)** | Adaptive execution, brownfield, monorepos | 3 | Adaptive (0-2) |
|
|
59
|
+
| **[AI-DLC](#ai-dlc-flow)** | Full traceability, DDD, regulated environments | 4 | Comprehensive |
|
|
60
|
+
|
|
61
|
+
> **Not sure which flow?** If you want quick specs without execution tracking, use **Simple**. If you want adaptive execution that right-sizes rigor, use **FIRE**. If you need comprehensive documentation and DDD, use **AI-DLC**.
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
38
65
|
## Quick Start
|
|
39
66
|
|
|
40
67
|
### Prerequisites
|
|
@@ -45,275 +72,177 @@ Track your AI-DLC progress with our sidebar extension for VS Code and compatible
|
|
|
45
72
|
### Installation
|
|
46
73
|
|
|
47
74
|
> [!NOTE]
|
|
48
|
-
>
|
|
75
|
+
> Always use npx to get the latest version. Do not install globally with npm.
|
|
49
76
|
|
|
50
77
|
```bash
|
|
51
78
|
npx specsmd@latest install
|
|
52
79
|
```
|
|
53
80
|
|
|
54
|
-
|
|
55
|
-
- Agent definitions and skills
|
|
56
|
-
- Memory bank structure for context persistence
|
|
57
|
-
- Slash commands for easy agent invocation
|
|
81
|
+
During installation, select your flow:
|
|
58
82
|
|
|
59
|
-
### Verify Installation
|
|
60
|
-
|
|
61
|
-
```bash
|
|
62
|
-
# Check the manifest
|
|
63
|
-
cat .specsmd/manifest.yaml
|
|
64
|
-
|
|
65
|
-
# List installed agents
|
|
66
|
-
ls .specsmd/aidlc/agents/
|
|
67
83
|
```
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
```bash
|
|
73
|
-
# Start the Master Agent
|
|
74
|
-
/specsmd-master-agent
|
|
75
|
-
|
|
76
|
-
# Then type:
|
|
77
|
-
project-init
|
|
84
|
+
? Select a development flow:
|
|
85
|
+
Simple - Spec generation only (requirements, design, tasks)
|
|
86
|
+
❯ FIRE - Adaptive execution, brownfield & monorepo ready
|
|
87
|
+
AI-DLC - Full methodology with DDD (comprehensive checkpoints)
|
|
78
88
|
```
|
|
79
89
|
|
|
80
|
-
|
|
81
|
-
- **Tech Stack** - Languages, frameworks, databases, infrastructure
|
|
82
|
-
- **Coding Standards** - Formatting, linting, naming, testing strategy
|
|
83
|
-
- **System Architecture** - Architecture style, API design, state management
|
|
84
|
-
- **UX Guide** - Design system, styling, accessibility (optional)
|
|
85
|
-
- **API Conventions** - API style, versioning, response formats (optional)
|
|
90
|
+
The installer detects your AI coding tools and sets up agent definitions, slash commands, and project structure for your selected flow.
|
|
86
91
|
|
|
87
|
-
###
|
|
92
|
+
### Install VS Code Extension (Optional)
|
|
88
93
|
|
|
89
|
-
|
|
90
|
-
/specsmd
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
An **Intent** is your high-level goal:
|
|
94
|
-
- "User authentication system"
|
|
95
|
-
- "Product catalog with search"
|
|
96
|
-
- "Payment processing integration"
|
|
97
|
-
|
|
98
|
-
The agent will:
|
|
99
|
-
1. Ask clarifying questions to minimize ambiguity
|
|
100
|
-
2. Elaborate into user stories and NFRs
|
|
101
|
-
3. Define system context
|
|
102
|
-
4. Decompose into loosely-coupled units
|
|
94
|
+
Track your progress visually with our sidebar extension:
|
|
95
|
+
- [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=fabriqaai.specsmd) — VS Code, GitHub Codespaces
|
|
96
|
+
- [Open VSX Registry](https://open-vsx.org/extension/fabriqaai/specsmd) — Cursor, Windsurf, Amazon Kiro, Google Antigravity
|
|
103
97
|
|
|
104
|
-
###
|
|
98
|
+
### Verify Installation
|
|
105
99
|
|
|
106
100
|
```bash
|
|
107
|
-
#
|
|
108
|
-
/
|
|
101
|
+
# Check the manifest
|
|
102
|
+
cat .specsmd/manifest.yaml
|
|
109
103
|
|
|
110
|
-
#
|
|
111
|
-
/
|
|
104
|
+
# List installed agents (adjust path for your flow)
|
|
105
|
+
ls .specsmd/fire/agents/ # FIRE flow
|
|
106
|
+
ls .specsmd/simple/agents/ # Simple flow
|
|
107
|
+
ls .specsmd/aidlc/agents/ # AI-DLC flow
|
|
112
108
|
```
|
|
113
109
|
|
|
114
|
-
Each bolt goes through validated stages:
|
|
115
|
-
1. **Domain Model** - Model business logic using DDD principles
|
|
116
|
-
2. **Technical Design** - Apply patterns and make architecture decisions
|
|
117
|
-
3. **ADR Analysis** - Document significant decisions (optional)
|
|
118
|
-
4. **Implement** - Generate production code
|
|
119
|
-
5. **Test** - Verify correctness with automated tests
|
|
120
|
-
|
|
121
|
-
**Human validation happens at each stage gate.**
|
|
122
|
-
|
|
123
110
|
---
|
|
124
111
|
|
|
125
|
-
##
|
|
126
|
-
|
|
127
|
-
AI-DLC is a reimagined software development methodology where **AI drives the conversation** and humans validate. Unlike traditional Agile where iterations span weeks, AI-DLC operates in **Bolts** - rapid iterations measured in hours or days.
|
|
112
|
+
## Simple Flow
|
|
128
113
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
### AI-DLC vs Traditional Methods
|
|
132
|
-
|
|
133
|
-
| Aspect | Agile/Scrum | AI-DLC |
|
|
134
|
-
|--------|-------------|--------|
|
|
135
|
-
| Iteration duration | Weeks (Sprints) | Hours/days (Bolts) |
|
|
136
|
-
| Who drives | Human-driven, AI assists | AI-driven, human-validated |
|
|
137
|
-
| Design techniques | Out of scope | Integrated (DDD, TDD, BDD) |
|
|
138
|
-
| Task decomposition | Manual | AI-powered |
|
|
139
|
-
| Phases | Repeating sprints | Rapid three-phase cycles (Inception → Construction → Operations) |
|
|
140
|
-
| Rituals | Daily standups, retrospectives | Mob Elaboration, Mob Construction |
|
|
141
|
-
|
|
142
|
-
---
|
|
114
|
+
**Spec generation only.** Generate requirements, design, and task documents without execution tracking.
|
|
143
115
|
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
116
|
+
```
|
|
117
|
+
/specsmd-agent
|
|
118
|
+
```
|
|
147
119
|
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
MA --> OA[Operations Agent]
|
|
120
|
+
**Three Phases:**
|
|
121
|
+
1. **Requirements** → `requirements.md` - User stories, EARS criteria
|
|
122
|
+
2. **Design** → `design.md` - Technical design, architecture diagrams
|
|
123
|
+
3. **Tasks** → `tasks.md` - Implementation checklist
|
|
153
124
|
|
|
154
|
-
|
|
125
|
+
**Best for:** Prototypes, MVPs, spec handoff, projects that don't need AI-assisted execution.
|
|
155
126
|
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
127
|
+
**Output structure:**
|
|
128
|
+
```
|
|
129
|
+
specs/
|
|
130
|
+
└── {feature-name}/
|
|
131
|
+
├── requirements.md
|
|
132
|
+
├── design.md
|
|
133
|
+
└── tasks.md
|
|
160
134
|
```
|
|
161
135
|
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
| Phase | Agent | Purpose | Key Outputs |
|
|
165
|
-
|-------|-------|---------|-------------|
|
|
166
|
-
| **Inception** | Inception Agent | Capture intents, elaborate requirements, decompose into units | User stories, NFRs, Unit definitions, Bolt plans |
|
|
167
|
-
| **Construction** | Construction Agent | Execute bolts through domain design → logical design → code → test | Domain models, Technical designs, Code, Tests |
|
|
168
|
-
| **Operations** | Operations Agent | Deploy, verify, and monitor | Deployment units, Monitoring, Runbooks |
|
|
136
|
+
[Simple Flow Documentation →](https://specs.md/simple-flow/overview)
|
|
169
137
|
|
|
170
138
|
---
|
|
171
139
|
|
|
172
|
-
##
|
|
140
|
+
## FIRE Flow
|
|
173
141
|
|
|
174
|
-
|
|
175
|
-
A high-level statement of purpose that encapsulates what needs to be achieved - whether a business goal, feature, or technical outcome. It serves as the starting point for AI-driven decomposition.
|
|
142
|
+
**Fast Intent-Run Engineering.** Adaptive execution with brownfield and monorepo support. Ships in hours with 0-2 checkpoints based on task complexity.
|
|
176
143
|
|
|
177
|
-
|
|
178
|
-
|
|
144
|
+
```
|
|
145
|
+
/fire-orchestrator # Entry point, routing
|
|
146
|
+
/fire-planner # Intent capture, work item decomposition
|
|
147
|
+
/fire-builder # Run execution, walkthrough generation
|
|
148
|
+
```
|
|
179
149
|
|
|
180
|
-
|
|
181
|
-
|
|
150
|
+
**Key Features:**
|
|
151
|
+
- **Adaptive checkpoints** - Autopilot (0), Confirm (1), or Validate (2) based on complexity
|
|
152
|
+
- **First-class brownfield** - Auto-detects existing patterns and conventions
|
|
153
|
+
- **Monorepo support** - Hierarchical standards with module-specific overrides
|
|
154
|
+
- **Walkthrough generation** - Documents every change automatically
|
|
182
155
|
|
|
183
|
-
|
|
184
|
-
|------|----------|--------|
|
|
185
|
-
| **DDD Construction** | Complex business logic, domain modeling | Model → Design → ADR → Implement → Test |
|
|
186
|
-
| **Simple Construction** | UI, integrations, utilities | Plan → Implement → Test |
|
|
156
|
+
**Best for:** Teams who hate friction, brownfield projects, monorepos.
|
|
187
157
|
|
|
188
|
-
|
|
189
|
-
|
|
158
|
+
**Output structure:**
|
|
159
|
+
```
|
|
160
|
+
.specs-fire/
|
|
161
|
+
├── state.yaml # Central state tracking
|
|
162
|
+
├── standards/ # Project standards
|
|
163
|
+
├── intents/ # Intent documentation
|
|
164
|
+
├── runs/ # Run logs
|
|
165
|
+
└── walkthroughs/ # Generated documentation
|
|
166
|
+
```
|
|
190
167
|
|
|
191
|
-
|
|
192
|
-
Project decisions that inform AI code generation. Standards ensure consistency across all generated code and documentation.
|
|
168
|
+
[FIRE Flow Documentation →](https://specs.md/fire-flow/overview)
|
|
193
169
|
|
|
194
170
|
---
|
|
195
171
|
|
|
196
|
-
|
|
197
|
-
<summary><h2>Project Structure</h2></summary>
|
|
172
|
+
## AI-DLC Flow
|
|
198
173
|
|
|
199
|
-
|
|
174
|
+
**Full methodology.** Implements the [AI-Driven Development Lifecycle](https://aws.amazon.com/blogs/devops/ai-driven-development-life-cycle/) with Domain-Driven Design and comprehensive traceability.
|
|
200
175
|
|
|
201
176
|
```
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
├── skills/ # Agent capabilities
|
|
207
|
-
├── templates/ # Artifact templates
|
|
208
|
-
│ └── standards/ # Standards facilitation guides
|
|
209
|
-
└── memory-bank.yaml # Memory bank schema
|
|
210
|
-
|
|
211
|
-
memory-bank/ # Created after project-init
|
|
212
|
-
├── intents/ # Your captured intents
|
|
213
|
-
│ └── {intent-name}/
|
|
214
|
-
│ ├── requirements.md
|
|
215
|
-
│ ├── system-context.md
|
|
216
|
-
│ └── units/
|
|
217
|
-
├── bolts/ # Bolt execution records
|
|
218
|
-
├── standards/ # Project standards
|
|
219
|
-
│ ├── tech-stack.md
|
|
220
|
-
│ ├── coding-standards.md
|
|
221
|
-
│ └── ...
|
|
222
|
-
└── operations/ # Deployment context
|
|
177
|
+
/specsmd-master-agent # Orchestrates & navigates
|
|
178
|
+
/specsmd-inception-agent # Requirements, stories, bolt planning
|
|
179
|
+
/specsmd-construction-agent # Execute bolts through DDD stages
|
|
180
|
+
/specsmd-operations-agent # Deploy, verify, monitor
|
|
223
181
|
```
|
|
224
182
|
|
|
225
|
-
|
|
183
|
+
**Three Sequential Phases:**
|
|
184
|
+
1. **Inception** - Capture intents, elaborate requirements, decompose into units
|
|
185
|
+
2. **Construction** - Execute bolts: Model → Design → ADR → Implement → Test
|
|
186
|
+
3. **Operations** - Deploy, verify, and monitor
|
|
226
187
|
|
|
227
|
-
|
|
228
|
-
<summary><h2>Agent Commands</h2></summary>
|
|
188
|
+
**Best for:** Complex domains, multi-team coordination, regulated environments.
|
|
229
189
|
|
|
230
|
-
|
|
231
|
-
```bash
|
|
232
|
-
/specsmd-master-agent
|
|
190
|
+
**Output structure:**
|
|
233
191
|
```
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
```bash
|
|
244
|
-
/specsmd-inception-agent
|
|
245
|
-
```
|
|
246
|
-
| Command | Purpose |
|
|
247
|
-
|---------|---------|
|
|
248
|
-
| `intent-create` | Create a new intent |
|
|
249
|
-
| `intent-list` | List all intents |
|
|
250
|
-
| `requirements` | Elaborate intent requirements |
|
|
251
|
-
| `context` | Define system context |
|
|
252
|
-
| `units` | Decompose into units |
|
|
253
|
-
| `story-create` | Create stories for a unit |
|
|
254
|
-
| `bolt-plan` | Plan bolts for stories |
|
|
255
|
-
| `review` | Review inception artifacts |
|
|
256
|
-
|
|
257
|
-
### Construction Agent
|
|
258
|
-
```bash
|
|
259
|
-
/specsmd-construction-agent
|
|
260
|
-
```
|
|
261
|
-
| Command | Purpose |
|
|
262
|
-
|---------|---------|
|
|
263
|
-
| `bolt-start` | Start/continue executing a bolt |
|
|
264
|
-
| `bolt-status` | Check bolt progress |
|
|
265
|
-
| `bolt-list` | List all bolts |
|
|
266
|
-
| `bolt-replan` | Replan bolts if needed |
|
|
267
|
-
|
|
268
|
-
### Operations Agent
|
|
269
|
-
```bash
|
|
270
|
-
/specsmd-operations-agent
|
|
192
|
+
memory-bank/
|
|
193
|
+
├── standards/ # Project standards
|
|
194
|
+
├── intents/ # Intent documentation
|
|
195
|
+
│ └── {intent-name}/
|
|
196
|
+
│ ├── requirements.md
|
|
197
|
+
│ ├── system-context.md
|
|
198
|
+
│ └── units/
|
|
199
|
+
├── bolts/ # Bolt execution records
|
|
200
|
+
└── operations/ # Deployment context
|
|
271
201
|
```
|
|
272
|
-
| Command | Purpose |
|
|
273
|
-
|---------|---------|
|
|
274
|
-
| `build` | Build the project |
|
|
275
|
-
| `deploy` | Deploy to environment |
|
|
276
|
-
| `verify` | Verify deployment |
|
|
277
|
-
| `monitor` | Set up monitoring |
|
|
278
202
|
|
|
279
|
-
|
|
203
|
+
[AI-DLC Flow Documentation →](https://specs.md/aidlc/overview)
|
|
280
204
|
|
|
281
205
|
---
|
|
282
206
|
|
|
283
|
-
## Why
|
|
207
|
+
## Why specs.md?
|
|
284
208
|
|
|
285
|
-
###
|
|
286
|
-
|
|
209
|
+
### Three Flows for Every Use Case
|
|
210
|
+
From quick specs (Simple) to adaptive execution (FIRE) to full methodology (AI-DLC). Choose the flow that matches your project needs.
|
|
287
211
|
|
|
288
|
-
###
|
|
289
|
-
|
|
212
|
+
### Adaptive Checkpoints (FIRE)
|
|
213
|
+
Right-sizes the rigor. Simple bug fixes burn through fast. Critical changes get design review. You configure your autonomy preference.
|
|
290
214
|
|
|
291
|
-
###
|
|
292
|
-
|
|
215
|
+
### First-Class Brownfield & Monorepo (FIRE)
|
|
216
|
+
Auto-detects existing patterns and respects your conventions. Hierarchical standards with module-specific overrides.
|
|
217
|
+
|
|
218
|
+
### Full DDD Methodology (AI-DLC)
|
|
219
|
+
Domain-Driven Design is integral to Construction, not an optional add-on. Every decision documented with full traceability.
|
|
293
220
|
|
|
294
221
|
### Tool Agnostic
|
|
295
|
-
Works with Claude Code, Cursor, GitHub Copilot, and other AI coding assistants. Markdown-based agents work anywhere.
|
|
222
|
+
Works with Claude Code, Cursor, GitHub Copilot, and other AI coding assistants. Markdown-based agents work anywhere—no vendor lock-in.
|
|
296
223
|
|
|
297
224
|
### Context Engineering
|
|
298
|
-
|
|
225
|
+
Structured artifacts provide persistent context for AI agents. Agents reload context each session—no more lost knowledge.
|
|
299
226
|
|
|
300
227
|
---
|
|
301
228
|
|
|
302
229
|
## Supported Tools
|
|
303
230
|
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
|
307
|
-
|
|
308
|
-
| **
|
|
309
|
-
| **
|
|
310
|
-
| **
|
|
311
|
-
| **
|
|
312
|
-
| **
|
|
313
|
-
| **
|
|
314
|
-
| **
|
|
315
|
-
| **
|
|
316
|
-
| **
|
|
231
|
+
specs.md is **IDE and AI-agnostic**—your specs and agents are portable markdown files that work anywhere.
|
|
232
|
+
|
|
233
|
+
| Tool | Integration |
|
|
234
|
+
|------|-------------|
|
|
235
|
+
| **Claude Code** | Slash commands in `.claude/commands/` |
|
|
236
|
+
| **Cursor** | Rules in `.cursor/rules/` (`.mdc` format) |
|
|
237
|
+
| **GitHub Copilot** | Agents in `.github/agents/` (`.agent.md` format) |
|
|
238
|
+
| **Google Antigravity** | Agents in `.agent/agents/` |
|
|
239
|
+
| **Windsurf** | Rules in `.windsurf/rules/` |
|
|
240
|
+
| **Amazon Kiro** | Steering in `.kiro/steering/` |
|
|
241
|
+
| **Gemini CLI** | Commands in `.gemini/commands/` (`.toml` format) |
|
|
242
|
+
| **Cline** | Rules in `.clinerules/` |
|
|
243
|
+
| **Roo Code** | Commands in `.roo/commands/` |
|
|
244
|
+
| **OpenAI Codex** | Config in `.codex/` |
|
|
245
|
+
| **OpenCode** | Agents in `.opencode/agent/` |
|
|
317
246
|
|
|
318
247
|
---
|
|
319
248
|
|
|
@@ -324,7 +253,10 @@ Specs and Memory Bank provide structured context for AI agents. Agents reload co
|
|
|
324
253
|
|
|
325
254
|
Ensure specs.md is installed correctly:
|
|
326
255
|
```bash
|
|
327
|
-
|
|
256
|
+
# Check for your flow
|
|
257
|
+
ls .specsmd/fire/agents/ # FIRE
|
|
258
|
+
ls .specsmd/simple/agents/ # Simple
|
|
259
|
+
ls .specsmd/aidlc/agents/ # AI-DLC
|
|
328
260
|
```
|
|
329
261
|
|
|
330
262
|
If the directory is empty or missing, reinstall:
|
|
@@ -334,33 +266,26 @@ npx specsmd@latest install
|
|
|
334
266
|
</details>
|
|
335
267
|
|
|
336
268
|
<details>
|
|
337
|
-
<summary><strong>
|
|
269
|
+
<summary><strong>Project artifacts missing</strong></summary>
|
|
338
270
|
|
|
339
|
-
Check if the
|
|
271
|
+
Check if the artifacts directory exists for your flow:
|
|
340
272
|
```bash
|
|
341
|
-
ls
|
|
273
|
+
ls .specs-fire/ # FIRE flow
|
|
274
|
+
ls specs/ # Simple flow
|
|
275
|
+
ls memory-bank/ # AI-DLC flow
|
|
342
276
|
```
|
|
343
277
|
|
|
344
|
-
If missing,
|
|
345
|
-
```
|
|
346
|
-
/specsmd-master-agent
|
|
347
|
-
> project-init
|
|
348
|
-
```
|
|
278
|
+
If missing, initialize your project using the appropriate agent.
|
|
349
279
|
</details>
|
|
350
280
|
|
|
351
281
|
<details>
|
|
352
282
|
<summary><strong>Standards not being followed in generated code</strong></summary>
|
|
353
283
|
|
|
354
|
-
Ensure standards are defined in
|
|
355
|
-
-
|
|
356
|
-
- `
|
|
357
|
-
- `architecture.md`
|
|
284
|
+
Ensure standards are defined in your flow's standards directory:
|
|
285
|
+
- FIRE: `.specs-fire/standards/`
|
|
286
|
+
- AI-DLC: `memory-bank/standards/`
|
|
358
287
|
|
|
359
|
-
|
|
360
|
-
```
|
|
361
|
-
/specsmd-master-agent
|
|
362
|
-
> project-init
|
|
363
|
-
```
|
|
288
|
+
Run project initialization if missing.
|
|
364
289
|
</details>
|
|
365
290
|
|
|
366
291
|
---
|
|
@@ -368,17 +293,27 @@ If missing or incomplete, use the Master Agent to define them:
|
|
|
368
293
|
<details>
|
|
369
294
|
<summary><h2>FAQ</h2></summary>
|
|
370
295
|
|
|
296
|
+
**Q: Which flow should I choose?**
|
|
297
|
+
- **Simple**: Spec generation only, no execution tracking
|
|
298
|
+
- **FIRE**: Adaptive execution, brownfield/monorepo support
|
|
299
|
+
- **AI-DLC**: Full methodology with DDD and comprehensive traceability
|
|
300
|
+
|
|
301
|
+
**Q: Can I switch flows after installation?**
|
|
302
|
+
Flows are independent—they're not an upgrade path. Each is designed for different use cases. You can reinstall to change flows, but artifacts are structured differently.
|
|
303
|
+
|
|
371
304
|
**Q: Agents don't seem to remember previous context?**
|
|
372
|
-
Each agent invocation starts fresh. Agents read context from
|
|
305
|
+
Each agent invocation starts fresh. Agents read context from artifacts at startup. Ensure artifacts are saved after each step.
|
|
373
306
|
|
|
374
307
|
**Q: How do I reset project state?**
|
|
375
|
-
|
|
308
|
+
Delete the artifacts directory for your flow:
|
|
309
|
+
- FIRE: `.specs-fire/`
|
|
310
|
+
- Simple: `specs/`
|
|
311
|
+
- AI-DLC: `memory-bank/`
|
|
376
312
|
|
|
377
|
-
|
|
378
|
-
AI-DLC is designed as a reimagination, not a retrofit. However, familiar concepts (user stories, acceptance criteria) are retained to ease transition.
|
|
313
|
+
To remove specsmd entirely, also delete `.specsmd/` and tool-specific command files.
|
|
379
314
|
|
|
380
315
|
**Q: What project types is this suited for?**
|
|
381
|
-
|
|
316
|
+
specs.md supports everything from quick prototypes (Simple) to complex enterprise systems (AI-DLC). Choose the flow that matches your project needs.
|
|
382
317
|
|
|
383
318
|
</details>
|
|
384
319
|
|
|
@@ -387,10 +322,11 @@ specsmd is designed for building complex systems that demand architectural compl
|
|
|
387
322
|
## Resources
|
|
388
323
|
|
|
389
324
|
- [Documentation](https://specs.md)
|
|
325
|
+
- [Choose Your Flow Guide](https://specs.md/architecture/choose-flow)
|
|
390
326
|
- [AI-DLC Specification (AWS)](https://aws.amazon.com/blogs/devops/ai-driven-development-life-cycle/)
|
|
391
327
|
- [npm Package](https://www.npmjs.com/package/specsmd)
|
|
392
|
-
- [GitHub Issues](https://github.com/fabriqaai/
|
|
393
|
-
|
|
328
|
+
- [GitHub Issues](https://github.com/fabriqaai/specs.md/issues)
|
|
329
|
+
- [Discord Community](http://discord.specs.md/)
|
|
394
330
|
|
|
395
331
|
---
|
|
396
332
|
|
|
@@ -401,5 +337,5 @@ MIT License - see [LICENSE](LICENSE) for details.
|
|
|
401
337
|
---
|
|
402
338
|
|
|
403
339
|
<p align="center">
|
|
404
|
-
Built
|
|
340
|
+
Built by the <a href="https://specs.md">specs.md</a> team.
|
|
405
341
|
</p>
|
|
@@ -10,9 +10,9 @@
|
|
|
10
10
|
* - Timestamp format (ISO 8601 without milliseconds)
|
|
11
11
|
*
|
|
12
12
|
* Usage:
|
|
13
|
-
* node .specsmd/aidlc/scripts/artifact-validator.
|
|
14
|
-
* node .specsmd/aidlc/scripts/artifact-validator.
|
|
15
|
-
* node .specsmd/aidlc/scripts/artifact-validator.
|
|
13
|
+
* node .specsmd/aidlc/scripts/artifact-validator.cjs
|
|
14
|
+
* node .specsmd/aidlc/scripts/artifact-validator.cjs --json
|
|
15
|
+
* node .specsmd/aidlc/scripts/artifact-validator.cjs --fix
|
|
16
16
|
*
|
|
17
17
|
* Cross-platform: Works on Linux, macOS, Windows via Node.js
|
|
18
18
|
*/
|
|
@@ -115,11 +115,11 @@
|
|
|
115
115
|
*
|
|
116
116
|
* From agent skill (bolt-start.md Step 10):
|
|
117
117
|
*
|
|
118
|
-
* node .specsmd/aidlc/scripts/bolt-complete.
|
|
118
|
+
* node .specsmd/aidlc/scripts/bolt-complete.cjs 016-analytics-tracker
|
|
119
119
|
*
|
|
120
120
|
* With optional stage name:
|
|
121
121
|
*
|
|
122
|
-
* node .specsmd/aidlc/scripts/bolt-complete.
|
|
122
|
+
* node .specsmd/aidlc/scripts/bolt-complete.cjs 016-analytics-tracker --last-stage test
|
|
123
123
|
*
|
|
124
124
|
* ═══════════════════════════════════════════════════════════════════════════════
|
|
125
125
|
*/
|
|
@@ -594,7 +594,7 @@ const lastStage = process.argv['--last-stage'] || null;
|
|
|
594
594
|
|
|
595
595
|
if (!boltId) {
|
|
596
596
|
console.error(`${colors.red}Error:${colors.reset} Bolt ID required`);
|
|
597
|
-
console.error(`${colors.dim}Usage: node bolt-complete.
|
|
597
|
+
console.error(`${colors.dim}Usage: node bolt-complete.cjs <bolt-id> [--last-stage <stage-name>]${colors.reset}`);
|
|
598
598
|
process.exit(1);
|
|
599
599
|
}
|
|
600
600
|
|
|
@@ -7,8 +7,8 @@
|
|
|
7
7
|
* Status must cascade correctly: Bolt complete → Stories complete → Unit complete → Intent complete
|
|
8
8
|
*
|
|
9
9
|
* Usage:
|
|
10
|
-
* node .specsmd/aidlc/scripts/status-integrity.
|
|
11
|
-
* node .specsmd/aidlc/scripts/status-integrity.
|
|
10
|
+
* node .specsmd/aidlc/scripts/status-integrity.cjs
|
|
11
|
+
* node .specsmd/aidlc/scripts/status-integrity.cjs --fix
|
|
12
12
|
*
|
|
13
13
|
* Cross-platform: Works on Linux, macOS, Windows via Node.js
|
|
14
14
|
*/
|
|
@@ -577,15 +577,15 @@ const shouldFix = args.includes('--fix') || args.includes('-f');
|
|
|
577
577
|
|
|
578
578
|
if (args.includes('--help') || args.includes('-h')) {
|
|
579
579
|
console.log(`
|
|
580
|
-
Usage: node status-integrity.
|
|
580
|
+
Usage: node status-integrity.cjs [options]
|
|
581
581
|
|
|
582
582
|
Options:
|
|
583
583
|
--fix, -f Automatically fix status inconsistencies
|
|
584
584
|
--help, -h Show this help message
|
|
585
585
|
|
|
586
586
|
Examples:
|
|
587
|
-
node .specsmd/aidlc/scripts/status-integrity.
|
|
588
|
-
node .specsmd/aidlc/scripts/status-integrity.
|
|
587
|
+
node .specsmd/aidlc/scripts/status-integrity.cjs
|
|
588
|
+
node .specsmd/aidlc/scripts/status-integrity.cjs --fix
|
|
589
589
|
`);
|
|
590
590
|
process.exit(0);
|
|
591
591
|
}
|
|
@@ -194,7 +194,7 @@ If the bolt type specifies automatic validation criteria, follow those rules.
|
|
|
194
194
|
┌─────────────────────────────────────────────────────────────┐
|
|
195
195
|
│ FINAL STAGE DETECTED │
|
|
196
196
|
│ → Re-read Step 10 NOW │
|
|
197
|
-
│ → You MUST run: node .specsmd/aidlc/scripts/bolt-complete.
|
|
197
|
+
│ → You MUST run: node .specsmd/aidlc/scripts/bolt-complete.cjs │
|
|
198
198
|
│ → Do NOT manually edit story files │
|
|
199
199
|
└─────────────────────────────────────────────────────────────┘
|
|
200
200
|
```
|
|
@@ -235,7 +235,7 @@ stages_completed:
|
|
|
235
235
|
⛔ HARD GATE - SCRIPT EXECUTION REQUIRED
|
|
236
236
|
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
|
237
237
|
You CANNOT report bolt completion without:
|
|
238
|
-
1. Running the bolt-complete.
|
|
238
|
+
1. Running the bolt-complete.cjs script
|
|
239
239
|
2. Showing the script output to the user
|
|
240
240
|
|
|
241
241
|
If you skip this, the memory-bank becomes inconsistent.
|
|
@@ -245,7 +245,7 @@ Do NOT manually edit story files - the script handles everything.
|
|
|
245
245
|
**Run this command:**
|
|
246
246
|
|
|
247
247
|
```bash
|
|
248
|
-
node .specsmd/aidlc/scripts/bolt-complete.
|
|
248
|
+
node .specsmd/aidlc/scripts/bolt-complete.cjs {bolt-id}
|
|
249
249
|
```
|
|
250
250
|
|
|
251
251
|
**What this command does (deterministically):**
|