clavix 5.6.5 → 5.6.6
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 +1 -1
- package/dist/templates/slash-commands/_canonical/archive.md +34 -0
- package/dist/templates/slash-commands/_canonical/plan.md +15 -0
- package/dist/templates/slash-commands/_canonical/refine.md +43 -7
- package/dist/templates/slash-commands/_canonical/start.md +24 -0
- package/dist/templates/slash-commands/_canonical/summarize.md +4 -1
- package/dist/templates/slash-commands/_components/MANIFEST.md +2 -1
- package/dist/templates/slash-commands/_components/references/quality-dimensions.md +21 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Clavix
|
|
2
2
|
|
|
3
|
-
> Agentic-first prompt workflows. Markdown templates that teach AI agents how to optimize prompts, create PRDs, and manage implementation. Works with Claude Code, Cursor, Windsurf, and
|
|
3
|
+
> Agentic-first prompt workflows. Markdown templates that teach AI agents how to optimize prompts, create PRDs, and manage implementation. Works with Claude Code, Cursor, Windsurf, and 20 AI coding tools.
|
|
4
4
|
|
|
5
5
|
## Quick Links
|
|
6
6
|
|
|
@@ -285,6 +285,39 @@ Result: Project permanently deleted
|
|
|
285
285
|
- `/clavix:plan` - Review task completion status
|
|
286
286
|
- `/clavix:prd` - Start new project after archiving old one
|
|
287
287
|
|
|
288
|
+
## Archive Size Management
|
|
289
|
+
|
|
290
|
+
**Proactive maintenance to prevent archive bloat:**
|
|
291
|
+
|
|
292
|
+
**When to clean up the archive:**
|
|
293
|
+
- Archive exceeds 50 projects (or 100MB)
|
|
294
|
+
- Projects older than 12 months that haven't been referenced
|
|
295
|
+
- Duplicate or superseded projects
|
|
296
|
+
- Failed experiments with no learning value
|
|
297
|
+
|
|
298
|
+
**Size check (run periodically):**
|
|
299
|
+
```bash
|
|
300
|
+
# Count archived projects
|
|
301
|
+
ls .clavix/outputs/archive/ | wc -l
|
|
302
|
+
|
|
303
|
+
# Check total archive size
|
|
304
|
+
du -sh .clavix/outputs/archive/
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
**Cleanup workflow:**
|
|
308
|
+
1. List all archived projects with dates: `ls -lt .clavix/outputs/archive/`
|
|
309
|
+
2. Identify candidates for deletion (failed experiments, duplicates, ancient projects)
|
|
310
|
+
3. For each candidate, confirm zero future value
|
|
311
|
+
4. Delete only with explicit confirmation
|
|
312
|
+
|
|
313
|
+
**Archive retention recommendations:**
|
|
314
|
+
| Project Type | Keep For | Then |
|
|
315
|
+
|--------------|----------|------|
|
|
316
|
+
| Completed features | Indefinitely | Archive forever (reference value) |
|
|
317
|
+
| Failed experiments | 30 days | Delete if no learning value |
|
|
318
|
+
| Superseded versions | 90 days | Delete if newer version exists |
|
|
319
|
+
| Test/demo projects | 7 days | Delete unless documenting patterns |
|
|
320
|
+
|
|
288
321
|
## Tips
|
|
289
322
|
|
|
290
323
|
- Archive keeps your active projects list clean and focused
|
|
@@ -292,6 +325,7 @@ Result: Project permanently deleted
|
|
|
292
325
|
- Archive is searchable - you can still `grep` or find files in archive/
|
|
293
326
|
- Regular archiving keeps `.clavix/outputs/` organized
|
|
294
327
|
- Check `.clavix/outputs/archive/` to see what's been archived
|
|
328
|
+
- Review archive size quarterly to avoid unbounded growth
|
|
295
329
|
|
|
296
330
|
## Troubleshooting
|
|
297
331
|
|
|
@@ -134,6 +134,16 @@ If you have the full PRD content in memory and want to generate tasks directly:
|
|
|
134
134
|
- Each phase should be independently deployable when possible
|
|
135
135
|
- Critical path first (must-haves before nice-to-haves)
|
|
136
136
|
|
|
137
|
+
**Task Dependency Management:**
|
|
138
|
+
- **Explicit ordering**: Tasks within a phase should be ordered by execution sequence
|
|
139
|
+
- **Dependency markers**: Use `(depends: task-id)` for explicit dependencies
|
|
140
|
+
- **Common dependency patterns**:
|
|
141
|
+
- Database schema → Models → API endpoints → UI components
|
|
142
|
+
- Authentication → Protected routes → User-specific features
|
|
143
|
+
- Core utilities → Features that use them → Integration tests
|
|
144
|
+
- **Anti-pattern**: Avoid circular dependencies (A depends on B, B depends on A)
|
|
145
|
+
- **Parallel tasks**: If two tasks have no dependencies, they can be worked on simultaneously
|
|
146
|
+
|
|
137
147
|
4. **Review and customize generated tasks**:
|
|
138
148
|
- The command will generate `tasks.md` in the PRD folder
|
|
139
149
|
- Tasks are organized into logical phases with quality principles
|
|
@@ -244,11 +254,16 @@ The generated `tasks.md` will look like:
|
|
|
244
254
|
|
|
245
255
|
**Basic**: `- [ ] {Clear, actionable description}`
|
|
246
256
|
**With reference**: `- [ ] {Description} (ref: {PRD Section Name})`
|
|
257
|
+
**With dependency**: `- [ ] {Description} (depends: {task-id})`
|
|
258
|
+
**Combined**: `- [ ] {Description} (ref: {Section}) (depends: {task-id})`
|
|
247
259
|
|
|
248
260
|
**Example**:
|
|
249
261
|
```markdown
|
|
250
262
|
- [ ] Create user registration API endpoint (ref: User Management)
|
|
251
263
|
Task ID: phase-1-authentication-1
|
|
264
|
+
|
|
265
|
+
- [ ] Add JWT token validation middleware (depends: phase-1-authentication-1)
|
|
266
|
+
Task ID: phase-1-authentication-2
|
|
252
267
|
```
|
|
253
268
|
|
|
254
269
|
### Task ID Placement
|
|
@@ -328,11 +328,13 @@ Present the current prompt to the user:
|
|
|
328
328
|
|
|
329
329
|
---
|
|
330
330
|
|
|
331
|
-
**Quality Assessment:**
|
|
331
|
+
**Quality Assessment (6 dimensions):**
|
|
332
332
|
- Clarity: [Score]
|
|
333
|
-
-
|
|
333
|
+
- Efficiency: [Score]
|
|
334
|
+
- Structure: [Score]
|
|
334
335
|
- Completeness: [Score]
|
|
335
336
|
- Actionability: [Score]
|
|
337
|
+
- Specificity: [Score]
|
|
336
338
|
|
|
337
339
|
**What would you like to change?**
|
|
338
340
|
1. Clarify the objective
|
|
@@ -351,13 +353,13 @@ Enter conversational mode:
|
|
|
351
353
|
|
|
352
354
|
### Step 6b: Run Quality Assessment
|
|
353
355
|
|
|
354
|
-
After refinement, re-assess using the
|
|
356
|
+
After refinement, re-assess using the standard 6 quality dimensions:
|
|
355
357
|
- Clarity
|
|
356
|
-
-
|
|
357
|
-
- Context
|
|
358
|
-
- Constraints
|
|
359
|
-
- Actionability
|
|
358
|
+
- Efficiency
|
|
360
359
|
- Structure
|
|
360
|
+
- Completeness
|
|
361
|
+
- Actionability
|
|
362
|
+
- Specificity
|
|
361
363
|
|
|
362
364
|
### Step 7b: Save Refined Prompt
|
|
363
365
|
|
|
@@ -559,6 +561,9 @@ I'll update the PRD and add this to the refinement history. Confirm?
|
|
|
559
561
|
### CLI Reference
|
|
560
562
|
{{INCLUDE:agent-protocols/cli-reference.md}}
|
|
561
563
|
|
|
564
|
+
### Quality Dimensions (for Prompt Refinement)
|
|
565
|
+
{{INCLUDE:references/quality-dimensions.md}}
|
|
566
|
+
|
|
562
567
|
### Workflow State Detection
|
|
563
568
|
{{INCLUDE:agent-protocols/state-awareness.md}}
|
|
564
569
|
|
|
@@ -610,3 +615,34 @@ I'll update the PRD and add this to the refinement history. Confirm?
|
|
|
610
615
|
- Run `/clavix:plan` to regenerate tasks
|
|
611
616
|
- Or manually update tasks.md
|
|
612
617
|
- Previous progress markers may need adjustment
|
|
618
|
+
|
|
619
|
+
### Issue: User wants to refine multiple topics at once
|
|
620
|
+
**Cause**: PRD covers several distinct features and user wants to update multiple areas
|
|
621
|
+
**Solution**:
|
|
622
|
+
1. **Sequential approach (recommended)**:
|
|
623
|
+
- Focus on one topic/feature at a time
|
|
624
|
+
- Complete refinement for Topic A
|
|
625
|
+
- Then start new refinement session for Topic B
|
|
626
|
+
- Clearer change tracking per topic
|
|
627
|
+
|
|
628
|
+
2. **Batched approach (if user insists)**:
|
|
629
|
+
- Discuss all changes upfront
|
|
630
|
+
- Group changes by category: [ADDED], [MODIFIED], [REMOVED]
|
|
631
|
+
- Apply all changes in one session
|
|
632
|
+
- In Refinement History, list changes per topic area:
|
|
633
|
+
```
|
|
634
|
+
### [Date] - Multi-Topic Refinement
|
|
635
|
+
**Authentication changes:**
|
|
636
|
+
- [ADDED] 2FA support
|
|
637
|
+
- [MODIFIED] Password requirements
|
|
638
|
+
|
|
639
|
+
**Dashboard changes:**
|
|
640
|
+
- [ADDED] Dark mode toggle
|
|
641
|
+
- [REMOVED] Deprecated widgets
|
|
642
|
+
```
|
|
643
|
+
|
|
644
|
+
3. **When to recommend splitting**:
|
|
645
|
+
- Changes span 4+ distinct features
|
|
646
|
+
- Changes affect different system components
|
|
647
|
+
- Risk of losing track of individual changes
|
|
648
|
+
- User seems overwhelmed by scope
|
|
@@ -141,6 +141,30 @@ Implementation: BLOCKED - I will ask questions and explore needs, not implement
|
|
|
141
141
|
|
|
142
142
|
**CHECKPOINT:** Complexity threshold reached - suggesting summarization
|
|
143
143
|
|
|
144
|
+
**Scope Creep Detection and Handling:**
|
|
145
|
+
Watch for these scope creep signals:
|
|
146
|
+
- Feature requests keep expanding ("also, it should...")
|
|
147
|
+
- Requirements contradict earlier decisions
|
|
148
|
+
- Must-haves grow without prioritization
|
|
149
|
+
- "Nice-to-have" features being treated as core requirements
|
|
150
|
+
- Scope drift from original problem statement
|
|
151
|
+
|
|
152
|
+
**When scope creep detected**, intervene with:
|
|
153
|
+
"I notice we've expanded from [original scope] to include [new additions]. Let's pause and prioritize:
|
|
154
|
+
- **Core (MVP)**: [list essential features] - these solve the original problem
|
|
155
|
+
- **Extended**: [list additions] - valuable but not essential
|
|
156
|
+
- **Future**: [list nice-to-haves] - consider for later iterations
|
|
157
|
+
|
|
158
|
+
Which of the extended features are truly necessary for the first version?"
|
|
159
|
+
|
|
160
|
+
**Scope management strategies:**
|
|
161
|
+
- Anchor to original problem statement frequently
|
|
162
|
+
- Ask "Does this feature solve the core problem?"
|
|
163
|
+
- Suggest versioning: "v1 with X, v2 adds Y"
|
|
164
|
+
- Track must-have vs nice-to-have explicitly
|
|
165
|
+
|
|
166
|
+
**CHECKPOINT:** Scope creep detected - helping user prioritize
|
|
167
|
+
|
|
144
168
|
4. Be conversational and supportive:
|
|
145
169
|
- Don't interrogate - have a natural discussion
|
|
146
170
|
- Build on their ideas
|
|
@@ -375,13 +375,16 @@ Implementation: BLOCKED - I will extract requirements, not implement them
|
|
|
375
375
|
|
|
376
376
|
## Quality Enhancement
|
|
377
377
|
|
|
378
|
-
**What gets optimized:**
|
|
378
|
+
**What gets optimized (5 dimensions):**
|
|
379
379
|
- **Clarity**: Remove ambiguity from extracted requirements
|
|
380
380
|
- **Efficiency**: Remove verbosity and conversational fluff
|
|
381
381
|
- **Structure**: Ensure logical flow (context → requirements → constraints → output)
|
|
382
382
|
- **Completeness**: Add missing specifications, formats, success criteria
|
|
383
383
|
- **Actionability**: Make requirements specific and executable
|
|
384
384
|
|
|
385
|
+
**Why Specificity is excluded:**
|
|
386
|
+
The `/clavix:summarize` command extracts requirements from exploratory conversations. Users in discovery mode often haven't determined concrete specifics yet (exact versions, file paths, numeric thresholds). Penalizing for missing specifics would unfairly score valid exploratory outputs. If specific details are needed, use `/clavix:improve` on the extracted prompt or proceed to `/clavix:prd` for full specification.
|
|
387
|
+
|
|
385
388
|
**Output files:**
|
|
386
389
|
- `original-prompt.md` - Raw extraction from conversation
|
|
387
390
|
- `optimized-prompt.md` - Enhanced version (recommended for AI agents)
|
|
@@ -22,7 +22,7 @@ Static reference documentation for AI agents.
|
|
|
22
22
|
|
|
23
23
|
| Component | Purpose | Used By |
|
|
24
24
|
|-----------|---------|---------|
|
|
25
|
-
| `quality-dimensions.md` |
|
|
25
|
+
| `quality-dimensions.md` | Quality scoring dimensions (6 dimensions), workflow-specific usage, and why summarize excludes Specificity | improve, prd, summarize, refine |
|
|
26
26
|
|
|
27
27
|
### Sections
|
|
28
28
|
Reusable content sections for specific workflows.
|
|
@@ -52,6 +52,7 @@ Recovery patterns for common agent issues.
|
|
|
52
52
|
| `/clavix:implement` | AGENT_MANUAL, state-awareness, task-blocking, cli-reference, vibecoder-recovery |
|
|
53
53
|
| `/clavix:start` | AGENT_MANUAL, supportive-companion, conversation-examples, vibecoder-recovery |
|
|
54
54
|
| `/clavix:summarize` | AGENT_MANUAL, improvement-explanations, quality-dimensions, state-awareness, vibecoder-recovery |
|
|
55
|
+
| `/clavix:refine` | AGENT_MANUAL, cli-reference, quality-dimensions, state-awareness |
|
|
55
56
|
| `/clavix:verify` | AGENT_MANUAL, cli-reference, vibecoder-recovery |
|
|
56
57
|
| `/clavix:archive` | AGENT_MANUAL, cli-reference, vibecoder-recovery |
|
|
57
58
|
|
|
@@ -160,3 +160,24 @@ If ANY of these are true, suggest deep mode:
|
|
|
160
160
|
| Completeness | 25% | Yes - below 50% triggers deep mode |
|
|
161
161
|
| Actionability | 20% | Yes - below 50% triggers deep mode |
|
|
162
162
|
| Specificity | 10% | No |
|
|
163
|
+
|
|
164
|
+
---
|
|
165
|
+
|
|
166
|
+
### Workflow-Specific Dimension Usage
|
|
167
|
+
|
|
168
|
+
Different Clavix workflows use quality dimensions in different ways:
|
|
169
|
+
|
|
170
|
+
| Workflow | Dimensions Used | Notes |
|
|
171
|
+
|----------|----------------|-------|
|
|
172
|
+
| `/clavix:improve` | All 6 | Full quality assessment for prompt optimization |
|
|
173
|
+
| `/clavix:prd` | All 6 | PRD quality requires all dimensions |
|
|
174
|
+
| `/clavix:summarize` | 5 (excludes Specificity) | Conversational extraction may lack concrete specifics by nature |
|
|
175
|
+
| `/clavix:refine` | All 6 | Refinement targets all quality aspects |
|
|
176
|
+
|
|
177
|
+
**Why Summarize Excludes Specificity:**
|
|
178
|
+
The `/clavix:summarize` command extracts requirements from conversation. Users in exploratory mode often haven't determined specific versions, numbers, or file paths yet. Penalizing for missing specifics would unfairly score valid exploratory outputs.
|
|
179
|
+
|
|
180
|
+
**Rationale for Dimension Selection:**
|
|
181
|
+
- **Clarity, Completeness, Actionability**: Always critical - these determine if AI can act on the prompt
|
|
182
|
+
- **Structure, Efficiency**: Important for complex prompts, less critical for simple ones
|
|
183
|
+
- **Specificity**: Important for implementation, less important for early-stage exploration
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "clavix",
|
|
3
|
-
"version": "5.6.
|
|
4
|
-
"description": "Agentic-first prompt workflows. Markdown templates that teach AI agents how to optimize prompts, create PRDs, and manage implementation.\n\nSLASH COMMANDS (in your AI assistant):\n /clavix:improve Optimize prompts with auto-depth\n /clavix:prd Generate PRD through questions\n /clavix:plan Create task breakdown from PRD\n /clavix:implement Execute tasks with progress tracking\n /clavix:start Begin conversational session\n /clavix:summarize Extract requirements from conversation\n\nWorks with Claude Code, Cursor, Windsurf, and
|
|
3
|
+
"version": "5.6.6",
|
|
4
|
+
"description": "Agentic-first prompt workflows. Markdown templates that teach AI agents how to optimize prompts, create PRDs, and manage implementation.\n\nSLASH COMMANDS (in your AI assistant):\n /clavix:improve Optimize prompts with auto-depth\n /clavix:prd Generate PRD through questions\n /clavix:plan Create task breakdown from PRD\n /clavix:implement Execute tasks with progress tracking\n /clavix:start Begin conversational session\n /clavix:summarize Extract requirements from conversation\n /clavix:refine Refine existing PRD or prompt\n /clavix:verify Verify implementation against requirements\n /clavix:archive Archive completed projects\n\nWorks with Claude Code, Cursor, Windsurf, and 20 AI coding tools.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
7
7
|
"types": "dist/index.d.ts",
|