specsmd 0.0.15 → 0.0.17
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 +92 -21
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -6,6 +6,7 @@ specsmd implements the [AI-Driven Development Lifecycle (AI-DLC)](https://aws.am
|
|
|
6
6
|
|
|
7
7
|
[](https://www.npmjs.com/package/specsmd)
|
|
8
8
|
[](https://opensource.org/licenses/MIT)
|
|
9
|
+
[](https://specs.md)
|
|
9
10
|
|
|
10
11
|
<p align="center">
|
|
11
12
|
<img src="assets/demo.gif" alt="specs.md demo" width="800" />
|
|
@@ -15,10 +16,15 @@ specsmd implements the [AI-Driven Development Lifecycle (AI-DLC)](https://aws.am
|
|
|
15
16
|
|
|
16
17
|
## Quick Start
|
|
17
18
|
|
|
19
|
+
### Prerequisites
|
|
20
|
+
|
|
21
|
+
- Node.js 18 or higher
|
|
22
|
+
- An AI coding tool (Claude Code, Cursor, GitHub Copilot, or Google Antigravity)
|
|
23
|
+
|
|
18
24
|
### Installation
|
|
19
25
|
|
|
20
26
|
> [!NOTE]
|
|
21
|
-
> Do not use npm if you want to always get the latest version. Use the npx command below.
|
|
27
|
+
> Do not use npm if you want to always get the latest version. Use the npx command below.
|
|
22
28
|
|
|
23
29
|
```bash
|
|
24
30
|
npx specsmd@latest install
|
|
@@ -29,8 +35,18 @@ The installer detects your AI coding tools (Claude Code, Cursor, GitHub Copilot)
|
|
|
29
35
|
- Memory bank structure for context persistence
|
|
30
36
|
- Slash commands for easy agent invocation
|
|
31
37
|
|
|
38
|
+
### Verify Installation
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
# Check the manifest
|
|
42
|
+
cat .specsmd/manifest.yaml
|
|
43
|
+
|
|
44
|
+
# List installed agents
|
|
45
|
+
ls .specsmd/aidlc/agents/
|
|
46
|
+
```
|
|
47
|
+
|
|
32
48
|
### Initialize Your Project
|
|
33
|
-
Open your AI
|
|
49
|
+
Open your AI Assisted Tool (Claude Code, Cursor, GitHub Copilot) and run the following commands:
|
|
34
50
|
|
|
35
51
|
```bash
|
|
36
52
|
# Start the Master Agent
|
|
@@ -108,20 +124,18 @@ AI-DLC is a reimagined software development methodology where **AI drives the co
|
|
|
108
124
|
|
|
109
125
|
specsmd provides four specialized agents that guide you through the entire development lifecycle:
|
|
110
126
|
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
Define units Build & test Verify & scale
|
|
124
|
-
Plan stories Validate stages
|
|
127
|
+
```mermaid
|
|
128
|
+
flowchart TB
|
|
129
|
+
MA[Master Agent<br/>Orchestrates & Navigates] --> IA[Inception Agent]
|
|
130
|
+
MA --> CA[Construction Agent]
|
|
131
|
+
MA --> OA[Operations Agent]
|
|
132
|
+
|
|
133
|
+
IA --> CA --> OA
|
|
134
|
+
|
|
135
|
+
style MA fill:#8B5CF6,stroke:#7C3AED,color:#fff
|
|
136
|
+
style IA fill:#818CF8,stroke:#6366F1,color:#fff
|
|
137
|
+
style CA fill:#34D399,stroke:#10B981,color:#fff
|
|
138
|
+
style OA fill:#FBBF24,stroke:#F59E0B,color:#fff
|
|
125
139
|
```
|
|
126
140
|
|
|
127
141
|
### The Three Phases
|
|
@@ -160,7 +174,8 @@ Project decisions that inform AI code generation. Standards ensure consistency a
|
|
|
160
174
|
|
|
161
175
|
---
|
|
162
176
|
|
|
163
|
-
|
|
177
|
+
<details>
|
|
178
|
+
<summary><h2>Project Structure</h2></summary>
|
|
164
179
|
|
|
165
180
|
After installation:
|
|
166
181
|
|
|
@@ -188,9 +203,10 @@ memory-bank/ # Created after project-init
|
|
|
188
203
|
└── operations/ # Deployment context
|
|
189
204
|
```
|
|
190
205
|
|
|
191
|
-
|
|
206
|
+
</details>
|
|
192
207
|
|
|
193
|
-
|
|
208
|
+
<details>
|
|
209
|
+
<summary><h2>Agent Commands</h2></summary>
|
|
194
210
|
|
|
195
211
|
### Master Agent
|
|
196
212
|
```bash
|
|
@@ -241,6 +257,8 @@ memory-bank/ # Created after project-init
|
|
|
241
257
|
| `verify` | Verify deployment |
|
|
242
258
|
| `monitor` | Set up monitoring |
|
|
243
259
|
|
|
260
|
+
</details>
|
|
261
|
+
|
|
244
262
|
---
|
|
245
263
|
|
|
246
264
|
## Why specsmd?
|
|
@@ -273,7 +291,56 @@ Memory bank ensures AI agents have full project context across sessions. All art
|
|
|
273
291
|
|
|
274
292
|
---
|
|
275
293
|
|
|
276
|
-
##
|
|
294
|
+
## Troubleshooting
|
|
295
|
+
|
|
296
|
+
<details>
|
|
297
|
+
<summary><strong>Agent commands not recognized</strong></summary>
|
|
298
|
+
|
|
299
|
+
Ensure specs.md is installed correctly:
|
|
300
|
+
```bash
|
|
301
|
+
ls .specsmd/aidlc/agents/
|
|
302
|
+
```
|
|
303
|
+
|
|
304
|
+
If the directory is empty or missing, reinstall:
|
|
305
|
+
```bash
|
|
306
|
+
npx specsmd@latest install
|
|
307
|
+
```
|
|
308
|
+
</details>
|
|
309
|
+
|
|
310
|
+
<details>
|
|
311
|
+
<summary><strong>Memory Bank artifacts missing</strong></summary>
|
|
312
|
+
|
|
313
|
+
Check if the memory-bank directory exists:
|
|
314
|
+
```bash
|
|
315
|
+
ls memory-bank/
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
If missing, run project initialization:
|
|
319
|
+
```
|
|
320
|
+
/specsmd-master-agent
|
|
321
|
+
> project-init
|
|
322
|
+
```
|
|
323
|
+
</details>
|
|
324
|
+
|
|
325
|
+
<details>
|
|
326
|
+
<summary><strong>Standards not being followed in generated code</strong></summary>
|
|
327
|
+
|
|
328
|
+
Ensure standards are defined in `memory-bank/standards/`:
|
|
329
|
+
- `tech-stack.md`
|
|
330
|
+
- `coding-standards.md`
|
|
331
|
+
- `architecture.md`
|
|
332
|
+
|
|
333
|
+
If missing or incomplete, use the Master Agent to define them:
|
|
334
|
+
```
|
|
335
|
+
/specsmd-master-agent
|
|
336
|
+
> project-init
|
|
337
|
+
```
|
|
338
|
+
</details>
|
|
339
|
+
|
|
340
|
+
---
|
|
341
|
+
|
|
342
|
+
<details>
|
|
343
|
+
<summary><h2>FAQ</h2></summary>
|
|
277
344
|
|
|
278
345
|
**Q: Agents don't seem to remember previous context?**
|
|
279
346
|
Each agent invocation starts fresh. Agents read context from the Memory Bank at startup. Ensure artifacts are saved after each step.
|
|
@@ -287,12 +354,16 @@ AI-DLC is designed as a reimagination, not a retrofit. However, familiar concept
|
|
|
287
354
|
**Q: What project types is this suited for?**
|
|
288
355
|
specsmd is designed for building complex systems that demand architectural complexity, trade-off management, and scalability. Simpler systems may be better suited for low-code/no-code approaches.
|
|
289
356
|
|
|
357
|
+
</details>
|
|
358
|
+
|
|
290
359
|
---
|
|
291
360
|
|
|
292
361
|
## Resources
|
|
293
362
|
|
|
363
|
+
- [Documentation](https://specs.md)
|
|
294
364
|
- [AI-DLC Specification (AWS)](https://aws.amazon.com/blogs/devops/ai-driven-development-life-cycle/)
|
|
295
|
-
- [
|
|
365
|
+
- [npm Package](https://www.npmjs.com/package/specsmd)
|
|
366
|
+
- [GitHub Issues](https://github.com/fabriqaai/specsmd/issues)
|
|
296
367
|
|
|
297
368
|
|
|
298
369
|
---
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "specsmd",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.17",
|
|
4
4
|
"description": "Multi-agent orchestration system for AI-native software development. Delivers AI-DLC, Agile, and custom SDLC flows as markdown-based agent systems.",
|
|
5
5
|
"main": "lib/installer.js",
|
|
6
6
|
"bin": {
|