clavix 2.2.0 → 2.3.0
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 +2 -2
- package/dist/cli/commands/init.js +11 -4
- package/dist/core/adapters/copilot-instructions-generator.d.ts +26 -0
- package/dist/core/adapters/copilot-instructions-generator.js +104 -0
- package/dist/core/agent-manager.js +0 -2
- package/dist/templates/agents/copilot-instructions.md +90 -0
- package/dist/types/agent.d.ts +1 -1
- package/package.json +1 -1
- package/dist/core/adapters/copilot-adapter.d.ts +0 -24
- package/dist/core/adapters/copilot-adapter.js +0 -88
- package/dist/templates/slash-commands/copilot/archive.agent.md +0 -291
- package/dist/templates/slash-commands/copilot/deep.agent.md +0 -207
- package/dist/templates/slash-commands/copilot/fast.agent.md +0 -183
- package/dist/templates/slash-commands/copilot/implement.agent.md +0 -267
- package/dist/templates/slash-commands/copilot/plan.agent.md +0 -173
- package/dist/templates/slash-commands/copilot/prd.agent.md +0 -178
- package/dist/templates/slash-commands/copilot/start.agent.md +0 -142
- package/dist/templates/slash-commands/copilot/summarize.agent.md +0 -179
|
@@ -1,291 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: "Clavix: Archive"
|
|
3
|
-
description: Archive completed PRD projects
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Clavix Archive - PRD Project Archival
|
|
7
|
-
|
|
8
|
-
You are helping the user archive completed PRD projects to keep their workspace organized.
|
|
9
|
-
|
|
10
|
-
## Instructions
|
|
11
|
-
|
|
12
|
-
1. **Understanding Archive**:
|
|
13
|
-
- Archives move completed PRD projects from `.clavix/outputs/` to `.clavix/outputs/archive/`
|
|
14
|
-
- Archived projects are no longer shown in active project lists
|
|
15
|
-
- Projects can be restored from archive if needed
|
|
16
|
-
- Only projects with all tasks completed should typically be archived
|
|
17
|
-
|
|
18
|
-
2. **Interactive Archive Mode**:
|
|
19
|
-
```bash
|
|
20
|
-
clavix archive
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
This will:
|
|
24
|
-
- List all PRD projects with 100% tasks completed
|
|
25
|
-
- Allow user to select which project to archive
|
|
26
|
-
- Confirm before archiving
|
|
27
|
-
- Move the project to archive directory
|
|
28
|
-
|
|
29
|
-
3. **Archive Specific Project**:
|
|
30
|
-
```bash
|
|
31
|
-
clavix archive [project-name]
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
This will:
|
|
35
|
-
- Check task completion status
|
|
36
|
-
- Warn if tasks are incomplete
|
|
37
|
-
- Ask for confirmation
|
|
38
|
-
- Archive the specific project
|
|
39
|
-
|
|
40
|
-
4. **Force Archive (Incomplete Tasks)**:
|
|
41
|
-
```bash
|
|
42
|
-
clavix archive [project-name] --force
|
|
43
|
-
```
|
|
44
|
-
|
|
45
|
-
Use this when:
|
|
46
|
-
- Project scope changed and some tasks are no longer relevant
|
|
47
|
-
- User wants to archive work-in-progress
|
|
48
|
-
- Tasks are incomplete but project is done
|
|
49
|
-
|
|
50
|
-
5. **Delete Project (Permanent Removal)**: **DESTRUCTIVE ACTION**
|
|
51
|
-
```bash
|
|
52
|
-
clavix archive [project-name] --delete
|
|
53
|
-
```
|
|
54
|
-
|
|
55
|
-
**WARNING**: This PERMANENTLY deletes the project. Cannot be restored.
|
|
56
|
-
|
|
57
|
-
**When to delete vs archive:**
|
|
58
|
-
- **DELETE**: Failed experiments, duplicate projects, test/demo data, abandoned prototypes with no value
|
|
59
|
-
- **ARCHIVE**: Completed work, incomplete but potentially useful work, anything you might reference later
|
|
60
|
-
|
|
61
|
-
**Delete decision tree:**
|
|
62
|
-
```
|
|
63
|
-
Is this a failed experiment with no learning value? → DELETE
|
|
64
|
-
Is this a duplicate/test project with no unique info? → DELETE
|
|
65
|
-
Might you need to reference this code later? → ARCHIVE
|
|
66
|
-
Could this be useful for learning/reference? → ARCHIVE
|
|
67
|
-
Are you unsure? → ARCHIVE (safe default)
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
**Safety confirmation required:**
|
|
71
|
-
- Shows project details and task status
|
|
72
|
-
- Requires typing project name to confirm
|
|
73
|
-
- Warns about permanent deletion
|
|
74
|
-
- Lists what will be permanently deleted
|
|
75
|
-
|
|
76
|
-
6. **List Archived Projects**:
|
|
77
|
-
```bash
|
|
78
|
-
clavix archive --list
|
|
79
|
-
```
|
|
80
|
-
|
|
81
|
-
Shows all projects currently in archive with their task completion status
|
|
82
|
-
|
|
83
|
-
6. **Restore from Archive**:
|
|
84
|
-
```bash
|
|
85
|
-
clavix archive --restore [project-name]
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
Moves a project back from archive to active outputs
|
|
89
|
-
|
|
90
|
-
## When to Archive
|
|
91
|
-
|
|
92
|
-
**Good times to archive:**
|
|
93
|
-
- All implementation tasks are completed (`tasks.md` shows 100%)
|
|
94
|
-
- Project has been deployed/shipped to production
|
|
95
|
-
- Feature is complete and no more work planned
|
|
96
|
-
- User explicitly requests archival
|
|
97
|
-
- Old/abandoned projects that won't be continued
|
|
98
|
-
|
|
99
|
-
**Don't archive when:**
|
|
100
|
-
- Tasks are still in progress (unless using --force)
|
|
101
|
-
- Project is actively being worked on
|
|
102
|
-
- Future enhancements are planned in current tasks
|
|
103
|
-
|
|
104
|
-
## Archive Behavior
|
|
105
|
-
|
|
106
|
-
**What gets archived:**
|
|
107
|
-
- The entire PRD project folder
|
|
108
|
-
- All files: PRD.md, PRD-quick.md, tasks.md, .clavix-implement-config.json
|
|
109
|
-
- Complete directory structure preserved
|
|
110
|
-
|
|
111
|
-
**Where it goes:**
|
|
112
|
-
- From: `.clavix/outputs/[project-name]/`
|
|
113
|
-
- To: `.clavix/outputs/archive/[project-name]/`
|
|
114
|
-
|
|
115
|
-
**What changes:**
|
|
116
|
-
- Archived projects won't show in `/clavix:plan` searches
|
|
117
|
-
- Archived projects won't show in `/clavix:implement` searches
|
|
118
|
-
- They're still accessible in archive directory
|
|
119
|
-
- Can be restored at any time
|
|
120
|
-
|
|
121
|
-
## Example Workflows
|
|
122
|
-
|
|
123
|
-
### Workflow 1: Complete Project
|
|
124
|
-
```
|
|
125
|
-
User: "I've finished implementing the user authentication feature"
|
|
126
|
-
You: "Great! Let me help you archive it."
|
|
127
|
-
|
|
128
|
-
Run: clavix archive
|
|
129
|
-
|
|
130
|
-
User selects: user-authentication-system
|
|
131
|
-
System shows: All 15 tasks completed (100%)
|
|
132
|
-
User confirms: Yes, archive it
|
|
133
|
-
|
|
134
|
-
Result: Project moved to .clavix/outputs/archive/user-authentication-system/
|
|
135
|
-
```
|
|
136
|
-
|
|
137
|
-
### Workflow 2: Force Archive WIP
|
|
138
|
-
```
|
|
139
|
-
User: "We're pivoting, I want to archive the old API design even though tasks aren't done"
|
|
140
|
-
You: "I'll archive it with --force"
|
|
141
|
-
|
|
142
|
-
Run: clavix archive old-api-design --force
|
|
143
|
-
|
|
144
|
-
System shows: 8 incomplete tasks
|
|
145
|
-
User confirms: Yes, archive anyway
|
|
146
|
-
|
|
147
|
-
Result: Project archived despite incomplete tasks
|
|
148
|
-
```
|
|
149
|
-
|
|
150
|
-
### Workflow 3: Restore Archived Project
|
|
151
|
-
```
|
|
152
|
-
User: "Actually, we need to revisit that authentication feature"
|
|
153
|
-
You: "I'll restore it from the archive"
|
|
154
|
-
|
|
155
|
-
Run: clavix archive --restore user-authentication-system
|
|
156
|
-
|
|
157
|
-
Result: Project moved back to .clavix/outputs/user-authentication-system/
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
### Workflow 4: Delete Failed Experiment
|
|
161
|
-
```
|
|
162
|
-
User: "I have a test project 'api-experiment-1' that I don't need anymore"
|
|
163
|
-
You: "Is this something you might reference later, or can it be permanently deleted?"
|
|
164
|
-
|
|
165
|
-
User: "It was just a quick test, no value. Delete it."
|
|
166
|
-
You: "This will permanently delete the project. I'll run the delete command."
|
|
167
|
-
|
|
168
|
-
Run: clavix archive api-experiment-1 --delete
|
|
169
|
-
|
|
170
|
-
System shows:
|
|
171
|
-
Project: api-experiment-1
|
|
172
|
-
Tasks: 3/5 completed
|
|
173
|
-
Files: full-prd.md, quick-prd.md, tasks.md
|
|
174
|
-
|
|
175
|
-
WARNING: This action is PERMANENT and CANNOT be undone.
|
|
176
|
-
Type the project name to confirm deletion: _
|
|
177
|
-
|
|
178
|
-
User types: api-experiment-1
|
|
179
|
-
|
|
180
|
-
Result: Project permanently deleted from .clavix/outputs/api-experiment-1/
|
|
181
|
-
```
|
|
182
|
-
|
|
183
|
-
## AI Agent Guidelines
|
|
184
|
-
|
|
185
|
-
When user mentions archiving or cleaning up projects:
|
|
186
|
-
|
|
187
|
-
1. **Check completion status first**:
|
|
188
|
-
- Run `clavix archive` to see archivable projects
|
|
189
|
-
- Review task completion percentages
|
|
190
|
-
- Suggest archiving only completed projects
|
|
191
|
-
|
|
192
|
-
2. **Confirm before archiving**:
|
|
193
|
-
- Always confirm which project to archive
|
|
194
|
-
- Mention the archive location
|
|
195
|
-
- Explain that it can be restored
|
|
196
|
-
|
|
197
|
-
3. **Use --force cautiously**:
|
|
198
|
-
- Only when user explicitly wants to archive incomplete work
|
|
199
|
-
- Explain which tasks will remain incomplete
|
|
200
|
-
- Confirm they won't lose data (just moving location)
|
|
201
|
-
|
|
202
|
-
4. **Suggest restoration**:
|
|
203
|
-
- If user mentions old work, check archive
|
|
204
|
-
- Use `clavix archive --list` to show what's archived
|
|
205
|
-
- Offer to restore if needed
|
|
206
|
-
|
|
207
|
-
5. **Handle delete requests carefully**:
|
|
208
|
-
- Always ask if they want to delete or archive
|
|
209
|
-
- Explain that delete is permanent and irreversible
|
|
210
|
-
- Suggest archive as the safer default
|
|
211
|
-
- Use decision tree to help user decide
|
|
212
|
-
- Only proceed with `--delete` after clear confirmation
|
|
213
|
-
- Double-check it's truly no-value content (failed experiments, duplicates)
|
|
214
|
-
|
|
215
|
-
## Workflow Navigation
|
|
216
|
-
|
|
217
|
-
**You are here:** Archive (Project Cleanup)
|
|
218
|
-
|
|
219
|
-
**Common workflows:**
|
|
220
|
-
- **Complete workflow**: `/clavix:implement` → [all tasks done] → `/clavix:archive` → Clean workspace
|
|
221
|
-
- **Review and archive**: `/clavix:archive` → [select completed project] → Archive
|
|
222
|
-
- **Restore old work**: `/clavix:archive --list` → `/clavix:archive --restore [project]` → Resume
|
|
223
|
-
|
|
224
|
-
**Related commands:**
|
|
225
|
-
- `/clavix:implement` - Complete remaining tasks before archiving
|
|
226
|
-
- `/clavix:plan` - Review task completion status
|
|
227
|
-
- `/clavix:prd` - Start new project after archiving old one
|
|
228
|
-
|
|
229
|
-
## Tips
|
|
230
|
-
|
|
231
|
-
- Archive keeps your active projects list clean and focused
|
|
232
|
-
- Archived projects maintain all their data (nothing is deleted)
|
|
233
|
-
- Archive is searchable - you can still `grep` or find files in archive/
|
|
234
|
-
- Regular archiving improves `/clavix:plan` and `/clavix:implement` performance
|
|
235
|
-
- Use `--list` regularly to know what's been archived
|
|
236
|
-
|
|
237
|
-
## Troubleshooting
|
|
238
|
-
|
|
239
|
-
### Issue: No projects available to archive
|
|
240
|
-
**Cause**: No projects in `.clavix/outputs/` OR all already archived
|
|
241
|
-
**Solution**:
|
|
242
|
-
- Run `clavix archive --list` to see archived projects
|
|
243
|
-
- Check `.clavix/outputs/` for active projects
|
|
244
|
-
- If none exist, no action needed
|
|
245
|
-
|
|
246
|
-
### Issue: Trying to archive project with incomplete tasks
|
|
247
|
-
**Cause**: User wants to archive but tasks aren't 100% done
|
|
248
|
-
**Solution** (inline):
|
|
249
|
-
- Warn: "Project has X incomplete tasks. Archive anyway?"
|
|
250
|
-
- Show which tasks are incomplete
|
|
251
|
-
- Suggest `--force` flag if user confirms
|
|
252
|
-
- Recommend completing tasks first if they're actually unfinished (not scope-changed)
|
|
253
|
-
|
|
254
|
-
### Issue: Cannot restore archived project (name conflict)
|
|
255
|
-
**Cause**: Project with same name already exists in active outputs
|
|
256
|
-
**Solution**:
|
|
257
|
-
- Error: "Project '[name]' already exists in active outputs"
|
|
258
|
-
- Suggest renaming one of them
|
|
259
|
-
- Or archive the active one first, then restore
|
|
260
|
-
- Or restore to different name (if CLI supports it)
|
|
261
|
-
|
|
262
|
-
### Issue: Unsure whether to delete or archive
|
|
263
|
-
**Cause**: User wants to clean up but uncertain about permanence
|
|
264
|
-
**Solution**:
|
|
265
|
-
- Use the decision tree in template
|
|
266
|
-
- Default recommendation: ARCHIVE (safer)
|
|
267
|
-
- Only suggest delete for: duplicates, failed experiments, test data
|
|
268
|
-
- Remind: Archive is free, disk space is cheap, regret is expensive
|
|
269
|
-
|
|
270
|
-
### Issue: Accidentally deleted project (used --delete instead of archive)
|
|
271
|
-
**Cause**: User error or misunderstanding of --delete flag
|
|
272
|
-
**Solution**:
|
|
273
|
-
- Cannot be recovered from Clavix
|
|
274
|
-
- Check if git history exists (if code was committed)
|
|
275
|
-
- Check if user has backups
|
|
276
|
-
- Learn: Use archive by default, delete only when absolutely certain
|
|
277
|
-
|
|
278
|
-
### Issue: Archive directory getting too large
|
|
279
|
-
**Cause**: Many archived projects accumulating
|
|
280
|
-
**Solution**:
|
|
281
|
-
- Archive is meant to grow - this is normal
|
|
282
|
-
- Projects in archive don't affect performance
|
|
283
|
-
- If truly concerned: Review archive, delete ancient/irrelevant projects
|
|
284
|
-
- Or move very old archives to external backup storage
|
|
285
|
-
|
|
286
|
-
### Issue: Archived project but forgot what it was about
|
|
287
|
-
**Cause**: No naming convention or time passed
|
|
288
|
-
**Solution**:
|
|
289
|
-
- Read PRD in archived project: `.clavix/outputs/archive/[project]/full-prd.md`
|
|
290
|
-
- PRD contains problem, goal, and features
|
|
291
|
-
- Consider better naming conventions: date-feature format (e.g., "2024-01-user-auth")
|
|
@@ -1,207 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: "Clavix: Deep"
|
|
3
|
-
description: Full CLEAR framework analysis (C, L, E, A, R components)
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Clavix Deep Mode - Full CLEAR Framework Analysis
|
|
7
|
-
|
|
8
|
-
You are helping the user perform a comprehensive deep analysis using the full CLEAR Framework (all 5 components: Concise, Logical, Explicit, Adaptive, Reflective).
|
|
9
|
-
|
|
10
|
-
## CLEAR Framework (Deep Mode)
|
|
11
|
-
|
|
12
|
-
**What is CLEAR?**
|
|
13
|
-
An academically-validated prompt engineering framework by Dr. Leo Lo (University of New Mexico).
|
|
14
|
-
|
|
15
|
-
**Deep Mode Uses ALL Components:**
|
|
16
|
-
- **[C] Concise**: Remove verbosity, pleasantries, unnecessary words
|
|
17
|
-
- **[L] Logical**: Ensure coherent sequencing (context → requirements → constraints → output)
|
|
18
|
-
- **[E] Explicit**: Add persona, format, tone, success criteria
|
|
19
|
-
- **[A] Adaptive**: Generate alternative phrasings, structures, flexibility
|
|
20
|
-
- **[R] Reflective**: Create validation checklists, edge cases, quality criteria
|
|
21
|
-
|
|
22
|
-
## Instructions
|
|
23
|
-
|
|
24
|
-
1. Take the user's prompt: `{{ARGS}}`
|
|
25
|
-
|
|
26
|
-
2. **Apply Full CLEAR Framework** (C, L, E, A, R):
|
|
27
|
-
|
|
28
|
-
- **Conciseness [C]**: Detailed verbosity analysis
|
|
29
|
-
- **Logic [L]**: Comprehensive flow analysis
|
|
30
|
-
- **Explicitness [E]**: Complete specification check
|
|
31
|
-
- **Adaptiveness [A]**: Multiple variations and approaches
|
|
32
|
-
- **Reflectiveness [R]**: Full validation and edge case analysis
|
|
33
|
-
|
|
34
|
-
3. **Strategic Scope Detection** (before detailed analysis):
|
|
35
|
-
|
|
36
|
-
**Check for strategic concerns** by identifying keywords/themes:
|
|
37
|
-
- **Architecture**: system design, microservices, monolith, architecture patterns, scalability patterns
|
|
38
|
-
- **Security**: authentication, authorization, encryption, security, OWASP, vulnerabilities, threat model
|
|
39
|
-
- **Scalability**: load balancing, caching, database scaling, performance optimization, high availability
|
|
40
|
-
- **Infrastructure**: deployment, CI/CD, DevOps, cloud infrastructure, containers, orchestration
|
|
41
|
-
- **Business Impact**: ROI, business metrics, KPIs, stakeholder impact, market analysis
|
|
42
|
-
|
|
43
|
-
**If 3+ strategic keywords detected**:
|
|
44
|
-
Ask the user: "I notice this involves strategic decisions around [detected themes]. These topics benefit from PRD-style planning with business context and architectural considerations. Would you like to:
|
|
45
|
-
- Switch to `/clavix:prd` for comprehensive strategic planning (recommended)
|
|
46
|
-
- Continue with deep mode for prompt-level analysis only"
|
|
47
|
-
|
|
48
|
-
**If user chooses to continue**, proceed with deep analysis but remind them at the end that `/clavix:prd` is available for strategic planning.
|
|
49
|
-
|
|
50
|
-
4. **Generate Comprehensive Output**:
|
|
51
|
-
|
|
52
|
-
a. **CLEAR Assessment** (all 5 components with scores)
|
|
53
|
-
|
|
54
|
-
b. **CLEAR-Optimized Prompt** (applying all components)
|
|
55
|
-
|
|
56
|
-
c. **CLEAR Changes Made** (labeled with [C], [L], [E], [A], [R])
|
|
57
|
-
|
|
58
|
-
d. **Adaptive Variations [A]**:
|
|
59
|
-
- 2-3 alternative phrasings
|
|
60
|
-
- Alternative structures (user story, job story, structured)
|
|
61
|
-
- Temperature recommendations
|
|
62
|
-
- Explain when each approach is most appropriate
|
|
63
|
-
|
|
64
|
-
e. **Reflection Checklist [R]**:
|
|
65
|
-
- Validation steps for accuracy
|
|
66
|
-
- Edge cases to consider
|
|
67
|
-
- "What could go wrong" analysis
|
|
68
|
-
- Fact-checking steps
|
|
69
|
-
- Quality criteria
|
|
70
|
-
|
|
71
|
-
4. **CLEAR-labeled educational feedback**:
|
|
72
|
-
- Label all changes with CLEAR component tags
|
|
73
|
-
- Example: "[C] Removed 15 unnecessary pleasantries"
|
|
74
|
-
- Example: "[A] See Alternative Structures for 3 different approaches"
|
|
75
|
-
- Example: "[R] See Reflection Checklist for 5 validation steps"
|
|
76
|
-
|
|
77
|
-
5. Present everything in comprehensive, CLEAR-organized format.
|
|
78
|
-
|
|
79
|
-
## Deep Mode Features
|
|
80
|
-
|
|
81
|
-
**Include (Full CLEAR Framework):**
|
|
82
|
-
- **[C, L, E]**: All fast mode analysis (conciseness, logic, explicitness)
|
|
83
|
-
- **[A] Adaptive**: Alternative phrasings, structures, flexibility, temperature
|
|
84
|
-
- **[R] Reflective**: Validation checklist, edge cases, quality criteria, fact-checking
|
|
85
|
-
- **CLEAR Assessment**: All 5 component scores
|
|
86
|
-
- **CLEAR-labeled Changes**: Educational feedback showing which component improved what
|
|
87
|
-
|
|
88
|
-
**Do NOT include (these belong in `/clavix:prd`):**
|
|
89
|
-
- System architecture recommendations
|
|
90
|
-
- Security best practices
|
|
91
|
-
- Scalability strategy
|
|
92
|
-
- Business impact analysis
|
|
93
|
-
|
|
94
|
-
## Example
|
|
95
|
-
|
|
96
|
-
If user provides: "Create a login page"
|
|
97
|
-
|
|
98
|
-
Output:
|
|
99
|
-
```
|
|
100
|
-
## Analysis
|
|
101
|
-
[All fast mode analysis: gaps, ambiguities, strengths, suggestions]
|
|
102
|
-
|
|
103
|
-
## Changes Made
|
|
104
|
-
- Added authentication context and user needs
|
|
105
|
-
- Specified technical stack and constraints
|
|
106
|
-
- Defined success criteria and expected output
|
|
107
|
-
|
|
108
|
-
## Alternative Phrasings
|
|
109
|
-
1. "Implement a user authentication interface that enables secure access to the platform"
|
|
110
|
-
2. "Design and build a login system that validates user credentials and manages sessions"
|
|
111
|
-
3. "Create an authentication flow that allows registered users to access their accounts"
|
|
112
|
-
|
|
113
|
-
## Edge Cases to Consider
|
|
114
|
-
- What happens when a user enters incorrect credentials 3+ times?
|
|
115
|
-
- How to handle users who've forgotten both email and password?
|
|
116
|
-
- What about users trying to log in from a new device?
|
|
117
|
-
- How to handle session expiration during active use?
|
|
118
|
-
|
|
119
|
-
## Implementation Examples
|
|
120
|
-
**Good:**
|
|
121
|
-
- Prompt specifies authentication method, error handling, and accessibility requirements
|
|
122
|
-
- Includes context about existing auth system and integration points
|
|
123
|
-
- Defines measurable success criteria (load time, accessibility score)
|
|
124
|
-
|
|
125
|
-
**Bad:**
|
|
126
|
-
- "Make a login page" - no context, constraints, or success criteria
|
|
127
|
-
- Missing technical stack and integration requirements
|
|
128
|
-
- No consideration of security or user experience
|
|
129
|
-
|
|
130
|
-
## Alternative Prompt Structures
|
|
131
|
-
1. **User Story**: "As a registered user, I want to log into my account so that I can access my personalized dashboard"
|
|
132
|
-
→ Focuses on user value and benefits
|
|
133
|
-
|
|
134
|
-
2. **Job Story**: "When I visit the app, I want to authenticate securely, so I can access my saved data"
|
|
135
|
-
→ Emphasizes context and motivation
|
|
136
|
-
|
|
137
|
-
3. **Structured Sections**: Objective, Requirements, Constraints, Success Criteria
|
|
138
|
-
→ Provides comprehensive organization
|
|
139
|
-
|
|
140
|
-
## What Could Go Wrong
|
|
141
|
-
- Without security requirements, implementation might miss OWASP best practices
|
|
142
|
-
- Vague "login page" could be interpreted as OAuth, email/password, or social login
|
|
143
|
-
- Missing error handling specification could lead to poor UX
|
|
144
|
-
- No accessibility requirements might exclude users with disabilities
|
|
145
|
-
|
|
146
|
-
## Improved Prompt
|
|
147
|
-
[Structured prompt with all sections]
|
|
148
|
-
```
|
|
149
|
-
|
|
150
|
-
## When to Use Deep vs Fast vs PRD
|
|
151
|
-
|
|
152
|
-
- **Fast mode** (`/clavix:fast`): C, L, E components - quick CLEAR cleanup
|
|
153
|
-
- **Deep mode** (`/clavix:deep`): Full CLEAR (C, L, E, A, R) - comprehensive analysis with alternatives and validation
|
|
154
|
-
- **PRD mode** (`/clavix:prd`): CLEAR-validated PRD generation - strategic planning with architecture decisions
|
|
155
|
-
|
|
156
|
-
## Workflow Navigation
|
|
157
|
-
|
|
158
|
-
**You are here:** Deep Mode (Comprehensive CLEAR Analysis)
|
|
159
|
-
|
|
160
|
-
**Common workflows:**
|
|
161
|
-
- **Thorough analysis**: `/clavix:deep` → Use optimized prompt + alternatives
|
|
162
|
-
- **Escalate to strategic**: `/clavix:deep` → (detects strategic scope) → `/clavix:prd` → Plan → Implement → Archive
|
|
163
|
-
- **From fast mode**: `/clavix:fast` → (suggests) `/clavix:deep` → Full analysis with A & R components
|
|
164
|
-
|
|
165
|
-
**Related commands:**
|
|
166
|
-
- `/clavix:fast` - Quick CLEAR improvements (C, L, E only)
|
|
167
|
-
- `/clavix:prd` - Strategic PRD generation for architecture/business decisions
|
|
168
|
-
- `/clavix:start` - Conversational mode for exploring unclear requirements
|
|
169
|
-
|
|
170
|
-
## Tips
|
|
171
|
-
|
|
172
|
-
- **Apply full CLEAR framework** systematically: all 5 components
|
|
173
|
-
- Label all changes with CLEAR components for education
|
|
174
|
-
- Deep mode focuses on **prompt-level** CLEAR analysis, not strategic architecture
|
|
175
|
-
- Use **[A] Adaptive** to explore alternative approaches
|
|
176
|
-
- Use **[R] Reflective** to identify edge cases and validation needs
|
|
177
|
-
- For architecture, security, and scalability, recommend `/clavix:prd`
|
|
178
|
-
|
|
179
|
-
## Troubleshooting
|
|
180
|
-
|
|
181
|
-
### Issue: Strategic scope detected but user wants to continue with deep mode
|
|
182
|
-
**Cause**: User prefers deep analysis over PRD generation
|
|
183
|
-
**Solution**:
|
|
184
|
-
- Proceed with deep mode as requested
|
|
185
|
-
- Remind at end that `/clavix:prd` is available for strategic planning
|
|
186
|
-
- Focus on prompt-level CLEAR analysis, exclude architecture recommendations
|
|
187
|
-
|
|
188
|
-
### Issue: Too many alternative variations making output overwhelming
|
|
189
|
-
**Cause**: Adaptive component generating many options
|
|
190
|
-
**Solution**:
|
|
191
|
-
- Limit to 2-3 most distinct alternatives
|
|
192
|
-
- Focus on meaningfully different approaches (not minor wording changes)
|
|
193
|
-
- Group similar variations together
|
|
194
|
-
|
|
195
|
-
### Issue: Reflective validation finding too many edge cases
|
|
196
|
-
**Cause**: Complex prompt with many potential failure modes
|
|
197
|
-
**Solution**:
|
|
198
|
-
- Prioritize most likely or highest-impact edge cases
|
|
199
|
-
- Group related edge cases
|
|
200
|
-
- Suggest documenting all edge cases in PRD for complex projects
|
|
201
|
-
|
|
202
|
-
### Issue: Deep analysis still feels insufficient for complex project
|
|
203
|
-
**Cause**: Project needs strategic planning, not just prompt analysis
|
|
204
|
-
**Solution**:
|
|
205
|
-
- Switch to `/clavix:prd` for comprehensive planning
|
|
206
|
-
- Deep mode is for prompts, PRD mode is for projects
|
|
207
|
-
- Use PRD workflow: PRD → Plan → Implement
|
|
@@ -1,183 +0,0 @@
|
|
|
1
|
-
---
|
|
2
|
-
name: "Clavix: Fast"
|
|
3
|
-
description: CLEAR-guided quick improvements (C, L, E components)
|
|
4
|
-
---
|
|
5
|
-
|
|
6
|
-
# Clavix Fast Mode - CLEAR Framework Quick Improvement
|
|
7
|
-
|
|
8
|
-
You are helping the user improve their prompt using Clavix's fast mode, which applies the CLEAR Framework (Concise, Logical, Explicit components) with smart triage.
|
|
9
|
-
|
|
10
|
-
## CLEAR Framework (Fast Mode)
|
|
11
|
-
|
|
12
|
-
**What is CLEAR?**
|
|
13
|
-
An academically-validated prompt engineering framework by Dr. Leo Lo (University of New Mexico).
|
|
14
|
-
|
|
15
|
-
**Fast Mode Uses:**
|
|
16
|
-
- **[C] Concise**: Remove verbosity, pleasantries, unnecessary words
|
|
17
|
-
- **[L] Logical**: Ensure coherent sequencing (context → requirements → constraints → output)
|
|
18
|
-
- **[E] Explicit**: Add persona, format, tone, success criteria
|
|
19
|
-
|
|
20
|
-
**Deep Mode Adds:** [A] Adaptive variations, [R] Reflective validation (use `/clavix:deep` for these)
|
|
21
|
-
|
|
22
|
-
## Instructions
|
|
23
|
-
|
|
24
|
-
1. Take the user's prompt: `{{ARGS}}`
|
|
25
|
-
|
|
26
|
-
2. **CLEAR Analysis** - Assess the prompt using three components:
|
|
27
|
-
|
|
28
|
-
- **Conciseness [C]**: Identify verbose language, pleasantries ("please", "could you"), unnecessary qualifiers
|
|
29
|
-
- **Logic [L]**: Check sequencing and flow - is information presented coherently?
|
|
30
|
-
- **Explicitness [E]**: Verify specifications - persona, output format, tone, success criteria
|
|
31
|
-
|
|
32
|
-
3. **CLEAR-Aware Smart Triage**: Use multi-factor content-quality assessment to determine if deep analysis is needed:
|
|
33
|
-
|
|
34
|
-
**Primary Indicators** (CLEAR scores - most important):
|
|
35
|
-
- **Low CLEAR scores**: Conciseness < 60%, Logic < 60%, or Explicitness < 50%
|
|
36
|
-
|
|
37
|
-
**Secondary Indicators** (content quality):
|
|
38
|
-
- **Missing critical elements**: 3+ missing from (context, tech stack, success criteria, user needs, expected output)
|
|
39
|
-
- **Scope clarity**: Contains vague words ("app", "system", "project", "feature") without defining what/who/why
|
|
40
|
-
- **Requirement completeness**: Lacks actionable requirements or measurable outcomes
|
|
41
|
-
- **Context depth**: Extremely brief (<15 words) OR overly verbose (>100 words without structure)
|
|
42
|
-
|
|
43
|
-
**Escalation Decision**:
|
|
44
|
-
- If **Low CLEAR scores** + **2+ Secondary Indicators**: **Strongly recommend `/clavix:deep`**
|
|
45
|
-
- If **Low CLEAR scores** only: **Suggest `/clavix:deep`** but can proceed with fast mode
|
|
46
|
-
- Explain which CLEAR component needs deeper analysis and why
|
|
47
|
-
|
|
48
|
-
Ask the user:
|
|
49
|
-
- Switch to deep mode (recommended when strongly recommended)
|
|
50
|
-
- Continue with fast mode (acceptable for suggestion-level, but at their own risk for strong recommendation)
|
|
51
|
-
|
|
52
|
-
4. Generate a **CLEAR-optimized** structured prompt with these sections:
|
|
53
|
-
**Objective**: Clear, specific goal
|
|
54
|
-
**Requirements**: Detailed, actionable requirements
|
|
55
|
-
**Technical Constraints**: Technologies, performance needs, integrations
|
|
56
|
-
**Expected Output**: What the result should look like
|
|
57
|
-
**Success Criteria**: How to measure completion
|
|
58
|
-
|
|
59
|
-
5. **CLEAR Changes Made**: List improvements with CLEAR component labels:
|
|
60
|
-
- **[C]** "Removed 15 unnecessary words and pleasantries"
|
|
61
|
-
- **[L]** "Restructured: context → requirements → constraints → output"
|
|
62
|
-
- **[E]** "Added explicit persona (senior developer), output format (React component), tone (production-ready)"
|
|
63
|
-
|
|
64
|
-
6. Present the CLEAR-optimized prompt in a code block for easy copying.
|
|
65
|
-
|
|
66
|
-
## Fast Mode Features
|
|
67
|
-
|
|
68
|
-
**Include (CLEAR C, L, E):**
|
|
69
|
-
- **CLEAR Assessment** (Conciseness, Logic, Explicitness scores with issues)
|
|
70
|
-
- Single CLEAR-optimized improved prompt
|
|
71
|
-
- **CLEAR Changes Made** (labeled with [C], [L], [E] components)
|
|
72
|
-
- Recommendation to use deep mode for Adaptive & Reflective components
|
|
73
|
-
|
|
74
|
-
**Skip (use `/clavix:deep` instead):**
|
|
75
|
-
- **[A] Adaptive**: Alternative phrasings, structures, flexibility
|
|
76
|
-
- **[R] Reflective**: Validation checklists, edge cases, quality criteria
|
|
77
|
-
- Strategic analysis (architecture, security - that's for `/clavix:prd`)
|
|
78
|
-
|
|
79
|
-
## Example
|
|
80
|
-
|
|
81
|
-
If user provides: "Please could you maybe help me create a login page?"
|
|
82
|
-
|
|
83
|
-
Output:
|
|
84
|
-
```
|
|
85
|
-
## CLEAR Analysis (Fast Mode)
|
|
86
|
-
|
|
87
|
-
### CLEAR Framework Assessment:
|
|
88
|
-
|
|
89
|
-
[C] Conciseness: 45%
|
|
90
|
-
• 4 unnecessary pleasantries detected ("Please", "could you", "maybe", "help me")
|
|
91
|
-
• Low signal-to-noise ratio (core request is only 4 words)
|
|
92
|
-
|
|
93
|
-
[L] Logic: 85%
|
|
94
|
-
• Single request, coherent but minimal
|
|
95
|
-
• Suggested flow: Context → Requirements → Constraints → Output
|
|
96
|
-
|
|
97
|
-
[E] Explicitness: 25%
|
|
98
|
-
• Missing: persona, output format, tone, success criteria, technical constraints
|
|
99
|
-
• No authentication context specified
|
|
100
|
-
|
|
101
|
-
Overall CLEAR Score: 51% (needs-improvement)
|
|
102
|
-
|
|
103
|
-
Recommendation:
|
|
104
|
-
For Adaptive variations (A) and Reflective validation (R), use:
|
|
105
|
-
clavix deep "<your prompt>"
|
|
106
|
-
|
|
107
|
-
### CLEAR-Optimized Prompt:
|
|
108
|
-
|
|
109
|
-
Objective: Build a secure user authentication login page
|
|
110
|
-
|
|
111
|
-
Requirements:
|
|
112
|
-
- Email and password input fields with validation
|
|
113
|
-
- "Remember me" checkbox
|
|
114
|
-
- "Forgot password" link
|
|
115
|
-
- Clear error messages for invalid credentials
|
|
116
|
-
- Responsive design for mobile and desktop
|
|
117
|
-
|
|
118
|
-
Technical Constraints:
|
|
119
|
-
- Use React with TypeScript
|
|
120
|
-
- Integrate with existing JWT authentication API
|
|
121
|
-
- Follow WCAG 2.1 AA accessibility standards
|
|
122
|
-
|
|
123
|
-
Expected Output:
|
|
124
|
-
- Fully functional login component
|
|
125
|
-
- Unit tests with >80% coverage
|
|
126
|
-
|
|
127
|
-
Success Criteria:
|
|
128
|
-
- Users can log in successfully
|
|
129
|
-
- Invalid credentials show appropriate errors
|
|
130
|
-
- Page is accessible via keyboard navigation
|
|
131
|
-
|
|
132
|
-
### CLEAR Changes Made:
|
|
133
|
-
|
|
134
|
-
[C] Removed 4 pleasantries ("Please", "could you", "maybe", "help me"), reduced from 11 words to core intent
|
|
135
|
-
[L] Structured logical flow: Objective → Requirements → Technical Constraints → Expected Output → Success Criteria
|
|
136
|
-
[E] Added explicit specifications: React TypeScript persona, component output format, production-ready tone, accessibility criteria
|
|
137
|
-
```
|
|
138
|
-
|
|
139
|
-
## Workflow Navigation
|
|
140
|
-
|
|
141
|
-
**You are here:** Fast Mode (Quick CLEAR Improvement)
|
|
142
|
-
|
|
143
|
-
**Common workflows:**
|
|
144
|
-
- **Quick cleanup**: `/clavix:fast` → Use improved prompt
|
|
145
|
-
- **Need more depth**: `/clavix:fast` → (suggests) `/clavix:deep` → Comprehensive analysis
|
|
146
|
-
- **Strategic planning**: `/clavix:fast` → (suggests) `/clavix:prd` → Plan → Implement → Archive
|
|
147
|
-
|
|
148
|
-
**Related commands:**
|
|
149
|
-
- `/clavix:deep` - Full CLEAR analysis (all 5 components: C, L, E, A, R)
|
|
150
|
-
- `/clavix:prd` - Generate PRD for strategic planning
|
|
151
|
-
- `/clavix:start` - Conversational exploration before prompting
|
|
152
|
-
|
|
153
|
-
## Tips
|
|
154
|
-
|
|
155
|
-
- **Apply CLEAR framework** systematically: C, L, E components
|
|
156
|
-
- Use **CLEAR-aware triage** to prevent inadequate analysis
|
|
157
|
-
- Label all changes with CLEAR components for education
|
|
158
|
-
- For comprehensive analysis with [A] and [R], recommend `/clavix:deep`
|
|
159
|
-
- For strategic planning, recommend `/clavix:prd`
|
|
160
|
-
- Focus on making prompts **CLEAR** quickly
|
|
161
|
-
|
|
162
|
-
## Troubleshooting
|
|
163
|
-
|
|
164
|
-
### Issue: Triage keeps recommending deep mode
|
|
165
|
-
**Cause**: Prompt has low CLEAR scores + multiple secondary indicators
|
|
166
|
-
**Solution**:
|
|
167
|
-
- Accept the recommendation - deep mode will provide better analysis
|
|
168
|
-
- OR improve prompt manually before running fast mode again
|
|
169
|
-
- Check which CLEAR component is scoring low and address it
|
|
170
|
-
|
|
171
|
-
### Issue: Can't determine if prompt is complex enough for deep mode
|
|
172
|
-
**Cause**: Borderline CLEAR scores or unclear content quality
|
|
173
|
-
**Solution**:
|
|
174
|
-
- Err on side of fast mode first
|
|
175
|
-
- If output feels insufficient, escalate to `/clavix:deep`
|
|
176
|
-
- Use triage as guidance, not absolute rule
|
|
177
|
-
|
|
178
|
-
### Issue: Improved prompt still feels incomplete
|
|
179
|
-
**Cause**: Fast mode only applies C, L, E components
|
|
180
|
-
**Solution**:
|
|
181
|
-
- Use `/clavix:deep` for Adaptive variations and Reflective validation
|
|
182
|
-
- OR use `/clavix:prd` if strategic planning is needed
|
|
183
|
-
- Fast mode is for quick cleanup, not comprehensive analysis
|