knowzcode 0.3.6 → 0.4.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.
Files changed (79) hide show
  1. package/.claude-plugin/marketplace.json +61 -61
  2. package/.claude-plugin/plugin.json +8 -8
  3. package/LICENSE +121 -121
  4. package/README.md +354 -320
  5. package/agents/analyst.md +114 -114
  6. package/agents/architect.md +200 -200
  7. package/agents/builder.md +104 -104
  8. package/agents/closer.md +177 -95
  9. package/agents/context-scout.md +54 -54
  10. package/agents/knowledge-migrator.md +349 -349
  11. package/agents/knowz-scout.md +83 -83
  12. package/agents/knowz-scribe.md +180 -180
  13. package/agents/microfix-specialist.md +135 -135
  14. package/agents/project-advisor.md +111 -111
  15. package/agents/reviewer.md +172 -172
  16. package/agents/security-officer.md +194 -194
  17. package/agents/test-advisor.md +162 -162
  18. package/agents/update-coordinator.md +394 -394
  19. package/bin/knowzcode.mjs +1199 -956
  20. package/commands/audit.md +328 -328
  21. package/commands/connect-mcp.md +549 -549
  22. package/commands/fix.md +107 -107
  23. package/commands/init.md +500 -439
  24. package/commands/learn.md +332 -332
  25. package/commands/plan.md +272 -272
  26. package/commands/register.md +733 -733
  27. package/commands/status.md +309 -309
  28. package/commands/telemetry-setup.md +368 -368
  29. package/commands/telemetry.md +188 -188
  30. package/commands/work.md +1204 -1170
  31. package/knowzcode/automation_manifest.md +59 -59
  32. package/knowzcode/claude_code_execution.md +431 -420
  33. package/knowzcode/copilot_execution.md +231 -231
  34. package/knowzcode/enterprise/compliance_manifest.md +137 -137
  35. package/knowzcode/enterprise/compliance_status.md +30 -30
  36. package/knowzcode/enterprise/guidelines/code-quality.md +67 -67
  37. package/knowzcode/enterprise/guidelines/security.md +355 -355
  38. package/knowzcode/enterprise/templates/guideline-template.md +55 -55
  39. package/knowzcode/gitignore.template +13 -13
  40. package/knowzcode/knowzcode_architecture.md +51 -51
  41. package/knowzcode/knowzcode_log.md +142 -142
  42. package/knowzcode/knowzcode_loop.md +596 -593
  43. package/knowzcode/knowzcode_orchestration.md +66 -66
  44. package/knowzcode/knowzcode_project.md +48 -48
  45. package/knowzcode/knowzcode_tracker.md +40 -40
  46. package/knowzcode/knowzcode_vaults.md +257 -257
  47. package/knowzcode/mcp_config.md +191 -191
  48. package/knowzcode/planning/Readme.md +6 -6
  49. package/knowzcode/platform_adapters.md +1260 -1047
  50. package/knowzcode/prompts/Execute_Micro_Fix.md +57 -57
  51. package/knowzcode/prompts/Investigate_Codebase.md +227 -227
  52. package/knowzcode/prompts/Migrate_Knowledge.md +301 -301
  53. package/knowzcode/prompts/Refactor_Node.md +72 -72
  54. package/knowzcode/prompts/Spec_Verification_Checkpoint.md +59 -59
  55. package/knowzcode/prompts/[LOOP_1A]__Propose_Change_Set.md +52 -52
  56. package/knowzcode/prompts/[LOOP_1B]__Draft_Specs.md +75 -75
  57. package/knowzcode/prompts/[LOOP_2A]__Implement_Change_Set.md +55 -55
  58. package/knowzcode/prompts/[LOOP_2B]__Verify_Implementation.md +72 -72
  59. package/knowzcode/prompts/[LOOP_3]__Finalize_And_Commit.md +67 -67
  60. package/knowzcode/specs/Readme.md +10 -10
  61. package/knowzcode/telemetry_config.md +89 -89
  62. package/knowzcode/user_preferences.md +120 -120
  63. package/package.json +53 -53
  64. package/skills/alias-resolver.json +15 -15
  65. package/skills/architecture-diff.json +12 -12
  66. package/skills/check-installation-status.json +14 -14
  67. package/skills/continue.md +126 -126
  68. package/skills/environment-guard.json +12 -12
  69. package/skills/generate-workgroup-id.json +25 -25
  70. package/skills/install-knowzcode.json +21 -21
  71. package/skills/load-core-context.json +18 -18
  72. package/skills/log-entry-builder.json +15 -15
  73. package/skills/spec-quality-check.json +14 -14
  74. package/skills/spec-template.json +15 -15
  75. package/skills/spec-validator.json +25 -25
  76. package/skills/start-work.md +224 -224
  77. package/skills/tracker-scan.json +12 -12
  78. package/skills/tracker-update.json +28 -28
  79. package/skills/validate-installation.json +14 -14
