clavix 6.1.0 → 6.1.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 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 21 AI coding tools.
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, GitHub Copilot, and many AI coding tools.
4
4
 
5
5
  ## Quick Links
6
6
 
@@ -19,7 +19,7 @@
19
19
  | Tool Type | Format | Example |
20
20
  |-----------|--------|---------|
21
21
  | **CLI tools** (Claude Code, Gemini, Qwen) | Colon (`:`) | `/clavix:improve` |
22
- | **IDE extensions** (Cursor, Windsurf, Cline) | Hyphen (`-`) | `/clavix-improve` |
22
+ | **IDEs & extensions** (Cursor, Windsurf, Cline, GitHub Copilot) | Hyphen (`-`) | `/clavix-improve` |
23
23
 
24
24
  **Rule of thumb:** CLI tools use colon, IDE extensions use hyphen.
25
25
 
@@ -32,13 +32,19 @@ npm install -g clavix
32
32
  clavix init
33
33
  ```
34
34
 
35
+ During `clavix init`, pick your AI tools (Cursor, Claude Code, GitHub Copilot, etc.). Clavix installs slash command templates into those integrations.
36
+
35
37
  ### 2. Use Slash Commands
36
38
 
37
- ```
39
+ ```text
40
+ # CLI-style tools (Claude Code, Gemini, Qwen)
38
41
  /clavix:improve "Create a secure login page with JWT"
42
+
43
+ # IDE-style tools (Cursor, Windsurf, GitHub Copilot, etc.)
44
+ /clavix-improve "Create a secure login page with JWT"
39
45
  ```
40
46
 
41
- The AI agent reads the template and optimizes your prompt.
47
+ The AI agent reads the Clavix template and optimizes your prompt.
42
48
 
43
49
  ### 3. Choose Your Workflow
44
50
 
