clavix 4.12.0 → 5.0.1
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 +69 -61
- package/dist/cli/commands/init.js +54 -153
- package/dist/cli/commands/update.js +19 -21
- package/dist/templates/agents/agents.md +28 -26
- package/dist/templates/agents/copilot-instructions.md +42 -36
- package/dist/templates/agents/octo.md +41 -36
- package/dist/templates/agents/warp.md +24 -24
- package/dist/templates/instructions/README.md +8 -5
- package/dist/templates/slash-commands/_canonical/archive.md +83 -121
- package/dist/templates/slash-commands/_canonical/execute.md +32 -42
- package/dist/templates/slash-commands/_canonical/implement.md +32 -44
- package/dist/templates/slash-commands/_canonical/improve.md +13 -52
- package/dist/templates/slash-commands/_canonical/plan.md +8 -20
- package/dist/templates/slash-commands/_canonical/verify.md +9 -9
- package/dist/templates/slash-commands/_components/agent-protocols/assertion-checkpoints.md +1 -1
- package/dist/templates/slash-commands/_components/agent-protocols/cli-reference.md +84 -180
- package/dist/templates/slash-commands/_components/agent-protocols/decision-rules.md +5 -6
- package/dist/templates/slash-commands/_components/agent-protocols/error-handling.md +2 -2
- package/dist/templates/slash-commands/_components/agent-protocols/file-formats.md +41 -59
- package/dist/templates/slash-commands/_components/agent-protocols/state-awareness.md +5 -7
- package/dist/templates/slash-commands/_components/sections/file-saving-protocol.md +20 -27
- package/dist/templates/slash-commands/_components/troubleshooting/file-not-saved.md +4 -5
- package/dist/templates/slash-commands/_components/troubleshooting/vibecoder-recovery.md +2 -2
- package/dist/utils/agent-error-messages.js +13 -12
- package/package.json +2 -2
- package/dist/cli/commands/analyze.d.ts +0 -17
- package/dist/cli/commands/analyze.js +0 -133
- package/dist/cli/commands/archive.d.ts +0 -36
- package/dist/cli/commands/archive.js +0 -266
- package/dist/cli/commands/deep.d.ts +0 -17
- package/dist/cli/commands/deep.js +0 -170
- package/dist/cli/commands/execute.d.ts +0 -15
- package/dist/cli/commands/execute.js +0 -168
- package/dist/cli/commands/fast.d.ts +0 -18
- package/dist/cli/commands/fast.js +0 -219
- package/dist/cli/commands/implement.d.ts +0 -24
- package/dist/cli/commands/implement.js +0 -289
- package/dist/cli/commands/improve.d.ts +0 -32
- package/dist/cli/commands/improve.js +0 -250
- package/dist/cli/commands/list.d.ts +0 -17
- package/dist/cli/commands/list.js +0 -217
- package/dist/cli/commands/plan.d.ts +0 -21
- package/dist/cli/commands/plan.js +0 -297
- package/dist/cli/commands/prd.d.ts +0 -24
- package/dist/cli/commands/prd.js +0 -321
- package/dist/cli/commands/prompts/clear.d.ts +0 -16
- package/dist/cli/commands/prompts/clear.js +0 -222
- package/dist/cli/commands/prompts/list.d.ts +0 -8
- package/dist/cli/commands/prompts/list.js +0 -88
- package/dist/cli/commands/show.d.ts +0 -21
- package/dist/cli/commands/show.js +0 -191
- package/dist/cli/commands/start.d.ts +0 -40
- package/dist/cli/commands/start.js +0 -210
- package/dist/cli/commands/summarize.d.ts +0 -17
- package/dist/cli/commands/summarize.js +0 -196
- package/dist/cli/commands/task-complete.d.ts +0 -27
- package/dist/cli/commands/task-complete.js +0 -269
- package/dist/cli/commands/verify.d.ts +0 -28
- package/dist/cli/commands/verify.js +0 -349
- package/dist/core/archive-manager.d.ts +0 -100
- package/dist/core/archive-manager.js +0 -302
- package/dist/core/basic-checklist-generator.d.ts +0 -35
- package/dist/core/basic-checklist-generator.js +0 -344
- package/dist/core/checklist-parser.d.ts +0 -48
- package/dist/core/checklist-parser.js +0 -238
- package/dist/core/config-manager.d.ts +0 -149
- package/dist/core/config-manager.js +0 -230
- package/dist/core/conversation-analyzer.d.ts +0 -86
- package/dist/core/conversation-analyzer.js +0 -387
- package/dist/core/conversation-quality-tracker.d.ts +0 -81
- package/dist/core/conversation-quality-tracker.js +0 -195
- package/dist/core/git-manager.d.ts +0 -126
- package/dist/core/git-manager.js +0 -282
- package/dist/core/intelligence/confidence-calculator.d.ts +0 -93
- package/dist/core/intelligence/confidence-calculator.js +0 -124
- package/dist/core/intelligence/index.d.ts +0 -11
- package/dist/core/intelligence/index.js +0 -15
- package/dist/core/intelligence/intent-detector.d.ts +0 -54
- package/dist/core/intelligence/intent-detector.js +0 -723
- package/dist/core/intelligence/pattern-library.d.ts +0 -104
- package/dist/core/intelligence/pattern-library.js +0 -330
- package/dist/core/intelligence/patterns/actionability-enhancer.d.ts +0 -27
- package/dist/core/intelligence/patterns/actionability-enhancer.js +0 -192
- package/dist/core/intelligence/patterns/alternative-phrasing-generator.d.ts +0 -29
- package/dist/core/intelligence/patterns/alternative-phrasing-generator.js +0 -239
- package/dist/core/intelligence/patterns/ambiguity-detector.d.ts +0 -22
- package/dist/core/intelligence/patterns/ambiguity-detector.js +0 -196
- package/dist/core/intelligence/patterns/assumption-explicitizer.d.ts +0 -30
- package/dist/core/intelligence/patterns/assumption-explicitizer.js +0 -296
- package/dist/core/intelligence/patterns/base-pattern.d.ts +0 -192
- package/dist/core/intelligence/patterns/base-pattern.js +0 -103
- package/dist/core/intelligence/patterns/completeness-validator.d.ts +0 -27
- package/dist/core/intelligence/patterns/completeness-validator.js +0 -221
- package/dist/core/intelligence/patterns/conciseness-filter.d.ts +0 -20
- package/dist/core/intelligence/patterns/conciseness-filter.js +0 -92
- package/dist/core/intelligence/patterns/context-precision.d.ts +0 -32
- package/dist/core/intelligence/patterns/context-precision.js +0 -389
- package/dist/core/intelligence/patterns/conversation-summarizer.d.ts +0 -30
- package/dist/core/intelligence/patterns/conversation-summarizer.js +0 -277
- package/dist/core/intelligence/patterns/dependency-identifier.d.ts +0 -23
- package/dist/core/intelligence/patterns/dependency-identifier.js +0 -166
- package/dist/core/intelligence/patterns/domain-context-enricher.d.ts +0 -21
- package/dist/core/intelligence/patterns/domain-context-enricher.js +0 -198
- package/dist/core/intelligence/patterns/edge-case-identifier.d.ts +0 -30
- package/dist/core/intelligence/patterns/edge-case-identifier.js +0 -269
- package/dist/core/intelligence/patterns/error-tolerance-enhancer.d.ts +0 -22
- package/dist/core/intelligence/patterns/error-tolerance-enhancer.js +0 -179
- package/dist/core/intelligence/patterns/implicit-requirement-extractor.d.ts +0 -24
- package/dist/core/intelligence/patterns/implicit-requirement-extractor.js +0 -259
- package/dist/core/intelligence/patterns/objective-clarifier.d.ts +0 -22
- package/dist/core/intelligence/patterns/objective-clarifier.js +0 -126
- package/dist/core/intelligence/patterns/output-format-enforcer.d.ts +0 -22
- package/dist/core/intelligence/patterns/output-format-enforcer.js +0 -151
- package/dist/core/intelligence/patterns/prd-structure-enforcer.d.ts +0 -23
- package/dist/core/intelligence/patterns/prd-structure-enforcer.js +0 -183
- package/dist/core/intelligence/patterns/prerequisite-identifier.d.ts +0 -23
- package/dist/core/intelligence/patterns/prerequisite-identifier.js +0 -221
- package/dist/core/intelligence/patterns/requirement-prioritizer.d.ts +0 -24
- package/dist/core/intelligence/patterns/requirement-prioritizer.js +0 -134
- package/dist/core/intelligence/patterns/scope-definer.d.ts +0 -26
- package/dist/core/intelligence/patterns/scope-definer.js +0 -236
- package/dist/core/intelligence/patterns/step-decomposer.d.ts +0 -31
- package/dist/core/intelligence/patterns/step-decomposer.js +0 -242
- package/dist/core/intelligence/patterns/structure-organizer.d.ts +0 -31
- package/dist/core/intelligence/patterns/structure-organizer.js +0 -218
- package/dist/core/intelligence/patterns/success-criteria-enforcer.d.ts +0 -22
- package/dist/core/intelligence/patterns/success-criteria-enforcer.js +0 -165
- package/dist/core/intelligence/patterns/success-metrics-enforcer.d.ts +0 -24
- package/dist/core/intelligence/patterns/success-metrics-enforcer.js +0 -165
- package/dist/core/intelligence/patterns/technical-context-enricher.d.ts +0 -25
- package/dist/core/intelligence/patterns/technical-context-enricher.js +0 -165
- package/dist/core/intelligence/patterns/topic-coherence-analyzer.d.ts +0 -26
- package/dist/core/intelligence/patterns/topic-coherence-analyzer.js +0 -300
- package/dist/core/intelligence/patterns/user-persona-enricher.d.ts +0 -24
- package/dist/core/intelligence/patterns/user-persona-enricher.js +0 -141
- package/dist/core/intelligence/patterns/validation-checklist-creator.d.ts +0 -31
- package/dist/core/intelligence/patterns/validation-checklist-creator.js +0 -242
- package/dist/core/intelligence/quality-assessor.d.ts +0 -71
- package/dist/core/intelligence/quality-assessor.js +0 -525
- package/dist/core/intelligence/types.d.ts +0 -111
- package/dist/core/intelligence/types.js +0 -3
- package/dist/core/intelligence/universal-optimizer.d.ts +0 -91
- package/dist/core/intelligence/universal-optimizer.js +0 -399
- package/dist/core/prd-generator.d.ts +0 -76
- package/dist/core/prd-generator.js +0 -173
- package/dist/core/prompt-manager.d.ts +0 -110
- package/dist/core/prompt-manager.js +0 -274
- package/dist/core/prompt-optimizer.d.ts +0 -268
- package/dist/core/prompt-optimizer.js +0 -959
- package/dist/core/question-engine.d.ts +0 -167
- package/dist/core/question-engine.js +0 -356
- package/dist/core/session-manager.d.ts +0 -139
- package/dist/core/session-manager.js +0 -365
- package/dist/core/task-manager.d.ts +0 -211
- package/dist/core/task-manager.js +0 -981
- package/dist/core/verification-hooks.d.ts +0 -67
- package/dist/core/verification-hooks.js +0 -309
- package/dist/core/verification-manager.d.ts +0 -107
- package/dist/core/verification-manager.js +0 -415
- package/dist/types/session.d.ts +0 -78
- package/dist/types/session.js +0 -8
- package/dist/types/verification.d.ts +0 -205
- package/dist/types/verification.js +0 -9
|
@@ -38,8 +38,7 @@ For complete step-by-step workflows, see `.clavix/instructions/`:
|
|
|
38
38
|
|----------|-----------------|---------|
|
|
39
39
|
| **Conversational Mode** | `workflows/start.md` | Natural requirements gathering through discussion |
|
|
40
40
|
| **Extract Requirements** | `workflows/summarize.md` | Analyze conversation → mini-PRD + optimized prompts |
|
|
41
|
-
| **
|
|
42
|
-
| **Deep Analysis** | `workflows/deep.md` | Comprehensive with alternatives, validation, edge cases |
|
|
41
|
+
| **Prompt Optimization** | `workflows/improve.md` | Intent detection + quality assessment + auto-depth selection |
|
|
43
42
|
| **PRD Generation** | `workflows/prd.md` | Socratic questions → full PRD + quick PRD |
|
|
44
43
|
| **Mode Boundaries** | `core/clavix-mode.md` | Planning vs implementation distinction |
|
|
45
44
|
|
|
@@ -54,33 +53,40 @@ For complete step-by-step workflows, see `.clavix/instructions/`:
|
|
|
54
53
|
|
|
55
54
|
---
|
|
56
55
|
|
|
57
|
-
## 📋
|
|
56
|
+
## 📋 Clavix Commands (v5)
|
|
58
57
|
|
|
58
|
+
### Setup Commands (CLI)
|
|
59
59
|
| Command | Purpose |
|
|
60
60
|
|---------|---------|
|
|
61
|
-
| `clavix
|
|
62
|
-
| `clavix
|
|
63
|
-
| `clavix
|
|
64
|
-
| `clavix
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
|
70
|
-
|
|
71
|
-
|
|
|
72
|
-
|
|
|
73
|
-
|
|
|
61
|
+
| `clavix init` | Initialize Clavix in a project |
|
|
62
|
+
| `clavix update` | Update templates after package update |
|
|
63
|
+
| `clavix config` | Manage configuration |
|
|
64
|
+
| `clavix version` | Show version |
|
|
65
|
+
|
|
66
|
+
### Workflow Commands (Slash Commands)
|
|
67
|
+
All workflows are executed via slash commands:
|
|
68
|
+
|
|
69
|
+
| Slash Command | Purpose |
|
|
70
|
+
|---------------|---------|
|
|
71
|
+
| `/clavix:improve` | Optimize prompts (auto-selects depth) |
|
|
72
|
+
| `/clavix:prd` | Generate PRD through guided questions |
|
|
73
|
+
| `/clavix:plan` | Create task breakdown from PRD |
|
|
74
|
+
| `/clavix:implement` | Execute tasks with progress tracking |
|
|
75
|
+
| `/clavix:start` | Begin conversational session |
|
|
76
|
+
| `/clavix:summarize` | Extract requirements from conversation |
|
|
77
|
+
| `/clavix:execute` | Run saved prompts |
|
|
78
|
+
| `/clavix:verify` | Verify implementation |
|
|
79
|
+
| `/clavix:archive` | Archive completed projects |
|
|
74
80
|
|
|
75
81
|
---
|
|
76
82
|
|
|
77
|
-
## 🔄 Prompt Lifecycle
|
|
83
|
+
## 🔄 Prompt Lifecycle Workflow
|
|
78
84
|
|
|
79
|
-
**Prompt Lifecycle
|
|
80
|
-
1. **Optimize**:
|
|
81
|
-
2. **Review**:
|
|
82
|
-
3. **Execute**:
|
|
83
|
-
4. **Cleanup**:
|
|
85
|
+
**Prompt Lifecycle:**
|
|
86
|
+
1. **Optimize**: `/clavix:improve` → Analyzes and improves your prompt
|
|
87
|
+
2. **Review**: Agent reads `.clavix/outputs/prompts/*.md` to list saved prompts
|
|
88
|
+
3. **Execute**: `/clavix:execute` → Implement when ready
|
|
89
|
+
4. **Cleanup**: Agent deletes old prompt files from `.clavix/outputs/prompts/`
|
|
84
90
|
|
|
85
91
|
---
|
|
86
92
|
|
|
@@ -94,10 +100,10 @@ PRD Creation → Task Planning → Implementation → Archive
|
|
|
94
100
|
|
|
95
101
|
**Detailed steps:**
|
|
96
102
|
|
|
97
|
-
1. **Planning Phase** -
|
|
98
|
-
2. **Task Preparation** -
|
|
99
|
-
3. **Implementation Phase** -
|
|
100
|
-
4. **Completion** -
|
|
103
|
+
1. **Planning Phase** - `/clavix:prd` or `/clavix:start` → `/clavix:summarize`
|
|
104
|
+
2. **Task Preparation** - `/clavix:plan` transforms PRD into tasks.md
|
|
105
|
+
3. **Implementation Phase** - `/clavix:implement` executes tasks systematically
|
|
106
|
+
4. **Completion** - `/clavix:archive` archives completed work
|
|
101
107
|
|
|
102
108
|
**Key principle:** Planning workflows create documents. Implementation workflows write code.
|
|
103
109
|
|
|
@@ -113,17 +119,17 @@ When analyzing prompts, consider these 5 dimensions:
|
|
|
113
119
|
- **Completeness**: All specs provided (persona, format, tone, success criteria)?
|
|
114
120
|
- **Actionability**: Can AI take immediate action?
|
|
115
121
|
|
|
116
|
-
**Reference:** See `workflows/
|
|
122
|
+
**Reference:** See `workflows/improve.md` for complete quality assessment patterns
|
|
117
123
|
|
|
118
124
|
---
|
|
119
125
|
|
|
120
126
|
## 💡 Best Practices for GitHub Copilot
|
|
121
127
|
|
|
122
|
-
1. **Suggest appropriate workflow** -
|
|
128
|
+
1. **Suggest appropriate workflow** - `/clavix:improve` for prompts, `/clavix:prd` for strategic planning
|
|
123
129
|
2. **Reference instruction files** - Point to `.clavix/instructions/workflows/*.md` instead of recreating steps
|
|
124
130
|
3. **Respect mode boundaries** - Planning mode = no code, Implementation mode = write code
|
|
125
131
|
4. **Use quality dimensions** - Apply 5-dimension assessment principles in responses
|
|
126
|
-
5. **Guide users to
|
|
132
|
+
5. **Guide users to slash commands** - Recommend appropriate `/clavix:*` commands for their needs
|
|
127
133
|
|
|
128
134
|
---
|
|
129
135
|
|
|
@@ -132,17 +138,17 @@ When analyzing prompts, consider these 5 dimensions:
|
|
|
132
138
|
### ❌ Jumping to implementation during planning
|
|
133
139
|
**Wrong:** User discusses feature → Copilot generates code immediately
|
|
134
140
|
|
|
135
|
-
**Right:** User discusses feature → Suggest
|
|
141
|
+
**Right:** User discusses feature → Suggest `/clavix:prd` or `/clavix:start` → Create planning docs first
|
|
136
142
|
|
|
137
143
|
### ❌ Not suggesting Clavix workflows
|
|
138
144
|
**Wrong:** User asks "How should I phrase this?" → Copilot provides generic advice
|
|
139
145
|
|
|
140
|
-
**Right:** User asks "How should I phrase this?" → Suggest
|
|
146
|
+
**Right:** User asks "How should I phrase this?" → Suggest `/clavix:improve` for quality assessment
|
|
141
147
|
|
|
142
148
|
### ❌ Recreating workflow steps inline
|
|
143
149
|
**Wrong:** Copilot explains entire PRD generation process in chat
|
|
144
150
|
|
|
145
|
-
**Right:** Copilot references `.clavix/instructions/workflows/prd.md` and suggests running
|
|
151
|
+
**Right:** Copilot references `.clavix/instructions/workflows/prd.md` and suggests running `/clavix:prd`
|
|
146
152
|
|
|
147
153
|
---
|
|
148
154
|
|
|
@@ -151,7 +157,7 @@ When analyzing prompts, consider these 5 dimensions:
|
|
|
151
157
|
When users ask for help with prompts or requirements:
|
|
152
158
|
|
|
153
159
|
1. **Detect need** - Identify if user needs planning, optimization, or implementation
|
|
154
|
-
2. **Suggest command** - Recommend appropriate
|
|
160
|
+
2. **Suggest slash command** - Recommend appropriate `/clavix:*` command
|
|
155
161
|
3. **Explain benefit** - Describe expected output and value
|
|
156
162
|
4. **Help interpret** - Assist with understanding Clavix-generated outputs
|
|
157
163
|
5. **Apply principles** - Use quality dimensions in your responses
|
|
@@ -159,10 +165,10 @@ When users ask for help with prompts or requirements:
|
|
|
159
165
|
**Example flow:**
|
|
160
166
|
```
|
|
161
167
|
User: "I want to build a dashboard but I'm not sure how to phrase the requirements"
|
|
162
|
-
Copilot: "I suggest running
|
|
168
|
+
Copilot: "I suggest running `/clavix:start` to begin conversational requirements gathering.
|
|
163
169
|
This will help us explore your needs naturally, then we can extract structured requirements
|
|
164
|
-
with
|
|
165
|
-
clavix
|
|
170
|
+
with `/clavix:summarize`. Alternatively, if you have a rough idea, try:
|
|
171
|
+
`/clavix:improve 'Build a dashboard for...'` for quick optimization."
|
|
166
172
|
```
|
|
167
173
|
|
|
168
174
|
---
|
|
@@ -20,9 +20,10 @@ Clavix workflows optimized for Octofriend's capabilities: model switching, multi
|
|
|
20
20
|
- ❌ DO NOT implement features during these workflows
|
|
21
21
|
|
|
22
22
|
**IMPLEMENTATION workflows** (CODE ALLOWED):
|
|
23
|
-
- `/clavix:implement`, `/clavix:execute
|
|
23
|
+
- `/clavix:implement`, `/clavix:execute`
|
|
24
24
|
- Your role: Write code, execute tasks, implement features
|
|
25
25
|
- ✅ DO implement code during these workflows
|
|
26
|
+
- Mark task completion by editing tasks.md directly (`- [ ]` → `- [x]`)
|
|
26
27
|
|
|
27
28
|
See `.clavix/instructions/core/clavix-mode.md` for complete mode documentation.
|
|
28
29
|
|
|
@@ -115,35 +116,40 @@ Autofix handles edge cases gracefully - let it work.
|
|
|
115
116
|
|
|
116
117
|
---
|
|
117
118
|
|
|
118
|
-
## 📋
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
| `clavix
|
|
124
|
-
| `clavix
|
|
125
|
-
| `clavix
|
|
126
|
-
| `clavix
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
|
130
|
-
|
|
131
|
-
|
|
|
132
|
-
|
|
|
133
|
-
|
|
|
134
|
-
|
|
|
119
|
+
## 📋 Clavix Commands (v5)
|
|
120
|
+
|
|
121
|
+
### Setup Commands (CLI)
|
|
122
|
+
| Command | Purpose |
|
|
123
|
+
|---------|---------|
|
|
124
|
+
| `clavix init` | Initialize Clavix in a project |
|
|
125
|
+
| `clavix update` | Update templates after package update |
|
|
126
|
+
| `clavix config` | Manage configuration |
|
|
127
|
+
| `clavix version` | Show version |
|
|
128
|
+
|
|
129
|
+
### Workflow Commands (Slash Commands)
|
|
130
|
+
| Slash Command | Purpose |
|
|
131
|
+
|---------------|---------|
|
|
132
|
+
| `/clavix:improve` | Optimize prompts (auto-selects depth) |
|
|
133
|
+
| `/clavix:prd` | Generate PRD through questions |
|
|
134
|
+
| `/clavix:plan` | Create task breakdown from PRD |
|
|
135
|
+
| `/clavix:implement` | Execute tasks with progress tracking |
|
|
136
|
+
| `/clavix:start` | Begin conversational session |
|
|
137
|
+
| `/clavix:summarize` | Extract requirements from conversation |
|
|
138
|
+
| `/clavix:execute` | Run saved prompts |
|
|
139
|
+
| `/clavix:verify` | Verify implementation |
|
|
140
|
+
| `/clavix:archive` | Archive completed projects |
|
|
135
141
|
|
|
136
142
|
---
|
|
137
143
|
|
|
138
144
|
## 🔄 Prompt Execution Workflow
|
|
139
145
|
|
|
140
|
-
**When you have a saved prompt to execute
|
|
146
|
+
**When you have a saved prompt to execute:**
|
|
141
147
|
|
|
142
|
-
1. **List available prompts**:
|
|
143
|
-
2. **
|
|
144
|
-
3. **
|
|
148
|
+
1. **List available prompts**: List files in `.clavix/outputs/prompts/*.md`
|
|
149
|
+
2. **Execute prompt**: `/clavix:execute` - implement saved prompt
|
|
150
|
+
3. **Implement**: Agent reads the optimized prompt and implements the feature
|
|
145
151
|
|
|
146
|
-
**Note:**
|
|
152
|
+
**Note:** Slash commands save prompts as `.md` files with frontmatter metadata.
|
|
147
153
|
|
|
148
154
|
---
|
|
149
155
|
|
|
@@ -151,26 +157,25 @@ Autofix handles edge cases gracefully - let it work.
|
|
|
151
157
|
|
|
152
158
|
**Complete project flow:**
|
|
153
159
|
|
|
154
|
-
1. **Planning** (
|
|
160
|
+
1. **Planning** (`/clavix:prd`)
|
|
155
161
|
- Creates PRD (full + quick versions)
|
|
156
162
|
- Saves to `.clavix/outputs/{project}/`
|
|
157
163
|
|
|
158
|
-
2. **Task Preparation** (
|
|
164
|
+
2. **Task Preparation** (`/clavix:plan`)
|
|
159
165
|
- Transforms PRD → curated tasks.md
|
|
160
166
|
- Phase-based organization
|
|
161
167
|
|
|
162
|
-
3. **Implementation** (
|
|
168
|
+
3. **Implementation** (`/clavix:implement`)
|
|
163
169
|
- Agent executes tasks systematically
|
|
164
|
-
-
|
|
170
|
+
- Marks progress by editing tasks.md (`- [ ]` → `- [x]`)
|
|
165
171
|
- Optional git commit strategies
|
|
166
172
|
|
|
167
|
-
4. **Completion** (
|
|
173
|
+
4. **Completion** (`/clavix:archive`)
|
|
168
174
|
- Archives completed project
|
|
169
175
|
|
|
170
176
|
**Alternative quick paths:**
|
|
171
|
-
- **Quick improvement**:
|
|
172
|
-
- **
|
|
173
|
-
- **Conversational**: `clavix start` → `clavix summarize` → `clavix execute` → Done
|
|
177
|
+
- **Quick improvement**: `/clavix:improve` → `/clavix:execute` → Done
|
|
178
|
+
- **Conversational**: `/clavix:start` → `/clavix:summarize` → `/clavix:execute` → Done
|
|
174
179
|
|
|
175
180
|
---
|
|
176
181
|
|
|
@@ -189,9 +194,9 @@ Autofix handles edge cases gracefully - let it work.
|
|
|
189
194
|
## ⚠️ Common Mistakes
|
|
190
195
|
|
|
191
196
|
### ❌ Implementing during planning workflows
|
|
192
|
-
**Wrong:** User runs
|
|
197
|
+
**Wrong:** User runs `/clavix:prd`, you generate PRD then start building features
|
|
193
198
|
|
|
194
|
-
**Right:** User runs
|
|
199
|
+
**Right:** User runs `/clavix:prd`, you generate PRD, save files, suggest `/clavix:plan` as next step
|
|
195
200
|
|
|
196
201
|
### ❌ Skipping file creation
|
|
197
202
|
**Wrong:** Display optimized prompt, stop there
|
|
@@ -201,7 +206,7 @@ Autofix handles edge cases gracefully - let it work.
|
|
|
201
206
|
### ❌ Not referencing instruction files
|
|
202
207
|
**Wrong:** Trying to remember workflow details from this file
|
|
203
208
|
|
|
204
|
-
**Right:** "See `.clavix/instructions/workflows/
|
|
209
|
+
**Right:** "See `.clavix/instructions/workflows/improve.md` for complete workflow"
|
|
205
210
|
|
|
206
211
|
### ❌ Using wrong model for task
|
|
207
212
|
**Wrong:** Using fast model for complex architectural planning
|
|
@@ -212,9 +217,9 @@ Autofix handles edge cases gracefully - let it work.
|
|
|
212
217
|
|
|
213
218
|
## 🆘 When in Doubt
|
|
214
219
|
|
|
215
|
-
1. **Check which command was run** - Determines your mode (planning vs implementation)
|
|
220
|
+
1. **Check which slash command was run** - Determines your mode (planning vs implementation)
|
|
216
221
|
2. **Reference instruction files** - They have complete step-by-step guidance
|
|
217
|
-
3. **Ask the user** - "Should I implement this (run
|
|
222
|
+
3. **Ask the user** - "Should I implement this (run `/clavix:implement`), or continue planning?"
|
|
218
223
|
4. **Switch models** - Use thinking models for complex planning tasks
|
|
219
224
|
|
|
220
225
|
---
|
|
@@ -33,8 +33,7 @@ See `.clavix/instructions/core/clavix-mode.md` for complete mode documentation.
|
|
|
33
33
|
For complete step-by-step workflows, see `.clavix/instructions/`:
|
|
34
34
|
- `.clavix/instructions/workflows/start.md` - Conversational mode
|
|
35
35
|
- `.clavix/instructions/workflows/summarize.md` - Extract requirements
|
|
36
|
-
- `.clavix/instructions/workflows/
|
|
37
|
-
- `.clavix/instructions/workflows/deep.md` - Comprehensive analysis
|
|
36
|
+
- `.clavix/instructions/workflows/improve.md` - Prompt optimization (auto-depth)
|
|
38
37
|
- `.clavix/instructions/workflows/prd.md` - PRD generation
|
|
39
38
|
- `.clavix/instructions/troubleshooting/` - Common issues
|
|
40
39
|
|
|
@@ -47,25 +46,26 @@ For complete step-by-step workflows, see `.clavix/instructions/`:
|
|
|
47
46
|
- Or run ad hoc: `npx clavix@latest init`
|
|
48
47
|
- Verify setup: `clavix version`
|
|
49
48
|
|
|
50
|
-
###
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
49
|
+
### CLI Commands (v5)
|
|
50
|
+
| Command | Purpose |
|
|
51
|
+
|---------|---------|
|
|
52
|
+
| `clavix init` | Initialize Clavix in a project |
|
|
53
|
+
| `clavix update` | Update templates after package update |
|
|
54
|
+
| `clavix config` | Manage configuration |
|
|
55
|
+
| `clavix version` | Show version |
|
|
56
|
+
|
|
57
|
+
### Slash Commands (Workflows)
|
|
58
|
+
| Slash Command | Purpose |
|
|
59
|
+
|---------------|---------|
|
|
60
|
+
| `/clavix:improve` | Optimize prompts (auto-selects depth) |
|
|
61
|
+
| `/clavix:prd` | Generate PRD through guided questions |
|
|
62
|
+
| `/clavix:plan` | Create task breakdown from PRD |
|
|
63
|
+
| `/clavix:implement` | Execute tasks with progress tracking |
|
|
64
|
+
| `/clavix:start` | Begin conversational session |
|
|
65
|
+
| `/clavix:summarize` | Extract requirements from conversation |
|
|
66
|
+
| `/clavix:execute` | Run saved prompts |
|
|
67
|
+
| `/clavix:verify` | Verify implementation |
|
|
68
|
+
| `/clavix:archive` | Archive completed projects |
|
|
69
69
|
|
|
70
70
|
### Outputs
|
|
71
71
|
- Project artifacts live under `.clavix/outputs/<project>/`
|
|
@@ -86,14 +86,14 @@ For complete step-by-step workflows, see `.clavix/instructions/`:
|
|
|
86
86
|
### ⚠️ Common Mistakes
|
|
87
87
|
|
|
88
88
|
#### ❌ Jumping to implementation during planning
|
|
89
|
-
**Wrong:** User runs
|
|
89
|
+
**Wrong:** User runs `/clavix:prd`, you generate PRD then start building features
|
|
90
90
|
|
|
91
|
-
**Right:** User runs
|
|
91
|
+
**Right:** User runs `/clavix:prd`, you generate PRD, save files, suggest `/clavix:plan` as next step
|
|
92
92
|
|
|
93
93
|
#### ❌ Not referencing instruction files
|
|
94
94
|
**Wrong:** Trying to remember workflow details from this file
|
|
95
95
|
|
|
96
|
-
**Right:** "See `.clavix/instructions/workflows/
|
|
96
|
+
**Right:** "See `.clavix/instructions/workflows/improve.md` for complete workflow"
|
|
97
97
|
|
|
98
98
|
---
|
|
99
99
|
|
|
@@ -137,12 +137,15 @@ PRD Creation → Task Planning → Implementation → Verification → Archive
|
|
|
137
137
|
| `/clavix:verify` | Verification | Context-dependent |
|
|
138
138
|
| `/clavix:archive` | Management | ✗ NO |
|
|
139
139
|
|
|
140
|
-
### Agent
|
|
140
|
+
### Agent Operations (v5 Agentic-First)
|
|
141
141
|
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
|
145
|
-
|
|
142
|
+
In v5, agents use native tools (Write, Edit, Bash) instead of CLI commands:
|
|
143
|
+
|
|
144
|
+
| Operation | How Agent Performs It |
|
|
145
|
+
|-----------|----------------------|
|
|
146
|
+
| Save prompt | Use Write tool to create `.clavix/outputs/prompts/<id>.md` |
|
|
147
|
+
| Mark task done | Use Edit tool to change `- [ ]` to `- [x]` in tasks.md |
|
|
148
|
+
| Archive project | Use Bash tool to move directory to archive/ |
|
|
146
149
|
|
|
147
150
|
---
|
|
148
151
|
|