specweave 0.1.6 → 0.1.8

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.
@@ -6,17 +6,24 @@ This project uses **SpecWeave** - a specification-first AI development framework
6
6
 
7
7
  ---
8
8
 
9
- ## 🔷 SpecWeave Auto-Routing
9
+ ## 🔷 Using SpecWeave with Slash Commands
10
10
 
11
- **MANDATORY**: This project has SpecWeave installed (`.specweave/` directory exists).
11
+ **CRITICAL**: This project uses SpecWeave - **USE SLASH COMMANDS to activate the framework!**
12
12
 
13
- **Behavior**:
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
- **Rule**: When in doubt, route through SpecWeave.
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` | Create new feature | `/create-increment "user auth"` |
161
- | `/review-docs` | Review docs vs code | `/review-docs --increment=003` |
162
- | `/sync-github` | Sync to GitHub issues | `/sync-github` |
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` | Auto-detect SpecWeave | Any request |
227
- | `increment-planner` | Plan increments/features | Creating 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
- **Need help?**: Ask Claude to load the relevant guide, or ask about specific workflows.
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://specweave.dev
422
+ **SpecWeave Documentation**: https://spec-weave.com
383
423
 
384
424
  ---
385
425
 
@@ -1,176 +0,0 @@
1
- # /add-tasks - Add Tasks to Existing Increment
2
-
3
- **Command**: `/add-tasks <increment-id> <description> [options]`
4
-
5
- **Purpose**: Add new tasks to an existing increment during implementation
6
-
7
- **Framework**: Framework-agnostic (works with all tech stacks)
8
-
9
- ---
10
-
11
- ## Usage
12
-
13
- ```bash
14
- /add-tasks 001 "Fix error handling in context-loader"
15
- /add-tasks 001 --priority P2 "Add caching to skill-router"
16
- /add-tasks 001 "Multiple task lines..." --estimate "3 days"
17
- ```
18
-
19
- ## Arguments
20
-
21
- - `<increment-id>` (required): Increment number (e.g., `001`, `002`)
22
- - `<description>` (required): Task description
23
- - `--priority` (optional): P1/P2/P3 (default: P2)
24
- - `--estimate` (optional): Time estimate (default: detected from description)
25
-
26
- ---
27
-
28
- ## When to Use
29
-
30
- **Add as task** ✅ when:
31
- - Duration: Hours-Days
32
- - Components affected: 1 agent/skill
33
- - Discovered during implementation
34
- - Examples: Bug fixes, small enhancements, error handling
35
-
36
- **Create new increment** ❌ when:
37
- - Duration: Weeks+
38
- - Components affected: 2+ agents/skills
39
- - Major new feature
40
- - Use `/create-increment` instead
41
-
42
- ---
43
-
44
- ## Workflow
45
-
46
- ### Step 1: Validate Increment
47
-
48
- ```
49
- Validating increment 001-core-framework...
50
-
51
- → Status: in-progress ✅ (can add tasks)
52
- → Current tasks: 50
53
- → Completed: 44 (88%)
54
- ```
55
-
56
- **If increment not valid**:
57
- ```
58
- ❌ Cannot add tasks
59
-
60
- Reason: Increment 001 status is "closed"
61
-
62
- Options:
63
- A) Create new increment (recommended)
64
- B) Reopen 001 (if justified)
65
- ```
66
-
67
- ### Step 2: Auto-Increment Task ID
68
-
69
- ```
70
- → Scanning tasks.md for highest task ID...
71
- → Found: T050
72
- → New task ID: T051
73
- ```
74
-
75
- ### Step 3: Add to tasks.md
76
-
77
- ```markdown
78
- ## Additional Tasks (Added During Implementation)
79
-
80
- ### T051: Fix error handling in context-loader
81
- **Added**: 2025-10-26
82
- **Discovered**: During integration testing
83
- **Priority**: P1
84
- **Estimated**: 2 hours
85
- **Status**: [ ] Pending
86
-
87
- **Implementation**:
88
- - Check if manifest file exists before parsing
89
- - Return helpful error message with file path
90
- - Log warning to .specweave/increments/0001-core-framework/logs/errors.log
91
-
92
- **Acceptance Criteria**:
93
- - [ ] Handles missing manifest gracefully
94
- - [ ] Error message includes file path
95
- - [ ] No crash when manifest not found
96
- ```
97
-
98
- ### Step 4: Update Frontmatter
99
-
100
- Update `spec.md`:
101
-
102
- ```yaml
103
- ---
104
- updated: 2025-10-26 # ← Current date
105
- total_tasks: 51 # ← Incremented
106
- completed_tasks: 44 # ← Unchanged
107
- completion_rate: 86 # ← Recalculated (44/51)
108
- ---
109
- ```
110
-
111
- ### Step 5: Confirm
112
-
113
- ```
114
- ✅ Task added successfully
115
-
116
- Summary:
117
- → Task ID: T051
118
- → Description: Fix error handling in context-loader
119
- → Priority: P1
120
- → Increment: 001-core-framework
121
- → Total tasks: 51 (was 50)
122
- → Completion rate: 86% (was 88%)
123
-
124
- File: .specweave/increments/0001-core-framework/tasks.md
125
- ```
126
-
127
- ---
128
-
129
- ## Examples
130
-
131
- ### Example 1: Bug Fix
132
-
133
- ```bash
134
- /add-tasks 001 "Fix null pointer in skill-router when no skills installed"
135
-
136
- # Result:
137
- → Task T052: Fix null pointer in skill-router
138
- → Priority: P1 (critical bug)
139
- → Estimated: 1 hour
140
- ```
141
-
142
- ### Example 2: Enhancement
143
-
144
- ```bash
145
- /add-tasks 001 --priority P2 "Add caching to context-loader for better performance"
146
-
147
- # Result:
148
- → Task T053: Add caching to context-loader
149
- → Priority: P2 (enhancement)
150
- → Estimated: 1 day
151
- ```
152
-
153
- ### Example 3: Multiple Tasks
154
-
155
- ```bash
156
- /add-tasks 001 "Add error handling, logging, and validation to hetzner-provisioner"
157
-
158
- # Result:
159
- → Task T054: Add error handling to hetzner-provisioner
160
- → Task T055: Add logging to hetzner-provisioner
161
- → Task T056: Add validation to hetzner-provisioner
162
- → Priority: P2 (improvements)
163
- ```
164
-
165
- ---
166
-
167
- ## Related Documentation
168
-
169
- - [CLAUDE.md](../../CLAUDE.md#adding-tasks-to-current-increment) - Task addition guide
170
- - [INCREMENT-LIFECYCLE-DESIGN.md](../../.specweave/increments/0001-core-framework/reports/INCREMENT-LIFECYCLE-DESIGN.md) - Lifecycle design
171
-
172
- ---
173
-
174
- **Command Type**: Task management
175
- **Framework Support**: All
176
- **Impact**: Adds tasks to existing increment, updates completion rate
@@ -1,114 +0,0 @@
1
- ---
2
- description: 🔥 Shorthand for /add-tasks - Add tasks to increment (Alias)
3
- ---
4
-
5
- # Add Tasks (Short Alias)
6
-
7
- **⚡ Quick Alias**: This is a shorthand command for `/add-tasks`.
8
-
9
- Use this when you want to quickly add tasks to an increment without typing the full command name.
10
-
11
- ---
12
-
13
- ## Full Command
14
-
15
- For complete documentation, see `/add-tasks`.
16
-
17
- This alias provides the exact same functionality as the full command.
18
-
19
- ---
20
-
21
- ## Usage
22
-
23
- ```bash
24
- /at <increment-id> <task-description>
25
- ```
26
-
27
- **Examples**:
28
- ```bash
29
- /at 0001 "Implement login endpoint"
30
- /at 0001 "Add password validation"
31
- /at 0001 "Write E2E tests for auth flow"
32
- ```
33
-
34
- ---
35
-
36
- ## What This Does
37
-
38
- 1. **Analyzes task** against spec/plan
39
- 2. **Determines priority** (P1, P2, P3)
40
- 3. **Estimates effort** (based on complexity)
41
- 4. **Identifies dependencies** (from existing tasks)
42
- 5. **Adds to tasks.md** with proper formatting
43
- 6. **Updates progress** percentage
44
-
45
- ---
46
-
47
- ## Task Format
48
-
49
- Tasks are added with:
50
- - ✅ **Task ID** (auto-numbered: T001, T002, ...)
51
- - ✅ **Description** (clear, actionable)
52
- - ✅ **Priority** (P1/P2/P3)
53
- - ✅ **Estimated time** (based on analysis)
54
- - ✅ **Dependencies** (if any)
55
- - ✅ **Status** (Pending by default)
56
-
57
- **Example Output**:
58
- ```markdown
59
- ### T012: Implement login endpoint
60
- **Priority**: P1
61
- **Estimated**: 2 hours
62
- **Depends on**: T008
63
- **Status**: [ ] Pending
64
-
65
- **Implementation**:
66
- - Create POST /api/auth/login endpoint
67
- - Validate email and password
68
- - Return JWT token on success
69
- - Handle rate limiting
70
- ```
71
-
72
- ---
73
-
74
- ## Bulk Add
75
-
76
- You can add multiple tasks by calling the command multiple times or providing a list:
77
-
78
- ```bash
79
- /at 0001 "Task 1"
80
- /at 0001 "Task 2"
81
- /at 0001 "Task 3"
82
- ```
83
-
84
- ---
85
-
86
- ## When to Add Tasks
87
-
88
- **During planning**:
89
- - Breaking down large features
90
- - After spec/plan review
91
-
92
- **During implementation**:
93
- - Discovered new requirements
94
- - Technical debt identified
95
- - Bug fixes needed
96
-
97
- **After review**:
98
- - Feedback from code review
99
- - QA findings
100
- - Security audit results
101
-
102
- ---
103
-
104
- ## Other Useful Aliases
105
-
106
- - `/ci` - Create increment (shorthand for `/create-increment`)
107
- - `/si` - Start increment (shorthand for `/start-increment`)
108
- - `/vi` - Validate increment (shorthand for `/validate-increment`)
109
- - `/done` - Close increment (shorthand for `/close-increment`)
110
- - `/ls` - List increments (shorthand for `/list-increments`)
111
-
112
- ---
113
-
114
- **💡 Tip**: Add tasks as you discover them - don't wait until sprint planning!
@@ -1,63 +0,0 @@
1
- ---
2
- description: 🔥 Shorthand for /create-increment - Create new increment (Alias)
3
- ---
4
-
5
- # Create Increment (Short Alias)
6
-
7
- **⚡ Quick Alias**: This is a shorthand command for `/create-increment`.
8
-
9
- Use this when you want to quickly create a new SpecWeave increment without typing the full command name.
10
-
11
- ---
12
-
13
- ## Full Command
14
-
15
- For complete documentation, see `/create-increment`.
16
-
17
- This alias provides the exact same functionality as the full command.
18
-
19
- ---
20
-
21
- ## Usage
22
-
23
- ```bash
24
- /ci "Feature name"
25
- ```
26
-
27
- **Example**:
28
- ```bash
29
- /ci "User authentication"
30
- /ci "Payment processing"
31
- /ci "Admin dashboard"
32
- ```
33
-
34
- ---
35
-
36
- ## What This Does
37
-
38
- 1. **Auto-numbers** the increment (e.g., 0001, 0002, 0003...)
39
- 2. **Creates folder** at `.specweave/increments/XXXX-feature-name/`
40
- 3. **Generates files**:
41
- - `spec.md` - WHAT & WHY (user stories, acceptance criteria)
42
- - `plan.md` - HOW (architecture, implementation strategy)
43
- - `tasks.md` - Implementation checklist
44
- - `tests.md` - Test strategy and coverage matrix
45
- - `context-manifest.yaml` - Context loading configuration
46
- 4. **Invokes agents**:
47
- - PM agent (requirements analysis)
48
- - Architect agent (technical design)
49
- - QA Lead agent (test strategy)
50
-
51
- ---
52
-
53
- ## Other Useful Aliases
54
-
55
- - `/si` - Start increment (shorthand for `/start-increment`)
56
- - `/vi` - Validate increment (shorthand for `/validate-increment`)
57
- - `/done` - Close increment (shorthand for `/close-increment`)
58
- - `/ls` - List increments (shorthand for `/list-increments`)
59
- - `/at` - Add tasks (shorthand for `/add-tasks`)
60
-
61
- ---
62
-
63
- **💡 Tip**: Use `/ci` for speed, `/create-increment` for clarity in scripts.