clavix 2.8.1 → 2.8.2
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 +24 -1
- package/dist/templates/agents/agents.md +1 -0
- package/dist/templates/agents/copilot-instructions.md +1 -0
- package/dist/templates/agents/octo.md +1 -0
- package/dist/templates/agents/warp.md +1 -0
- package/dist/templates/slash-commands/_canonical/task-complete.md +188 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -46,6 +46,11 @@ clavix init
|
|
|
46
46
|
/clavix:execute # Interactive selection of saved prompts
|
|
47
47
|
/clavix:prompts # Manage prompt lifecycle
|
|
48
48
|
|
|
49
|
+
# 4. Implement with task tracking (v2.8+)
|
|
50
|
+
clavix plan # Generate tasks from PRD
|
|
51
|
+
clavix implement # Start implementation workflow
|
|
52
|
+
clavix task-complete <taskId> # Mark tasks done with auto-commit
|
|
53
|
+
|
|
49
54
|
# Or via CLI
|
|
50
55
|
clavix execute --latest
|
|
51
56
|
clavix prompts list
|
|
@@ -68,13 +73,31 @@ Clavix now automatically saves prompts from fast/deep optimization, allowing you
|
|
|
68
73
|
3. **Execute**: `/clavix:execute` or `clavix execute --latest` → Implement when ready
|
|
69
74
|
4. **Cleanup**: `clavix prompts clear --executed` → Remove completed prompts
|
|
70
75
|
|
|
76
|
+
**Prompt Saving Modes (v2.8.1 clarification):**
|
|
77
|
+
|
|
78
|
+
**CLI Usage (Auto-Save)**:
|
|
79
|
+
```bash
|
|
80
|
+
clavix fast "prompt" # Automatically saves to .clavix/outputs/prompts/fast/
|
|
81
|
+
clavix deep "prompt" # Automatically saves to .clavix/outputs/prompts/deep/
|
|
82
|
+
```
|
|
83
|
+
CLI has direct file system access – saving is automatic.
|
|
84
|
+
|
|
85
|
+
**Slash Command Usage (Agent Manual Save)**:
|
|
86
|
+
```bash
|
|
87
|
+
/clavix:fast "prompt" # Agent must follow template saving instructions
|
|
88
|
+
/clavix:deep "prompt" # Agent must follow template saving instructions
|
|
89
|
+
```
|
|
90
|
+
Slash commands run through AI agent that must use tools per template.
|
|
91
|
+
|
|
92
|
+
**Why the difference?** CLI runs directly in Node.js with file access, while slash commands require agent execution of Write tool.
|
|
93
|
+
|
|
71
94
|
**Storage hygiene:**
|
|
72
95
|
- Age warnings: >7 days = OLD, >30 days = STALE
|
|
73
96
|
- Safety confirmations before deletion
|
|
74
97
|
- Smart recommendations for cleanup
|
|
75
98
|
- Keep <20 active prompts recommended
|
|
76
99
|
|
|
77
|
-
Learn more: [Complete prompt lifecycle documentation](
|
|
100
|
+
Learn more: [Complete prompt lifecycle documentation](docs/commands/execute.md)
|
|
78
101
|
|
|
79
102
|
### Direct CLI Usage (Alternative)
|
|
80
103
|
|
|
@@ -20,6 +20,7 @@ Use these instructions when your agent can only read documentation (no slash-com
|
|
|
20
20
|
| `clavix prd` | Guided Socratic questions that generate `full-prd.md` and `quick-prd.md`. |
|
|
21
21
|
| `clavix plan` | Transform PRDs or sessions into phase-based `tasks.md`. |
|
|
22
22
|
| `clavix implement [--commit-strategy=<type>]` | Start task execution. Git strategies: per-task, per-5-tasks, per-phase, none (default: none). |
|
|
23
|
+
| `clavix task-complete <taskId>` | Mark task as completed with validation and optional git commit. Auto-displays next task. |
|
|
23
24
|
| `clavix start` | Begin conversational capture session for requirements gathering. |
|
|
24
25
|
| `clavix summarize [session-id]` | Extract mini PRD and optimized prompts from saved sessions. |
|
|
25
26
|
| `clavix list` | List sessions and/or output projects (`--sessions`, `--outputs`, filters). |
|
|
@@ -18,6 +18,7 @@ When working with this project, you can use the following Clavix commands:
|
|
|
18
18
|
- `clavix prd` - Interactive PRD generation through Socratic questioning
|
|
19
19
|
- `clavix plan` - Transform PRDs into phase-based implementation tasks
|
|
20
20
|
- `clavix implement [--commit-strategy=<type>]` - Execute tasks with progress tracking (git: per-task, per-5-tasks, per-phase, none [default])
|
|
21
|
+
- `clavix task-complete <taskId>` - Mark task as completed with validation and optional git commit
|
|
21
22
|
|
|
22
23
|
### Conversational Workflows
|
|
23
24
|
- `clavix start` - Begin conversational session for requirements gathering
|
|
@@ -270,6 +270,7 @@ When starting implementation with `clavix implement`:
|
|
|
270
270
|
| `clavix prd` | Guided questions to create PRDs. |
|
|
271
271
|
| `clavix plan` | Convert PRD artifacts into task lists. |
|
|
272
272
|
| `clavix implement [--commit-strategy=<type>]` | Start task execution (git: per-task, per-5-tasks, per-phase, none [default]). |
|
|
273
|
+
| `clavix task-complete <taskId>` | Mark task completed with validation and optional git commit. Auto-displays next task. |
|
|
273
274
|
| `clavix start` | Capture conversational requirements. |
|
|
274
275
|
| `clavix summarize` | Extract mini PRDs and prompts from sessions. |
|
|
275
276
|
| `clavix list` | List sessions or outputs (use `--sessions`, `--outputs`, `--archived`). |
|
|
@@ -17,6 +17,7 @@ Clavix helps Warp developers turn rough ideas into CLEAR, AI-ready prompts and P
|
|
|
17
17
|
- `clavix prd` – answer focused questions to create full/quick PRDs
|
|
18
18
|
- `clavix plan` – transform PRDs or sessions into task lists
|
|
19
19
|
- `clavix implement [--commit-strategy=<type>]` – execute tasks (git: per-task, per-5-tasks, per-phase, none [default])
|
|
20
|
+
- `clavix task-complete <taskId>` – mark task completed with validation and optional git commit
|
|
20
21
|
- `clavix start` – capture requirement conversations in Warp
|
|
21
22
|
- `clavix summarize [session-id]` – extract mini PRDs and optimized prompts
|
|
22
23
|
- `clavix list` – list sessions/outputs (`--sessions`, `--outputs`, `--archived`)
|
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: "Clavix: Task Complete"
|
|
3
|
+
description: Mark a task as completed with validation and optional git commit
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Clavix Task Complete - Mark Implementation Task Done
|
|
7
|
+
|
|
8
|
+
You are helping the user mark a task as completed during implementation workflow.
|
|
9
|
+
|
|
10
|
+
## Instructions
|
|
11
|
+
|
|
12
|
+
1. **Prerequisites**:
|
|
13
|
+
- User must have run `clavix implement` to start implementation
|
|
14
|
+
- `.clavix-implement-config.json` must exist in PRD folder
|
|
15
|
+
- `tasks.md` must be generated from `clavix plan`
|
|
16
|
+
|
|
17
|
+
2. **Verify the task ID**:
|
|
18
|
+
|
|
19
|
+
a. **Read tasks.md** to find the task ID:
|
|
20
|
+
- Task IDs are in format: `**phase-1-feature-1**`
|
|
21
|
+
- Located before each task description
|
|
22
|
+
- Example: `- [ ] **phase-1-auth-1** - Implement user authentication`
|
|
23
|
+
|
|
24
|
+
b. **Confirm with user** if task ID is unclear:
|
|
25
|
+
```
|
|
26
|
+
I see these incomplete tasks:
|
|
27
|
+
- phase-1-auth-1: Implement user authentication
|
|
28
|
+
- phase-1-auth-2: Add password reset flow
|
|
29
|
+
|
|
30
|
+
Which task did you complete? (or provide task ID)
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
3. **Mark task as completed**:
|
|
34
|
+
|
|
35
|
+
**Run the CLI command**:
|
|
36
|
+
```bash
|
|
37
|
+
clavix task-complete <task-id>
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
**Examples**:
|
|
41
|
+
```bash
|
|
42
|
+
clavix task-complete phase-1-auth-1
|
|
43
|
+
clavix task-complete phase-2-api-3
|
|
44
|
+
clavix task-complete setup-1
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
4. **The command will automatically**:
|
|
48
|
+
- Validate task exists in tasks.md
|
|
49
|
+
- Mark checkbox as `[x]` in tasks.md
|
|
50
|
+
- Update config file with completion tracking
|
|
51
|
+
- Show progress statistics (X/Y tasks completed)
|
|
52
|
+
- Create git commit (if strategy enabled and conditions met)
|
|
53
|
+
- Display next incomplete task
|
|
54
|
+
|
|
55
|
+
5. **Git auto-commit behavior**:
|
|
56
|
+
|
|
57
|
+
The command respects the git strategy configured in `clavix implement`:
|
|
58
|
+
|
|
59
|
+
- **`none`** (default): No automatic commits
|
|
60
|
+
- **`per-task`**: Creates commit after this completion
|
|
61
|
+
- **`per-5-tasks`**: Creates commit if 5 tasks completed (modulo 5 == 0)
|
|
62
|
+
- **`per-phase`**: Creates commit if all tasks in current phase are done
|
|
63
|
+
|
|
64
|
+
**Override for specific task**:
|
|
65
|
+
```bash
|
|
66
|
+
clavix task-complete phase-1-auth-1 --no-git
|
|
67
|
+
```
|
|
68
|
+
Skips git commit even if strategy is enabled (useful for experimental changes).
|
|
69
|
+
|
|
70
|
+
6. **Handle command output**:
|
|
71
|
+
|
|
72
|
+
a. **Success case**:
|
|
73
|
+
```
|
|
74
|
+
✓ Task marked as completed
|
|
75
|
+
✓ Configuration updated
|
|
76
|
+
|
|
77
|
+
Progress:
|
|
78
|
+
Completed: 5/20 tasks (25%)
|
|
79
|
+
Remaining: 15 tasks
|
|
80
|
+
|
|
81
|
+
Next Task:
|
|
82
|
+
ID: phase-1-auth-2
|
|
83
|
+
Add password reset flow
|
|
84
|
+
Reference: Full PRD section "Authentication > Password Reset"
|
|
85
|
+
```
|
|
86
|
+
|
|
87
|
+
b. **Already completed case**:
|
|
88
|
+
```
|
|
89
|
+
⚠ Task "phase-1-auth-1" is already marked as completed
|
|
90
|
+
|
|
91
|
+
Use --force to re-mark this task as completed.
|
|
92
|
+
|
|
93
|
+
Next Task:
|
|
94
|
+
ID: phase-1-auth-2
|
|
95
|
+
...
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
c. **All tasks complete**:
|
|
99
|
+
```
|
|
100
|
+
✓ Task marked as completed
|
|
101
|
+
🎉 All tasks completed!
|
|
102
|
+
|
|
103
|
+
Great work! All implementation tasks are done.
|
|
104
|
+
|
|
105
|
+
Hint: Run "clavix archive" to archive this project
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
7. **After task completion**:
|
|
109
|
+
|
|
110
|
+
a. **If more tasks remaining**:
|
|
111
|
+
- Acknowledge the completion
|
|
112
|
+
- Ask user: "Ready to start the next task? [display next task description]"
|
|
113
|
+
- Or: "Would you like to implement the next task now?"
|
|
114
|
+
|
|
115
|
+
b. **If all tasks complete**:
|
|
116
|
+
- Congratulate the user
|
|
117
|
+
- Suggest running `clavix archive` to archive the project
|
|
118
|
+
- Ask if they want to create a final git commit or tag
|
|
119
|
+
|
|
120
|
+
8. **Error recovery**:
|
|
121
|
+
|
|
122
|
+
**If task ID not found**:
|
|
123
|
+
```
|
|
124
|
+
✗ Task ID "phase-1-invalid" not found
|
|
125
|
+
|
|
126
|
+
Available task IDs:
|
|
127
|
+
Phase 1: Authentication
|
|
128
|
+
[ ] phase-1-auth-1 - Implement user authentication
|
|
129
|
+
[ ] phase-1-auth-2 - Add password reset flow
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
- The command lists all available tasks
|
|
133
|
+
- Ask user to verify task ID
|
|
134
|
+
- Or ask which task they meant to complete
|
|
135
|
+
|
|
136
|
+
**If config file not found**:
|
|
137
|
+
```
|
|
138
|
+
No config files found.
|
|
139
|
+
|
|
140
|
+
Hint: Run "clavix implement" first to initialize
|
|
141
|
+
```
|
|
142
|
+
|
|
143
|
+
- Tell user to run `clavix implement` first
|
|
144
|
+
- This starts the implementation workflow
|
|
145
|
+
|
|
146
|
+
**If file write error**:
|
|
147
|
+
```
|
|
148
|
+
✗ Failed to mark task as completed
|
|
149
|
+
|
|
150
|
+
Recovery Options:
|
|
151
|
+
1. Check if tasks.md file is readable and writable
|
|
152
|
+
2. Verify task ID matches exactly
|
|
153
|
+
3. Try running with --force flag
|
|
154
|
+
4. Check tasks.md.backup file if created
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
- Follow recovery suggestions
|
|
158
|
+
- Check file permissions
|
|
159
|
+
- Ask user if they manually edited tasks.md
|
|
160
|
+
|
|
161
|
+
## Command Flags
|
|
162
|
+
|
|
163
|
+
- `--no-git`: Skip git commit even if strategy is enabled
|
|
164
|
+
- `-f, --force`: Force completion even if already marked complete
|
|
165
|
+
- `-c, --config <path>`: Specify custom config file path (defaults to auto-discover)
|
|
166
|
+
|
|
167
|
+
## Best Practices
|
|
168
|
+
|
|
169
|
+
1. **Never manually edit tasks.md checkboxes** - Always use `clavix task-complete`
|
|
170
|
+
2. **Verify task completion** - Ensure implementation is done before marking
|
|
171
|
+
3. **Use --no-git for experiments** - Skip commits for work-in-progress changes
|
|
172
|
+
4. **Check next task** - Command automatically shows what to work on next
|
|
173
|
+
5. **Track progress** - Use progress stats to estimate remaining work
|
|
174
|
+
|
|
175
|
+
## Related Commands
|
|
176
|
+
|
|
177
|
+
- `clavix implement` - Start implementation workflow (shows current task)
|
|
178
|
+
- `clavix plan` - Generate tasks.md from PRD
|
|
179
|
+
- `clavix archive` - Archive completed project (run after all tasks done)
|
|
180
|
+
|
|
181
|
+
## Next Steps
|
|
182
|
+
|
|
183
|
+
After completing all tasks:
|
|
184
|
+
1. Run `clavix archive` to archive the implementation
|
|
185
|
+
2. Create final git commit or tag
|
|
186
|
+
3. Update CHANGELOG if needed
|
|
187
|
+
4. Merge feature branch
|
|
188
|
+
5. Deploy or release
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "clavix",
|
|
3
|
-
"version": "2.8.
|
|
3
|
+
"version": "2.8.2",
|
|
4
4
|
"description": "Transform vague ideas into production-ready prompts. AI agent tool with CLI interface using the CLEAR framework to analyze, improve, and generate PRDs for AI coding assistants (Claude Code, Cursor, Windsurf, and more)",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|