@@ -79,7 +85,7 @@ Have a conversation to explore requirements, then extract and plan.
79
85
  ```
80
86
  Refine existing PRDs or prompts based on feedback.
81
87
 
82
- ### All 9 Slash Commands
88
+ ### All 10 Slash Commands
83
89
 
84
90
  | Command | Purpose |
85
91
  |---------|---------|
@@ -91,21 +97,24 @@ Refine existing PRDs or prompts based on feedback.
91
97
  | `/clavix:summarize` | Extract requirements from conversation |
92
98
  | `/clavix:refine` | Refine existing PRD or prompt |
93
99
  | `/clavix:verify` | Verify implementation against requirements |
100
+ | `/clavix:review` | Review teammate PRs using criteria presets |
94
101
  | `/clavix:archive` | Archive completed projects |
95
102
 
96
- See [Getting Started](docs/getting-started.md) for the full guide.
103
+ `/clavix:review` is for reviewing teammates' PRs (criteria-driven, severity levels, saved reports), while `/clavix:verify` checks your implementation against your own PRD.
104
+
105
+ For a full walkthrough, see [Getting Started](docs/getting-started.md).
97
106
 
98
107
  ## How It Works
99
108
 
100
109
  Clavix is **agentic-first**:
101
110
 
102
- 1. **You run `clavix init`** - Sets up slash command templates
103
- 2. **You invoke a slash command** - Like `/clavix:improve`
104
- 3. **AI agent reads the template** - Markdown instructions
105
- 4. **Agent follows instructions** - Using its native tools
106
- 5. **Output is saved** - To `.clavix/outputs/`
111
+ 1. **You run `clavix init`** Select integrations (Cursor, Claude Code, GitHub Copilot, etc.). Clavix installs markdown templates into each tool (e.g. `.cursor/commands/`, `.github/prompts/clavix-*.prompt.md`).
112
+ 2. **You invoke a slash command** Like `/clavix:improve`, `/clavix:plan`, or `/clavix:review` in your AI tool.
113
+ 3. **The AI agent reads the template** Structured markdown instructions with frontmatter.
114
+ 4. **The agent follows the instructions** Using its native tools (edit files, run tests, summarize, review PRs, etc.).
115
+ 5. **Outputs are saved locally** Under `.clavix/outputs/` (including `.clavix/outputs/reviews/` for PR review reports).
107
116
 
108
- **No TypeScript executes during slash commands.** The markdown templates ARE the product.
117
+ **No TypeScript executes during slash commands.** The markdown templates ARE the product; Clavix only installs and updates them.
109
118
 
110
119
  See [Architecture](docs/architecture.md) for details.
111
120
 
@@ -113,9 +122,11 @@ See [Architecture](docs/architecture.md) for details.
113
122
 
114
123
  | Category | Tools |
115
124
  |----------|-------|
116
- | IDE extensions | Cursor, Windsurf, Kilocode, Roocode, Cline |
125
+ | IDEs & extensions | Cursor, Windsurf, Kilocode, Roocode, Cline, GitHub Copilot (VS Code) |
117
126
  | CLI agents | Claude Code, Gemini CLI, Qwen Code, Droid CLI, CodeBuddy, OpenCode, LLXPRT, Amp, Crush CLI, Codex CLI, Augment CLI, Vibe CLI |
118
- | Universal | AGENTS.md, GitHub Copilot, OCTO.md, WARP.md |
127
+ | Universal formats | AGENTS.md, OCTO.md, WARP.md |
128
+
129
+ In GitHub Copilot Chat, Clavix commands appear as `/clavix-improve`, `/clavix-prd`, `/clavix-review`, etc.
119
130
 
120
131
  Full list: [docs/integrations.md](docs/integrations.md)
121
132
 
@@ -123,12 +134,12 @@ Full list: [docs/integrations.md](docs/integrations.md)
123
134
 
124
135
  | Command | Purpose |
125
136
  |---------|---------|
126
- | `clavix init` | Initialize Clavix in a project |
127
- | `clavix update` | Regenerate templates |
128
- | `clavix diagnose` | Check installation |
137
+ | `clavix init` | Initialize or reconfigure Clavix integrations in a project |
138
+ | `clavix update` | Regenerate templates for selected integrations |
139
+ | `clavix diagnose` | Check installation and integration health |
129
140
  | `clavix version` | Show version |
130
141
 
131
- All workflows (`/clavix:improve`, etc.) are **slash commands** that AI agents execute.
142
+ All workflows (`/clavix:improve`, `/clavix:plan`, `/clavix:review`, etc.) are **slash commands** that your AI tools execute using Clavix templates.
132
143
 
133
144
  ## Documentation
134
145
 
@@ -142,7 +153,7 @@ All workflows (`/clavix:improve`, etc.) are **slash commands** that AI agents ex
142
153
 
143
154
  - **Node.js >= 18.0.0**
144
155
  - npm or yarn
145
- - An AI coding tool (Claude Code, Cursor, etc.)
156
+ - An AI coding tool (Claude Code, Cursor, GitHub Copilot, etc.)
146
157
 
147
158
  ## License
148
159
 
@@ -274,7 +274,7 @@ Result: Project permanently deleted
274
274
 
275
275
  ---
276
276
 
277
- ## Agent Transparency (v6.1.0)
277
+ ## Agent Transparency (v6.1.2)
278
278
 
279
279
  ### Agent Manual (Universal Protocols)
280
280
  {{INCLUDE:agent-protocols/AGENT_MANUAL.md}}
@@ -615,7 +615,7 @@ I'll explain what's wrong and what you might need to do:
615
615
 
616
616
  ---
617
617
 
618
- ## Agent Transparency (v6.1.0)
618
+ ## Agent Transparency (v6.1.2)
619
619
 
620
620
  ### Agent Manual (Universal Protocols)
621
621
  {{INCLUDE:agent-protocols/AGENT_MANUAL.md}}
@@ -380,7 +380,7 @@ This is a BLOCKING checkpoint. You cannot proceed to the final message until sav
380
380
  | Step | Action | Tool to Use | Verification |
381
381
  |------|--------|-------------|--------------|
382
382
  | 1 | Create directory | Write tool (create parent dirs) | Directory exists |
383
- | 2 | Generate prompt ID | Format: `{std\|comp}-YYYYMMDD-HHMMSS-<random>` | ID is unique |
383
+ | 2 | Generate prompt ID | Format: `{std\\|comp}-YYYYMMDD-HHMMSS-<random>` | ID is unique |
384
384
  | 3 | Write prompt file with frontmatter | **Write tool** | File created |
385
385
  | 4 | **VERIFY: Read back file** | **Read tool** | File readable |
386
386
 
@@ -524,7 +524,7 @@ Wait for the user to decide what to do next.
524
524
 
525
525
  ---
526
526
 
527
- ## Agent Transparency (v6.1.0)
527
+ ## Agent Transparency (v6.1.2)
528
528
 
529
529
  ### Agent Manual (Universal Protocols)
530
530
  {{INCLUDE:agent-protocols/AGENT_MANUAL.md}}
@@ -229,7 +229,7 @@ Present the plan and ask:
229
229
 
230
230
  ---
231
231
 
232
- ## Agent Transparency (v6.1.0)
232
+ ## Agent Transparency (v6.1.2)
233
233
 
234
234
  ### Agent Manual (Universal Protocols)
235
235
  {{INCLUDE:agent-protocols/AGENT_MANUAL.md}}
@@ -354,7 +354,7 @@ The validation ensures generated PRDs are immediately usable for AI consumption
354
354
 
355
355
  ---
356
356
 
357
- ## Agent Transparency (v6.1.0)
357
+ ## Agent Transparency (v6.1.2)
358
358
 
359
359
  ### Agent Manual (Universal Protocols)
360
360
  {{INCLUDE:agent-protocols/AGENT_MANUAL.md}}
@@ -415,7 +415,7 @@ I'll update the PRD and add this to the refinement history. Confirm?
415
415
 
416
416
  ---
417
417
 
418
- ## Agent Transparency (v6.1.0)
418
+ ## Agent Transparency (v6.1.2)
419
419
 
420
420
  ### Agent Manual (Universal Protocols)
421
421
  {{INCLUDE:agent-protocols/AGENT_MANUAL.md}}
@@ -447,7 +447,7 @@ consistent with the project's conventions.
447
447
 
448
448
  ---
449
449
 
450
- ## Agent Transparency (v6.1.0)
450
+ ## Agent Transparency (v6.1.2)
451
451
 
452
452
  ### Agent Manual (Universal Protocols)
453
453
  {{INCLUDE:agent-protocols/AGENT_MANUAL.md}}
@@ -230,7 +230,7 @@ The goal is natural exploration of requirements, not a rigid questionnaire. Foll
230
230
 
231
231
  ---
232
232
 
233
- ## Agent Transparency (v6.1.0)
233
+ ## Agent Transparency (v6.1.2)
234
234
 
235
235
  ### Agent Manual (Universal Protocols)
236
236
  {{INCLUDE:agent-protocols/AGENT_MANUAL.md}}
@@ -409,7 +409,7 @@ The `/clavix:summarize` command extracts requirements from exploratory conversat
409
409
 
410
410
  ---
411
411
 
412
- ## Agent Transparency (v6.1.0)
412
+ ## Agent Transparency (v6.1.2)
413
413
 
414
414
  ### Agent Manual (Universal Protocols)
415
415
  {{INCLUDE:agent-protocols/AGENT_MANUAL.md}}
@@ -123,7 +123,7 @@ Implementation: BLOCKED - I'll analyze and report, not modify or fix
123
123
 
124
124
  ----
125
125
 
126
- ## Agent Transparency (v6.1.0)
126
+ ## Agent Transparency (v6.1.2)
127
127
 
128
128
  ### Agent Manual (Universal Protocols)
129
129
  {{INCLUDE:agent-protocols/AGENT_MANUAL.md}}
@@ -214,7 +214,7 @@ BEFORE completing response:
214
214
  ## What You Should NEVER Do
215
215
 
216
216
  ❌ **Don't silently skip tasks** - Always tell user if something was skipped
217
- ❌ **Don't make assumptions** - When in doubt, ask
217
+ ❌ **Don't make assumptions** - When in doubt, use the AskUserQuestion tool
218
218
  ❌ **Don't give up too easily** - Try to recover first
219
219
  ❌ **Don't overwhelm with options** - Max 3 choices
220
220
  ❌ **Don't use technical language** - Keep it friendly
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "clavix",
3
- "version": "6.1.0",
3
+ "version": "6.1.2",
4
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:review Review teammate PRs with criteria\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",