package/README.md CHANGED
@@ -1,320 +1,354 @@
1
- # KnowzCode
2
-
3
- <div align="center">
4
-
5
- **A structured development methodology for AI coding assistants.**
6
-
7
- [![License: MIT + Commons Clause](https://img.shields.io/badge/License-MIT_+_Commons_Clause-yellow.svg)](LICENSE)
8
- [![Claude Code Plugin](https://img.shields.io/badge/Claude_Code-Plugin-purple)](https://github.com/knowz-io/knowzcode)
9
- [![Version](https://img.shields.io/badge/version-0.3.6-blue)](https://github.com/knowz-io/knowzcode/releases)
10
-
11
- [Installation](#installation) · [Quick Start](#quick-start) · [When to Use It](#when-to-use-knowzcode) · [How It Works](#how-it-works) · [Commands](#commands) · [Docs](#documentation)
12
-
13
- </div>
14
-
15
- ---
16
-
17
- ## The Problem
18
-
19
- AI coding assistants lack structure. Without it, they:
20
- - Forget context between sessions
21
- - Make changes without considering impact
22
- - Declare "done" without verifying anything works
23
- - Let documentation drift from reality immediately
24
-
25
- ## What KnowzCode Does
26
-
27
- KnowzCode is a **platform-agnostic development methodology** that lives in your project's `knowzcode/` directory.
28
-
29
- - **Adaptive Development Loop** — Scales from quick fixes to full 5-phase TDD workflows with quality gates at each phase
30
- - **Quality Gates** — Automated verification at each phase prevents broken code from advancing
31
- - **Living Documentation** — Architecture diagrams and specs auto-update as code changes
32
- - **Session Memory** — WorkGroups track complete context so nothing is lost between sessions
33
- - **Interruption Recovery** — Say "continue" to resume exactly where you left off
34
- - **Multi-Platform** — Works with Claude Code, Codex, Gemini, Cursor, Copilot, and Windsurf
35
-
36
- ## When to Use KnowzCode
37
-
38
- KnowzCode adds overhead — more time, more tokens, more structure than letting your coding agent plan and execute natively. That's the tradeoff. Here's when it's worth it:
39
-
40
- **Your agent's native mode is fine for:**
41
- - Single-file changes, bug fixes, small refactors
42
- - Tasks where "good enough" is good enough
43
- - Anything you can verify at a glance
44
-
45
- **Reach for KnowzCode when:**
46
- - **Outcomes aren't meeting expectations** — the agent keeps missing edge cases, breaking things, or delivering incomplete work
47
- - **Multi-component changes** — features that touch multiple layers (API + DB + UI + tests) benefit from impact analysis and phased execution
48
- - **Architecture and security matter** — quality gates catch issues before they compound
49
- - **You need documentation that stays current** — specs and architecture docs update as part of the workflow, not as an afterthought
50
- - **Enforcing standards** — personal conventions, team guidelines, or enterprise compliance rules baked into every phase
51
- - **Resumability** — long-running work that spans sessions, where losing context means starting over
52
- - **Autonomous execution** — approve specs upfront, then let the agent run; verification loops and quality gates keep output on track without constant oversight
53
-
54
- The overhead pays for itself when the cost of getting it wrong exceeds the cost of being thorough.
55
-
56
- ## How It Works
57
-
58
- Every feature follows a structured loop with quality gates between phases:
59
-
60
- ```
61
- ┌──────────────────── THE KNOWZCODE LOOP ────────────────────┐
62
- │ │
63
- │ Goal → Analyze → ✓ → Design → ✓ → Build → Audit → ✓ → Ship │
64
- │ Impact Specs (TDD) Quality │
65
- │ 1A 1B 2A 2B 3 │
66
- │ │
67
- │ ✓ = approval gate (you decide whether to proceed) │
68
- └─────────────────────────────────────────────────────────────┘
69
- ```
70
-
71
- KnowzCode automatically classifies tasks by complexity:
72
- - **Micro** — single-file fixes skip the loop entirely (`/kc:fix`)
73
- - **Light** — small changes (≤3 files) use a streamlined 2-phase path
74
- - **Full** — complex features get the complete 5-phase workflow above
75
-
76
- Each gate requires your approval before proceeding. See the [Workflow Reference](./docs/workflow-reference.md) for details.
77
-
78
- ## Installation
79
-
80
- ### Claude Code (Recommended)
81
-
82
- ```bash
83
- /plugin marketplace add knowz-io/knowzcode
84
- /plugin install kc@knowzcode
85
- cd your-project/
86
- /kc:init
87
- /kc:work "Build user authentication"
88
- ```
89
-
90
- ### Alternative: Script Install
91
-
92
- ```bash
93
- npx knowzcode # Interactive setup
94
- npx knowzcode install --platforms claude,cursor # Specific platforms
95
- npx knowzcode install --platforms all # All 6 platforms
96
- ```
97
-
98
- Commands available as `/work`, `/plan`, `/fix` (without `kc:` prefix).
99
- For `/kc:` prefix, also run: `/plugin install kc@knowzcode`.
100
-
101
- <details>
102
- <summary><strong>Supported Platforms (6)</strong></summary>
103
-
104
- | Platform | Instruction File | Support Level |
105
- |----------|-----------------|---------------|
106
- | Claude Code | `CLAUDE.md` | Full support (plugin + agents + commands) |
107
- | Gemini CLI | `GEMINI.md` + `.gemini/commands/kc/*.toml` | Native `/kc:` commands + instruction file |
108
- | OpenAI Codex | `AGENTS.md` | Instruction file + SKILL.md format |
109
- | Cursor | `.cursor/rules/*.mdc` + `.cursor/commands/*.md` | Rules + commands (beta) |
110
- | GitHub Copilot | `.github/copilot-instructions.md` + `.github/prompts/kc-*.prompt.md` | Full support (instructions + 9 prompt files + MCP) |
111
- | Windsurf | `.windsurf/rules/*.md` + `.windsurf/workflows/*.md` | Rules + workflows |
112
-
113
- </details>
114
-
115
- ### Manual (No Node.js)
116
-
117
- ```bash
118
- git clone https://github.com/knowz-io/knowzcode.git
119
- cd KnowzCode
120
- ./install.sh --target /path/to/your/project # Linux/macOS
121
- .\install.ps1 -Target C:\path\to\your\project # Windows
122
- ```
123
-
124
- ### Cloud Features (Optional)
125
-
126
- Connect to KnowzCode Cloud for vector-powered semantic search, AI Q&A, and learning capture via MCP. See the [Getting Started Guide](./docs/knowzcode_getting_started.md#mcp-integration-cloud-features) for setup.
127
-
128
- ## Quick Start
129
-
130
- ### Start a Feature
131
-
132
- ```bash
133
- /kc:work "Build user authentication with email and password"
134
- ```
135
-
136
- Runs the full loop: impact analysis → specs → TDD → audit → finalize, with approval gates between each phase.
137
-
138
- ### Research First
139
-
140
- ```bash
141
- /kc:plan "how is authentication implemented?"
142
- ```
143
-
144
- Explores your codebase first. Say "implement" to transition into `/kc:work` with findings pre-loaded.
145
-
146
- ### Quick Fix
147
-
148
- ```bash
149
- /kc:fix "Fix typo in login button text"
150
- ```
151
-
152
- Targeted fixes that skip the full loop — for typos, small bugs, and CSS tweaks.
153
-
154
- ## Commands
155
-
156
- | Command | Description |
157
- |:--------|:------------|
158
- | `/kc:init` | Initialize KnowzCode in project |
159
- | `/kc:work <goal>` | Start feature workflow |
160
- | `/kc:plan <topic>` | Research before implementing |
161
- | `/kc:audit [type]` | Run quality audits |
162
- | `/kc:fix <target>` | Quick targeted fix |
163
- | `/kc:connect-mcp` | Configure MCP server |
164
- | `/kc:register` | Register and configure MCP |
165
- | `/kc:status` | Check MCP connection |
166
- | `/kc:learn` | Capture learnings to vault |
167
- | `/kc:telemetry` | Investigate production telemetry |
168
- | `/kc:telemetry-setup` | Configure telemetry sources |
169
-
170
- ## Architecture
171
-
172
- ```
173
- Layer 4: Platform Enhancements (optional, best experience)
174
- Claude Code agents | Codex Agents SDK | Gemini Skills
175
- ──────────────────────────────────────────────────────
176
- Layer 3: Platform Adapters (thin instruction files)
177
- CLAUDE.md | AGENTS.md | GEMINI.md | .cursor/rules/*.mdc
178
- ──────────────────────────────────────────────────────
179
- Layer 2: MCP Integration (cross-platform knowledge layer)
180
- KnowzCode MCP server → vaults, search, learning capture
181
- ──────────────────────────────────────────────────────
182
- Layer 1: Core Methodology (platform-agnostic, the actual product)
183
- knowzcode/ directory → loop, specs, tracker, architecture
184
- ```
185
-
186
- The real product is Layer 1 — the `knowzcode/` directory. Everything else enhances it.
187
- On Claude Code, Layer 4 provides 14 specialized agents (11 core + 3 opt-in specialists) with parallel orchestration.
188
- On other platforms, the AI follows the same methodology directly.
189
- See [Understanding KnowzCode](./docs/understanding-knowzcode.md) for a deep dive.
190
-
191
- ## Execution Modes
192
-
193
- ### Claude Code
194
-
195
- When using Claude Code, `/kc:work` automatically selects an execution strategy based on task complexity and available features:
196
-
197
- | Mode | When Used | How It Works |
198
- |------|-----------|-------------|
199
- | **Parallel Teams** | Complex features (default for >3 files) | Multiple agents work concurrently — scouts gather context, builders implement in parallel, reviewer audits incrementally |
200
- | **Sequential Teams** | Lighter features or `--sequential` flag | One agent per phase with persistent team context |
201
- | **Subagent Delegation** | Agent Teams not enabled | One agent spawned per phase via fallback works on all Claude Code instances |
202
-
203
- <details>
204
- <summary><strong>Agent Teams Setup & Roster (14 agents)</strong></summary>
205
-
206
- Parallel and Sequential Teams require [Agent Teams (experimental)](https://code.claude.com/docs/en/agent-teams). Enable by adding the following to your Claude Code `settings.json`:
207
-
208
- ```json
209
- { "env": { "CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS": "1" } }
210
- ```
211
-
212
- Or ask Claude Code: _"Enable Agent Teams in my settings."_ Then restart. Without it, subagent delegation is used automatically.
213
-
214
- | Agent | Role | Phase |
215
- |-------|------|-------|
216
- | `context-scout` | Local context research (specs, tracker, history) | Discovery |
217
- | `knowz-scout` | MCP vault research (conventions, decisions) | Discovery |
218
- | `knowz-scribe` | MCP vault writes (learning capture, audit trails) | All phases |
219
- | `analyst` | Impact analysis, Change Set proposals | 1A |
220
- | `architect` | Specification drafting, architecture review | 1B |
221
- | `builder` | TDD implementation, verification loops | 2A |
222
- | `reviewer` | Quality audit, security review | 2B |
223
- | `closer` | Finalization, learning capture | 3 |
224
- | `security-officer` | Threat modeling, vulnerability scanning (opt-in) | All phases |
225
- | `test-advisor` | TDD enforcement, test quality review (opt-in) | All phases |
226
- | `project-advisor` | Backlog curation, future work ideas (opt-in) | Discovery–2A |
227
- | `microfix-specialist` | Quick targeted fixes | Utility |
228
- | `knowledge-migrator` | Knowledge migration between vaults | Utility |
229
- | `update-coordinator` | Plugin update coordination | Utility |
230
-
231
- </details>
232
-
233
- <details>
234
- <summary><strong>Opt-in Specialist Agents</strong></summary>
235
-
236
- Activate specialists with `--specialists` in `/kc:work` or `/kc:audit`:
237
-
238
- ```bash
239
- /kc:work "Build auth system" --specialists # All 3 specialists
240
- /kc:work "Build auth system" --specialists=security # Security officer only
241
- /kc:audit --specialists # Deep audit with specialists
242
- ```
243
-
244
- - **security-officer**: Officer authority — CRITICAL/HIGH findings block gates
245
- - **test-advisor**: Advisory — TDD compliance, assertion quality, coverage gaps
246
- - **project-advisor**: Advisorybacklog ideas, tech debt tracking (shuts down mid-implementation)
247
-
248
- Specialists communicate directly with builders (max 2 DMs each) and report findings at quality gates. Supported in Parallel Teams and Subagent modes only.
249
-
250
- </details>
251
-
252
- See the [Workflow Reference](./docs/workflow-reference.md) for detailed orchestration flows.
253
-
254
- ### GitHub Copilot
255
-
256
- Copilot users invoke phases via prompt files in VS Code Copilot Chat:
257
-
258
- ```bash
259
- #prompt:kc-work "Build JWT authentication" # Start feature workflow
260
- #prompt:kc-specify # Draft specs (after Change Set approved)
261
- #prompt:kc-implement # TDD implementation
262
- #prompt:kc-audit # READ-ONLY audit
263
- #prompt:kc-finalize # Finalize and commit
264
- #prompt:kc-continue # Resume where you left off
265
- ```
266
-
267
- Generated by `/kc:init` into `.github/prompts/`. See `knowzcode/copilot_execution.md` for details.
268
-
269
- ### Other Platforms
270
-
271
- Gemini, Cursor, Codex, and Windsurf follow the same methodology phases sequentially — the AI reads prompt templates from `knowzcode/prompts/` and follows the same quality gates. No agent orchestration is needed.
272
-
273
- ## Project Structure
274
-
275
- ```
276
- your-project/
277
- └── knowzcode/
278
- ├── knowzcode_loop.md # The methodology (TDD, quality gates, phases)
279
- ├── knowzcode_project.md # Project goals, tech stack, standards
280
- ├── knowzcode_architecture.md # Auto-maintained architecture docs
281
- ├── knowzcode_tracker.md # WorkGroup status tracking
282
- ├── knowzcode_log.md # Session history
283
- ├── specs/ # Component specifications
284
- ├── prompts/ # Phase prompt templates (works with any AI)
285
- ├── workgroups/ # Session data (gitignored)
286
- └── enterprise/ # Optional compliance config (gitignored, experimental)
287
- ```
288
-
289
- ## Documentation
290
-
291
- | Guide | Description |
292
- |:------|:------------|
293
- | [Getting Started](./docs/knowzcode_getting_started.md) | Walkthrough, MCP setup, file structure |
294
- | [Understanding KnowzCode](./docs/understanding-knowzcode.md) | Concepts and architecture deep dive |
295
- | [Workflow Reference](./docs/workflow-reference.md) | Phase details, execution modes, parallel orchestration |
296
- | [Prompts Guide](./docs/knowzcode_prompts_guide.md) | Prompt templates and command reference |
297
-
298
- ## Contributing
299
-
300
- Fork branch PR. See **[CLAUDE.md](CLAUDE.md)** for developer docs.
301
-
302
- ## Acknowledgments
303
-
304
- KnowzCode is built upon the foundation of the [Noderr project](https://github.com/kaithoughtarchitect/noderr) by [@kaithoughtarchitect](https://github.com/kaithoughtarchitect). We're grateful for their pioneering work in systematic AI-driven development.
305
-
306
- ## License
307
-
308
- MIT License with Commons Clause — See [LICENSE](LICENSE) file for details.
309
-
310
- ---
311
-
312
- <div align="center">
313
-
314
- **A structured development methodology for AI coding assistants.**
315
-
316
- [Get Started](#installation) · [Read the Docs](#documentation) · [Contribute](#contributing)
317
-
318
- Built by [Knowz](https://github.com/knowz-io)
319
-
320
- </div>
1
+ # KnowzCode
2
+
3
+ <div align="center">
4
+
5
+ **A structured development methodology for AI coding assistants.**
6
+
7
+ [![License: MIT + Commons Clause](https://img.shields.io/badge/License-MIT_+_Commons_Clause-yellow.svg)](LICENSE)
8
+ [![Claude Code Plugin](https://img.shields.io/badge/Claude_Code-Plugin-purple)](https://github.com/knowz-io/knowzcode)
9
+ [![Version](https://img.shields.io/badge/version-0.4.0-blue)](https://github.com/knowz-io/knowzcode/releases)
10
+
11
+ [Installation](#installation) · [Quick Start](#quick-start) · [When to Use It](#when-to-use-knowzcode) · [How It Works](#how-it-works) · [Commands](#commands) · [Docs](#documentation)
12
+
13
+ </div>
14
+
15
+ ---
16
+
17
+ ## The Problem
18
+
19
+ AI coding assistants lack structure. Without it, they:
20
+ - Forget context between sessions
21
+ - Make changes without considering impact
22
+ - Declare "done" without verifying anything works
23
+ - Let documentation drift from reality immediately
24
+
25
+ ## What KnowzCode Does
26
+
27
+ KnowzCode is a **platform-agnostic development methodology** that lives in your project's `knowzcode/` directory.
28
+
29
+ - **Adaptive Development Loop** — Scales from quick fixes to full 5-phase TDD workflows with quality gates at each phase
30
+ - **Quality Gates** — Automated verification at each phase prevents broken code from advancing
31
+ - **Living Documentation** — Architecture diagrams and specs auto-update as code changes
32
+ - **Session Memory** — WorkGroups track complete context so nothing is lost between sessions
33
+ - **Interruption Recovery** — Say "continue" to resume exactly where you left off
34
+ - **Multi-Platform** — Works with Claude Code, Codex, Gemini, Cursor, Copilot, and Windsurf
35
+
36
+ ## When to Use KnowzCode
37
+
38
+ KnowzCode adds overhead — more time, more tokens, more structure than letting your coding agent plan and execute natively. That's the tradeoff. Here's when it's worth it:
39
+
40
+ **Your agent's native mode is fine for:**
41
+ - Single-file changes, bug fixes, small refactors
42
+ - Tasks where "good enough" is good enough
43
+ - Anything you can verify at a glance
44
+
45
+ **Reach for KnowzCode when:**
46
+ - **Outcomes aren't meeting expectations** — the agent keeps missing edge cases, breaking things, or delivering incomplete work
47
+ - **Multi-component changes** — features that touch multiple layers (API + DB + UI + tests) benefit from impact analysis and phased execution
48
+ - **Architecture and security matter** — quality gates catch issues before they compound
49
+ - **You need documentation that stays current** — specs and architecture docs update as part of the workflow, not as an afterthought
50
+ - **Enforcing standards** — personal conventions, team guidelines, or enterprise compliance rules baked into every phase
51
+ - **Resumability** — long-running work that spans sessions, where losing context means starting over
52
+ - **Autonomous execution** — approve specs upfront, then let the agent run; verification loops and quality gates keep output on track without constant oversight
53
+
54
+ The overhead pays for itself when the cost of getting it wrong exceeds the cost of being thorough.
55
+
56
+ ## How It Works
57
+
58
+ Every feature follows a structured loop with quality gates between phases:
59
+
60
+ ```
61
+ ┌──────────────────── THE KNOWZCODE LOOP ────────────────────┐
62
+ │ │
63
+ │ Goal → Analyze → ✓ → Design → ✓ → Build → Audit → ✓ → Ship │
64
+ │ Impact Specs (TDD) Quality │
65
+ │ 1A 1B 2A 2B 3 │
66
+ │ │
67
+ │ ✓ = approval gate (you decide whether to proceed) │
68
+ └─────────────────────────────────────────────────────────────┘
69
+ ```
70
+
71
+ KnowzCode automatically classifies tasks by complexity:
72
+ - **Micro** — single-file fixes skip the loop entirely (`/kc:fix`)
73
+ - **Light** — small changes (≤3 files) use a streamlined 2-phase path
74
+ - **Full** — complex features get the complete 5-phase workflow above
75
+
76
+ Each gate requires your approval before proceeding. See the [Workflow Reference](./docs/workflow-reference.md) for details.
77
+
78
+ ## Installation
79
+
80
+ ### Claude Code (Recommended)
81
+
82
+ ```bash
83
+ /plugin marketplace add knowz-io/knowzcode
84
+ /plugin install kc@knowzcode
85
+ cd your-project/
86
+ /kc:init
87
+ /kc:work "Build user authentication"
88
+ ```
89
+
90
+ ### Alternative: Script Install
91
+
92
+ ```bash
93
+ npx knowzcode # Interactive setup
94
+ npx knowzcode install --platforms claude,cursor # Specific platforms
95
+ npx knowzcode install --platforms all # All 6 platforms
96
+ ```
97
+
98
+ Commands available as `/work`, `/plan`, `/fix` (without `kc:` prefix).
99
+ For `/kc:` prefix, also run: `/plugin install kc@knowzcode`.
100
+
101
+ <details>
102
+ <summary><strong>Supported Platforms (6)</strong></summary>
103
+
104
+ | Platform | Generated Files | Support Level |
105
+ |----------|----------------|---------------|
106
+ | Claude Code | `CLAUDE.md` + `.claude/{agents,commands,skills}/` | Full support (plugin + 14 agents + 11 commands) |
107
+ | Gemini CLI | `GEMINI.md` + `.gemini/commands/kc/*.toml` (7 commands) | Native `/kc:` commands + instruction file |
108
+ | OpenAI Codex | `AGENTS.md` + `.codex/skills/kc/*.md` (6 skills) | Instruction file + discoverable skill files |
109
+ | Cursor | `.cursor/rules/knowzcode.mdc` | Rules file (commands via `.cursor/commands/` beta) |
110
+ | GitHub Copilot | `.github/copilot-instructions.md` + `.github/prompts/kc-*.prompt.md` (9 prompts) + `.vscode/mcp.json` | Full support (instructions + prompt files + MCP) |
111
+ | Windsurf | `.windsurf/rules/knowzcode.md` | Rules file (workflows via `.windsurf/workflows/`) |
112
+
113
+ </details>
114
+
115
+ ### Manual (Repo Clone)
116
+
117
+ ```bash
118
+ git clone https://github.com/knowz-io/knowzcode.git
119
+ cd KnowzCode
120
+ ./install.sh install --target /path/to/your/project # Linux/macOS
121
+ .\install.ps1 install --target C:\path\to\your\project # Windows
122
+ ```
123
+
124
+ `install.sh` and `install.ps1` are thin wrappers that delegate to the Node.js installer (`bin/knowzcode.mjs`). Node.js 18+ is required.
125
+
126
+ ### Cloud Features (Optional)
127
+
128
+ Connect to KnowzCode Cloud for vector-powered semantic search, AI Q&A, and learning capture via MCP. See the [Getting Started Guide](./docs/knowzcode_getting_started.md#mcp-integration-cloud-features) for setup.
129
+
130
+ ## Quick Start
131
+
132
+ ### Start a Feature
133
+
134
+ ```bash
135
+ /kc:work "Build user authentication with email and password"
136
+ ```
137
+
138
+ Runs the full loop: impact analysis → specs → TDD → audit → finalize, with approval gates between each phase.
139
+
140
+ ### Research First
141
+
142
+ ```bash
143
+ /kc:plan "how is authentication implemented?"
144
+ ```
145
+
146
+ Explores your codebase first. Say "implement" to transition into `/kc:work` with findings pre-loaded.
147
+
148
+ ### Quick Fix
149
+
150
+ ```bash
151
+ /kc:fix "Fix typo in login button text"
152
+ ```
153
+
154
+ Targeted fixes that skip the full loop — for typos, small bugs, and CSS tweaks.
155
+
156
+ ## Commands
157
+
158
+ | Command | Description |
159
+ |:--------|:------------|
160
+ | `/kc:init` | Initialize KnowzCode in project |
161
+ | `/kc:work <goal>` | Start feature workflow |
162
+ | `/kc:plan <topic>` | Research before implementing |
163
+ | `/kc:audit [type]` | Run quality audits |
164
+ | `/kc:fix <target>` | Quick targeted fix |
165
+ | `/kc:connect-mcp` | Configure MCP server |
166
+ | `/kc:register` | Register and configure MCP |
167
+ | `/kc:status` | Check MCP connection |
168
+ | `/kc:learn` | Capture learnings to vault |
169
+ | `/kc:telemetry` | Investigate production telemetry |
170
+ | `/kc:telemetry-setup` | Configure telemetry sources |
171
+
172
+ ## Architecture
173
+
174
+ ```
175
+ Layer 4: Platform Enhancements (optional, best experience)
176
+ Claude Code agents | Codex Agents SDK | Gemini Skills
177
+ ──────────────────────────────────────────────────────
178
+ Layer 3: Platform Adapters (thin instruction files)
179
+ CLAUDE.md | AGENTS.md | GEMINI.md | .cursor/rules/*.mdc
180
+ ──────────────────────────────────────────────────────
181
+ Layer 2: MCP Integration (cross-platform knowledge layer)
182
+ KnowzCode MCP server vaults, search, learning capture
183
+ ──────────────────────────────────────────────────────
184
+ Layer 1: Core Methodology (platform-agnostic, the actual product)
185
+ knowzcode/ directory → loop, specs, tracker, architecture
186
+ ```
187
+
188
+ The real product is Layer 1 the `knowzcode/` directory. Everything else enhances it.
189
+ On Claude Code, Layer 4 provides 14 specialized agents (11 core + 3 opt-in specialists) with parallel orchestration.
190
+ On other platforms, the AI follows the same methodology directly.
191
+ See [Understanding KnowzCode](./docs/understanding-knowzcode.md) for a deep dive.
192
+
193
+ ## Execution Modes
194
+
195
+ ### Claude Code
196
+
197
+ When using Claude Code, `/kc:work` automatically selects an execution strategy based on task complexity and available features:
198
+
199
+ | Mode | When Used | How It Works |
200
+ |------|-----------|-------------|
201
+ | **Parallel Teams** | Complex features (default for >3 files) | Multiple agents work concurrently scouts gather context, builders implement in parallel, reviewer audits incrementally |
202
+ | **Sequential Teams** | Lighter features or `--sequential` flag | One agent per phase with persistent team context |
203
+ | **Subagent Delegation** | Agent Teams not enabled | One agent spawned per phase via fallback — works on all Claude Code instances |
204
+
205
+ <details>
206
+ <summary><strong>Agent Teams Setup & Roster (14 agents)</strong></summary>
207
+
208
+ Parallel and Sequential Teams require [Agent Teams (experimental)](https://code.claude.com/docs/en/agent-teams). Enable by adding the following to your Claude Code `settings.json`:
209
+
210
+ ```json
211
+ { "env": { "CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS": "1" } }
212
+ ```
213
+
214
+ Or ask Claude Code: _"Enable Agent Teams in my settings."_ Then restart. Without it, subagent delegation is used automatically.
215
+
216
+ | Agent | Role | Phase |
217
+ |-------|------|-------|
218
+ | `context-scout` | Local context research (specs, tracker, history) | Discovery |
219
+ | `knowz-scout` | MCP vault research (conventions, decisions) | Discovery |
220
+ | `knowz-scribe` | MCP vault writes (learning capture, audit trails) | All phases |
221
+ | `analyst` | Impact analysis, Change Set proposals | 1A |
222
+ | `architect` | Specification drafting, architecture review | 1B |
223
+ | `builder` | TDD implementation, verification loops | 2A |
224
+ | `reviewer` | Quality audit, security review | 2B |
225
+ | `closer` | Finalization, learning capture | 3 |
226
+ | `security-officer` | Threat modeling, vulnerability scanning (opt-in) | All phases |
227
+ | `test-advisor` | TDD enforcement, test quality review (opt-in) | All phases |
228
+ | `project-advisor` | Backlog curation, future work ideas (opt-in) | Discovery–2A |
229
+ | `microfix-specialist` | Quick targeted fixes | Utility |
230
+ | `knowledge-migrator` | Knowledge migration between vaults | Utility |
231
+ | `update-coordinator` | Plugin update coordination | Utility |
232
+
233
+ </details>
234
+
235
+ <details>
236
+ <summary><strong>Opt-in Specialist Agents</strong></summary>
237
+
238
+ Activate specialists with `--specialists` in `/kc:work` or `/kc:audit`:
239
+
240
+ ```bash
241
+ /kc:work "Build auth system" --specialists # All 3 specialists
242
+ /kc:work "Build auth system" --specialists=security # Security officer only
243
+ /kc:audit --specialists # Deep audit with specialists
244
+ ```
245
+
246
+ - **security-officer**: Officer authority CRITICAL/HIGH findings block gates
247
+ - **test-advisor**: Advisory — TDD compliance, assertion quality, coverage gaps
248
+ - **project-advisor**: Advisory backlog ideas, tech debt tracking (shuts down mid-implementation)
249
+
250
+ Specialists communicate directly with builders (max 2 DMs each) and report findings at quality gates. Supported in Parallel Teams and Subagent modes only.
251
+
252
+ </details>
253
+
254
+ See the [Workflow Reference](./docs/workflow-reference.md) for detailed orchestration flows.
255
+
256
+ ### GitHub Copilot
257
+
258
+ Copilot users invoke phases via prompt files in VS Code Copilot Chat:
259
+
260
+ ```bash
261
+ #prompt:kc-work "Build JWT authentication" # Start feature workflow
262
+ #prompt:kc-specify # Draft specs (after Change Set approved)
263
+ #prompt:kc-implement # TDD implementation
264
+ #prompt:kc-audit # READ-ONLY audit
265
+ #prompt:kc-finalize # Finalize and commit
266
+ #prompt:kc-continue # Resume where you left off
267
+ ```
268
+
269
+ Generated by `/kc:init` into `.github/prompts/`. See `knowzcode/copilot_execution.md` for details.
270
+
271
+ ### Gemini CLI
272
+
273
+ Gemini users get native `/kc:` commands via TOML files in `.gemini/commands/kc/`:
274
+
275
+ ```bash
276
+ /kc:work "Build JWT authentication" # Start feature workflow
277
+ /kc:plan "how is auth implemented?" # Research first
278
+ /kc:fix "Fix login redirect bug" # Quick fix
279
+ /kc:audit # Quality audit
280
+ /kc:continue # Resume where you left off
281
+ ```
282
+
283
+ Generated by `npx knowzcode install --platforms gemini` into `.gemini/commands/kc/`.
284
+
285
+ ### OpenAI Codex
286
+
287
+ Codex users get discoverable `/kc:` skills via `.codex/skills/kc/`:
288
+
289
+ ```bash
290
+ /kc:work "Build user authentication" # Start feature workflow
291
+ /kc:plan "how is auth implemented?" # Research first
292
+ /kc:fix "Fix login bug" # Quick fix
293
+ /kc:audit # Quality audit
294
+ ```
295
+
296
+ Generated by `npx knowzcode install --platforms codex` into `.codex/skills/kc/`.
297
+
298
+ For cross-project availability, install skills globally:
299
+ ```bash
300
+ npx knowzcode install --platforms codex --global # Skills ~/.codex/skills/kc/
301
+ ```
302
+
303
+ ### Other Platforms
304
+
305
+ Cursor and Windsurf follow the same methodology phases sequentially — the AI reads prompt templates from `knowzcode/prompts/` and follows the same quality gates. No agent orchestration is needed.
306
+
307
+ ## Project Structure
308
+
309
+ ```
310
+ your-project/
311
+ └── knowzcode/
312
+ ├── knowzcode_loop.md # The methodology (TDD, quality gates, phases)
313
+ ├── knowzcode_project.md # Project goals, tech stack, standards
314
+ ├── knowzcode_architecture.md # Auto-maintained architecture docs
315
+ ├── knowzcode_tracker.md # WorkGroup status tracking
316
+ ├── knowzcode_log.md # Session history
317
+ ├── specs/ # Component specifications
318
+ ├── prompts/ # Phase prompt templates (works with any AI)
319
+ ├── workgroups/ # Session data (gitignored)
320
+ └── enterprise/ # Optional compliance config (gitignored, experimental)
321
+ ```
322
+
323
+ ## Documentation
324
+
325
+ | Guide | Description |
326
+ |:------|:------------|
327
+ | [Getting Started](./docs/knowzcode_getting_started.md) | Walkthrough, MCP setup, file structure |
328
+ | [Understanding KnowzCode](./docs/understanding-knowzcode.md) | Concepts and architecture deep dive |
329
+ | [Workflow Reference](./docs/workflow-reference.md) | Phase details, execution modes, parallel orchestration |
330
+ | [Prompts Guide](./docs/knowzcode_prompts_guide.md) | Prompt templates and command reference |
331
+
332
+ ## Contributing
333
+
334
+ Fork → branch → PR. See **[CLAUDE.md](CLAUDE.md)** for developer docs.
335
+
336
+ ## Acknowledgments
337
+
338
+ KnowzCode is built upon the foundation of the [Noderr project](https://github.com/kaithoughtarchitect/noderr) by [@kaithoughtarchitect](https://github.com/kaithoughtarchitect). We're grateful for their pioneering work in systematic AI-driven development.
339
+
340
+ ## License
341
+
342
+ MIT License with Commons Clause — See [LICENSE](LICENSE) file for details.
343
+
344
+ ---
345
+
346
+ <div align="center">
347
+
348
+ **A structured development methodology for AI coding assistants.**
349
+
350
+ [Get Started](#installation) · [Read the Docs](#documentation) · [Contribute](#contributing)
351
+
352
+ Built by [Knowz](https://github.com/knowz-io)
353
+
354
+ </div>