specweave 0.1.5 → 0.1.7
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 +189 -255
- package/SPECWEAVE.md +95 -52
- package/package.json +1 -1
- package/src/commands/README.md +173 -0
- package/src/commands/at.md +114 -0
- package/src/commands/done.md +103 -0
- package/src/commands/init.md +123 -0
- package/src/commands/ls.md +100 -0
- package/src/commands/pi.md +65 -0
- package/src/commands/si.md +83 -0
- package/src/commands/vi.md +89 -0
- package/src/skills/specweave-detector/SKILL.md +270 -443
- package/src/templates/CLAUDE.md.template +59 -19
|
@@ -6,17 +6,24 @@ This project uses **SpecWeave** - a specification-first AI development framework
|
|
|
6
6
|
|
|
7
7
|
---
|
|
8
8
|
|
|
9
|
-
## 🔷 SpecWeave
|
|
9
|
+
## 🔷 Using SpecWeave with Slash Commands
|
|
10
10
|
|
|
11
|
-
**
|
|
11
|
+
**CRITICAL**: This project uses SpecWeave - **USE SLASH COMMANDS to activate the framework!**
|
|
12
12
|
|
|
13
|
-
**
|
|
14
|
-
1. ✅ All development requests route through `specweave-detector` skill
|
|
15
|
-
2. ✅ Agents activate automatically based on task (PM, Architect, DevOps, etc.)
|
|
16
|
-
3. ✅ Context loaded selectively via manifests (70%+ token reduction)
|
|
17
|
-
4. ✅ Tech stack detected automatically
|
|
13
|
+
SpecWeave uses **EXPLICIT SLASH COMMANDS** - no auto-activation, no proactive detection.
|
|
18
14
|
|
|
19
|
-
**
|
|
15
|
+
**How to use**:
|
|
16
|
+
1. ✅ **Use `/pi "feature description"`** to create a new increment (Plan Product Increment)
|
|
17
|
+
2. ✅ **Use `/si 0001`** to start working on an increment
|
|
18
|
+
3. ✅ **Use `/done 0001`** to close an increment
|
|
19
|
+
4. ✅ **Regular conversation** for implementation after planning
|
|
20
|
+
|
|
21
|
+
**Why slash commands?**
|
|
22
|
+
- Auto-activation doesn't work reliably in Claude Code
|
|
23
|
+
- Explicit commands ensure SpecWeave ALWAYS activates when you want it
|
|
24
|
+
- Short aliases (`/pi`, `/si`, `/done`) save keystrokes
|
|
25
|
+
|
|
26
|
+
**See**: Full command list below in "Quick Commands" section
|
|
20
27
|
|
|
21
28
|
---
|
|
22
29
|
|
|
@@ -153,13 +160,23 @@ project-root/
|
|
|
153
160
|
|
|
154
161
|
---
|
|
155
162
|
|
|
156
|
-
## Quick Commands
|
|
163
|
+
## Quick Commands (SLASH COMMANDS - Use These!)
|
|
164
|
+
|
|
165
|
+
**IMPORTANT**: SpecWeave uses **EXPLICIT SLASH COMMANDS**. Type these commands to activate the framework.
|
|
157
166
|
|
|
158
|
-
| Command | Purpose | Example |
|
|
159
|
-
|
|
160
|
-
| `/create-increment` |
|
|
161
|
-
| `/
|
|
162
|
-
| `/
|
|
167
|
+
| Command | Alias | Purpose | Example |
|
|
168
|
+
|---------|-------|---------|---------|
|
|
169
|
+
| `/create-increment` | `/pi` | **Plan Product Increment** (create new feature) | `/pi "user auth"` |
|
|
170
|
+
| `/start-increment` | `/si` | Start working on increment | `/si 0001` |
|
|
171
|
+
| `/add-tasks` | `/at` | Add tasks to increment | `/at 0001 "add tests"` |
|
|
172
|
+
| `/validate-increment` | `/vi` | Validate increment quality | `/vi 0001 --quality` |
|
|
173
|
+
| `/close-increment` | `/done` | Close increment | `/done 0001` |
|
|
174
|
+
| `/list-increments` | `/ls` | List all increments | `/ls` |
|
|
175
|
+
| `/review-docs` | - | Review docs vs code | `/review-docs --increment=003` |
|
|
176
|
+
| `/sync-github` | - | Sync to GitHub issues | `/sync-github` |
|
|
177
|
+
|
|
178
|
+
**💡 Pro Tip**: Use short aliases (`/pi`, `/si`, `/done`) for speed!
|
|
179
|
+
- **PI** = Product Increment (standard Agile terminology)
|
|
163
180
|
|
|
164
181
|
**All commands adapt to your tech stack automatically**
|
|
165
182
|
|
|
@@ -167,9 +184,15 @@ project-root/
|
|
|
167
184
|
|
|
168
185
|
## Working with Increments
|
|
169
186
|
|
|
170
|
-
### Create New Feature
|
|
187
|
+
### Create New Feature (ALWAYS use slash command!)
|
|
188
|
+
|
|
189
|
+
**CRITICAL**: Use `/pi` (or `/create-increment`) to create new features:
|
|
171
190
|
|
|
172
191
|
```bash
|
|
192
|
+
# Short form (recommended)
|
|
193
|
+
/pi "feature description"
|
|
194
|
+
|
|
195
|
+
# Full form
|
|
173
196
|
/create-increment "feature description"
|
|
174
197
|
```
|
|
175
198
|
|
|
@@ -181,6 +204,10 @@ project-root/
|
|
|
181
204
|
- tests.md (Test strategy - QA Lead agent)
|
|
182
205
|
- context-manifest.yaml (Selective loading)
|
|
183
206
|
|
|
207
|
+
**Workflow**:
|
|
208
|
+
1. Use `/pi "feature"` to plan → SpecWeave creates specs
|
|
209
|
+
2. Then regular conversation to implement → Claude implements code
|
|
210
|
+
|
|
184
211
|
### Status Progression
|
|
185
212
|
|
|
186
213
|
```
|
|
@@ -223,8 +250,8 @@ backlog → planned → in-progress → completed → closed
|
|
|
223
250
|
|
|
224
251
|
| Skill | Purpose | Activates When |
|
|
225
252
|
|-------|---------|----------------|
|
|
226
|
-
| `specweave-detector` |
|
|
227
|
-
| `increment-planner` | Plan increments/features |
|
|
253
|
+
| `specweave-detector` | Slash command documentation | User asks about SpecWeave commands |
|
|
254
|
+
| `increment-planner` | Plan increments/features | `/pi` or `/create-increment` command |
|
|
228
255
|
| `context-loader` | Load context selectively | Working on increments |
|
|
229
256
|
| `skill-router` | Route to appropriate skill | Ambiguous requests |
|
|
230
257
|
|
|
@@ -372,14 +399,27 @@ max_context_tokens: 10000
|
|
|
372
399
|
|
|
373
400
|
## Quick Start
|
|
374
401
|
|
|
402
|
+
**CRITICAL**: SpecWeave uses **EXPLICIT SLASH COMMANDS** - type `/pi` to activate!
|
|
403
|
+
|
|
375
404
|
**Create your first feature**:
|
|
376
405
|
```bash
|
|
406
|
+
# Use short alias (recommended)
|
|
407
|
+
/pi "your feature description"
|
|
408
|
+
|
|
409
|
+
# Or full command
|
|
377
410
|
/create-increment "your feature description"
|
|
378
411
|
```
|
|
379
412
|
|
|
380
|
-
**
|
|
413
|
+
**Typical Workflow**:
|
|
414
|
+
1. `/pi "feature"` → SpecWeave creates specs (spec.md, plan.md, tasks.md)
|
|
415
|
+
2. Regular conversation → Claude implements the code
|
|
416
|
+
3. `/done 0001` → Close increment when complete
|
|
417
|
+
|
|
418
|
+
**Remember**: Type `/pi` first, THEN implement! Otherwise you lose all SpecWeave benefits.
|
|
419
|
+
|
|
420
|
+
**Need help?**: Type `/pi` to see examples, or ask about specific workflows.
|
|
381
421
|
|
|
382
|
-
**SpecWeave Documentation**: https://
|
|
422
|
+
**SpecWeave Documentation**: https://spec-weave.com
|
|
383
423
|
|
|
384
424
|
---
|
|
385
425
|
|