knowzcode 0.1.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/.claude-plugin/marketplace.json +55 -0
- package/.claude-plugin/plugin.json +8 -0
- package/LICENSE +121 -0
- package/README.md +223 -0
- package/agents/analyst.md +121 -0
- package/agents/architect.md +121 -0
- package/agents/builder.md +155 -0
- package/agents/closer.md +148 -0
- package/agents/knowledge-migrator.md +349 -0
- package/agents/microfix-specialist.md +140 -0
- package/agents/reviewer.md +220 -0
- package/agents/update-coordinator.md +405 -0
- package/bin/knowzcode.mjs +869 -0
- package/commands/audit.md +108 -0
- package/commands/connect-mcp.md +507 -0
- package/commands/fix.md +107 -0
- package/commands/init.md +320 -0
- package/commands/learn.md +308 -0
- package/commands/plan.md +125 -0
- package/commands/register.md +724 -0
- package/commands/status.md +291 -0
- package/commands/telemetry-setup.md +368 -0
- package/commands/telemetry.md +188 -0
- package/commands/work.md +390 -0
- package/knowzcode/automation_manifest.md +59 -0
- package/knowzcode/claude_code_execution.md +133 -0
- package/knowzcode/enterprise/compliance_manifest.md +132 -0
- package/knowzcode/enterprise/compliance_status.md +30 -0
- package/knowzcode/enterprise/guidelines/code-quality.md +67 -0
- package/knowzcode/enterprise/guidelines/custom/.gitkeep +0 -0
- package/knowzcode/enterprise/guidelines/security.md +355 -0
- package/knowzcode/enterprise/reports/.gitkeep +0 -0
- package/knowzcode/enterprise/templates/guideline-template.md +55 -0
- package/knowzcode/gitignore.template +13 -0
- package/knowzcode/knowzcode_architecture.md +51 -0
- package/knowzcode/knowzcode_log.md +142 -0
- package/knowzcode/knowzcode_loop.md +515 -0
- package/knowzcode/knowzcode_project.md +233 -0
- package/knowzcode/knowzcode_tracker.md +40 -0
- package/knowzcode/knowzcode_vaults.md +104 -0
- package/knowzcode/mcp_config.md +166 -0
- package/knowzcode/planning/Readme.md +6 -0
- package/knowzcode/platform_adapters.md +388 -0
- package/knowzcode/prompts/Execute_Micro_Fix.md +57 -0
- package/knowzcode/prompts/Investigate_Codebase.md +227 -0
- package/knowzcode/prompts/Migrate_Knowledge.md +301 -0
- package/knowzcode/prompts/Refactor_Node.md +72 -0
- package/knowzcode/prompts/Spec_Verification_Checkpoint.md +59 -0
- package/knowzcode/prompts/[LOOP_1A]__Propose_Change_Set.md +52 -0
- package/knowzcode/prompts/[LOOP_1B]__Draft_Specs.md +75 -0
- package/knowzcode/prompts/[LOOP_2A]__Implement_Change_Set.md +55 -0
- package/knowzcode/prompts/[LOOP_2B]__Verify_Implementation.md +72 -0
- package/knowzcode/prompts/[LOOP_3]__Finalize_And_Commit.md +67 -0
- package/knowzcode/specs/Readme.md +10 -0
- package/knowzcode/telemetry_config.md +89 -0
- package/knowzcode/user_preferences.md +120 -0
- package/package.json +53 -0
- package/skills/alias-resolver.json +15 -0
- package/skills/architecture-diff.json +12 -0
- package/skills/check-installation-status.json +14 -0
- package/skills/continue.md +105 -0
- package/skills/environment-guard.json +12 -0
- package/skills/generate-workgroup-id.json +25 -0
- package/skills/install-knowzcode.json +21 -0
- package/skills/load-core-context.json +18 -0
- package/skills/log-entry-builder.json +15 -0
- package/skills/spec-quality-check.json +14 -0
- package/skills/spec-template.json +15 -0
- package/skills/spec-validator.json +25 -0
- package/skills/start-work.md +224 -0
- package/skills/tracker-scan.json +12 -0
- package/skills/tracker-update.json +28 -0
- package/skills/validate-installation.json +14 -0
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "knowzcode-marketplace",
|
|
3
|
+
"owner": {
|
|
4
|
+
"name": "Alex Headscarf",
|
|
5
|
+
"email": "alex@headscarf.com"
|
|
6
|
+
},
|
|
7
|
+
"metadata": {
|
|
8
|
+
"description": "Official KnowzCode plugin marketplace - Platform-agnostic AI development methodology",
|
|
9
|
+
"version": "0.1.0"
|
|
10
|
+
},
|
|
11
|
+
"plugins": [
|
|
12
|
+
{
|
|
13
|
+
"name": "kc",
|
|
14
|
+
"source": "./",
|
|
15
|
+
"description": "KnowzCode - Platform-agnostic AI development methodology with TDD, quality gates, and structured workflows",
|
|
16
|
+
"version": "0.1.0",
|
|
17
|
+
"author": {
|
|
18
|
+
"name": "Alex Headscarf"
|
|
19
|
+
},
|
|
20
|
+
"homepage": "https://github.com/knowz-io/knowzcode",
|
|
21
|
+
"repository": "https://github.com/knowz-io/knowzcode",
|
|
22
|
+
"license": "MIT",
|
|
23
|
+
"keywords": ["tdd", "workflow", "methodology", "quality", "platform-agnostic"],
|
|
24
|
+
"category": "Development Workflow",
|
|
25
|
+
"tags": ["tdd", "testing", "quality-assurance", "cross-platform", "methodology"],
|
|
26
|
+
"commands": [
|
|
27
|
+
"./commands/work.md",
|
|
28
|
+
"./commands/init.md",
|
|
29
|
+
"./commands/fix.md",
|
|
30
|
+
"./commands/audit.md",
|
|
31
|
+
"./commands/plan.md",
|
|
32
|
+
"./commands/connect-mcp.md",
|
|
33
|
+
"./commands/status.md",
|
|
34
|
+
"./commands/telemetry.md",
|
|
35
|
+
"./commands/telemetry-setup.md",
|
|
36
|
+
"./commands/learn.md",
|
|
37
|
+
"./commands/register.md"
|
|
38
|
+
],
|
|
39
|
+
"agents": [
|
|
40
|
+
"./agents/analyst.md",
|
|
41
|
+
"./agents/architect.md",
|
|
42
|
+
"./agents/builder.md",
|
|
43
|
+
"./agents/reviewer.md",
|
|
44
|
+
"./agents/closer.md",
|
|
45
|
+
"./agents/microfix-specialist.md",
|
|
46
|
+
"./agents/knowledge-migrator.md",
|
|
47
|
+
"./agents/update-coordinator.md"
|
|
48
|
+
],
|
|
49
|
+
"skills": [
|
|
50
|
+
"./skills/start-work.md",
|
|
51
|
+
"./skills/continue.md"
|
|
52
|
+
]
|
|
53
|
+
}
|
|
54
|
+
]
|
|
55
|
+
}
|
package/LICENSE
ADDED
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
MIT License with Commons Clause
|
|
2
|
+
|
|
3
|
+
=============================================================================
|
|
4
|
+
ORIGINAL WORK: Noderr
|
|
5
|
+
=============================================================================
|
|
6
|
+
|
|
7
|
+
Noderr:
|
|
8
|
+
https://noderr.com
|
|
9
|
+
https://github.com/kaithoughtarchitect/noderr
|
|
10
|
+
|
|
11
|
+
Copyright (c) 2025 Kai ThoughtArchitect
|
|
12
|
+
|
|
13
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
14
|
+
of this framework and associated documentation files (the "Framework"), to deal
|
|
15
|
+
in the Framework without restriction, including without limitation the rights
|
|
16
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
17
|
+
copies of the Framework, and to permit persons to whom the Framework is
|
|
18
|
+
furnished to do so, subject to the following conditions:
|
|
19
|
+
|
|
20
|
+
The above copyright notice and this permission notice shall be included in all
|
|
21
|
+
copies or substantial portions of the Framework.
|
|
22
|
+
|
|
23
|
+
THE FRAMEWORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
24
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
25
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
26
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
27
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
28
|
+
OUT OF OR IN CONNECTION WITH THE FRAMEWORK OR THE USE OR OTHER DEALINGS IN THE
|
|
29
|
+
FRAMEWORK.
|
|
30
|
+
|
|
31
|
+
"Commons Clause" License Condition v1.0
|
|
32
|
+
|
|
33
|
+
The Framework is provided to you by the Licensor under the License, as defined
|
|
34
|
+
below, subject to the following condition:
|
|
35
|
+
|
|
36
|
+
Without limiting other conditions in the License, the grant of rights under the
|
|
37
|
+
License will not include, and the License does not grant to you, the right to
|
|
38
|
+
Sell the Framework.
|
|
39
|
+
|
|
40
|
+
For purposes of the foregoing, "Sell" means practicing any or all of the rights
|
|
41
|
+
granted to you under the License to provide to third parties, for a fee or other
|
|
42
|
+
consideration (including without limitation fees for hosting or consulting/support
|
|
43
|
+
services related to the Framework), a product or service whose value derives,
|
|
44
|
+
entirely or substantially, from the functionality of the Framework. Any license
|
|
45
|
+
notice or attribution required by the License must also include this Commons
|
|
46
|
+
Clause License Condition notice.
|
|
47
|
+
|
|
48
|
+
This restriction does not apply to: using Noderr to develop software for clients,
|
|
49
|
+
teaching Noderr methodology in educational settings, or creating products using
|
|
50
|
+
Noderr as a development tool.
|
|
51
|
+
|
|
52
|
+
Framework: Noderr - The Node-Based AI Development Methodology (including all
|
|
53
|
+
documentation, prompts, templates, tracking systems, workflow guides,
|
|
54
|
+
and associated files in the GitHub repository "noderr" and any
|
|
55
|
+
distributed packages)
|
|
56
|
+
|
|
57
|
+
License: MIT
|
|
58
|
+
|
|
59
|
+
Licensor: Kai ThoughtArchitect
|
|
60
|
+
|
|
61
|
+
=============================================================================
|
|
62
|
+
DERIVATIVE WORK: KnowzCode
|
|
63
|
+
=============================================================================
|
|
64
|
+
|
|
65
|
+
KnowzCode:
|
|
66
|
+
https://github.com/AlexHeadscarf/KnowzCode
|
|
67
|
+
|
|
68
|
+
Copyright (c) 2025 Alex Headscarf
|
|
69
|
+
|
|
70
|
+
This work is a derivative of Noderr, modified and extended as KnowzCode.
|
|
71
|
+
All modifications and extensions are licensed under the same terms below.
|
|
72
|
+
|
|
73
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
74
|
+
of this framework and associated documentation files (the "Framework"), to deal
|
|
75
|
+
in the Framework without restriction, including without limitation the rights
|
|
76
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
77
|
+
copies of the Framework, and to permit persons to whom the Framework is
|
|
78
|
+
furnished to do so, subject to the following conditions:
|
|
79
|
+
|
|
80
|
+
The above copyright notice and this permission notice (including the Noderr
|
|
81
|
+
attribution above) shall be included in all copies or substantial portions
|
|
82
|
+
of the Framework.
|
|
83
|
+
|
|
84
|
+
THE FRAMEWORK IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
85
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
86
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
87
|
+
AUTHORS OR COPYRIGHT HOLDERS (INCLUDING BOTH KAI THOUGHTARCHITECT AND ALEX
|
|
88
|
+
HEADSCARF) BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
89
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
90
|
+
CONNECTION WITH THE FRAMEWORK OR THE USE OR OTHER DEALINGS IN THE FRAMEWORK.
|
|
91
|
+
|
|
92
|
+
"Commons Clause" License Condition v1.0
|
|
93
|
+
|
|
94
|
+
The Framework is provided to you by the Licensor under the License, as defined
|
|
95
|
+
below, subject to the following condition:
|
|
96
|
+
|
|
97
|
+
Without limiting other conditions in the License, the grant of rights under the
|
|
98
|
+
License will not include, and the License does not grant to you, the right to
|
|
99
|
+
Sell the Framework.
|
|
100
|
+
|
|
101
|
+
For purposes of the foregoing, "Sell" means practicing any or all of the rights
|
|
102
|
+
granted to you under the License to provide to third parties, for a fee or other
|
|
103
|
+
consideration (including without limitation fees for hosting or consulting/support
|
|
104
|
+
services related to the Framework), a product or service whose value derives,
|
|
105
|
+
entirely or substantially, from the functionality of the Framework. Any license
|
|
106
|
+
notice or attribution required by the License must also include this Commons
|
|
107
|
+
Clause License Condition notice.
|
|
108
|
+
|
|
109
|
+
This restriction does not apply to: using KnowzCode to develop software for
|
|
110
|
+
clients, teaching KnowzCode methodology in educational settings, or creating
|
|
111
|
+
products using KnowzCode as a development tool.
|
|
112
|
+
|
|
113
|
+
Framework: KnowzCode - Knowledge-Driven Code Development Methodology (including
|
|
114
|
+
all documentation, prompts, templates, tracking systems, workflow
|
|
115
|
+
guides, and associated files in the GitHub repository "knowzcode"
|
|
116
|
+
and any distributed packages, as well as all inherited components
|
|
117
|
+
from Noderr)
|
|
118
|
+
|
|
119
|
+
License: MIT
|
|
120
|
+
|
|
121
|
+
Licensor: Alex Headscarf
|
package/README.md
ADDED
|
@@ -0,0 +1,223 @@
|
|
|
1
|
+
# KnowzCode
|
|
2
|
+
|
|
3
|
+
<div align="center">
|
|
4
|
+
|
|
5
|
+
**Turn any AI coding assistant into a disciplined software engineer.**
|
|
6
|
+
|
|
7
|
+
[](LICENSE)
|
|
8
|
+
[](https://github.com/knowz-io/knowzcode)
|
|
9
|
+
[](https://github.com/knowz-io/knowzcode/releases)
|
|
10
|
+
|
|
11
|
+
[Installation](#installation) · [Quick Start](#quick-start) · [How It Works](#how-it-works) · [Commands](#commands) · [Docs](#documentation)
|
|
12
|
+
|
|
13
|
+
</div>
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## The Problem
|
|
18
|
+
|
|
19
|
+
AI coding assistants are powerful — they can read your entire codebase, write complex code, and understand requirements. But without structure, they forget context between sessions, make random changes without considering impact, declare "done" when they've only written code (not verified it), and let documentation drift from reality immediately.
|
|
20
|
+
|
|
21
|
+
**KnowzCode fixes this.**
|
|
22
|
+
|
|
23
|
+
## What KnowzCode Does
|
|
24
|
+
|
|
25
|
+
KnowzCode is a **platform-agnostic development methodology** that lives in a `knowzcode/` directory inside your project. It gives any AI assistant a structured TDD workflow with quality gates, specifications, and session tracking — turning chaotic AI coding into systematic, verifiable software engineering.
|
|
26
|
+
|
|
27
|
+
- **5-Phase Development Loop** — Impact analysis → specs → TDD implementation → audit → finalization
|
|
28
|
+
- **Quality Gates** — Automated verification at each phase prevents broken code from advancing
|
|
29
|
+
- **Living Documentation** — Architecture diagrams and specs auto-update as code changes
|
|
30
|
+
- **Session Memory** — WorkGroups track complete context so nothing is lost between sessions
|
|
31
|
+
- **Interruption Recovery** — Say "continue" to resume exactly where you left off
|
|
32
|
+
- **Multi-Platform** — Works with Claude Code, Codex, Gemini, Cursor, Copilot, and Windsurf
|
|
33
|
+
|
|
34
|
+
## How It Works
|
|
35
|
+
|
|
36
|
+
Every feature follows a structured loop with quality gates between phases:
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
┌─────────────────────────────────────────────────────────┐
|
|
40
|
+
│ THE KNOWZCODE LOOP │
|
|
41
|
+
│ │
|
|
42
|
+
│ You provide a goal (e.g., "Add user authentication") │
|
|
43
|
+
│ ↓ │
|
|
44
|
+
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ │
|
|
45
|
+
│ │ Phase 1A │──→│ Phase 1B │──→│ Phase 2A │ │
|
|
46
|
+
│ │ Analyze │ │ Specify │ │ Build │ │
|
|
47
|
+
│ │ Impact │ │ Design │ │ with TDD │ │
|
|
48
|
+
│ └──────────┘ └──────────┘ └──────────┘ │
|
|
49
|
+
│ ↑ ↑ │ │
|
|
50
|
+
│ [approve] [approve] ↓ │
|
|
51
|
+
│ ┌──────────┐ ┌──────────┐ │
|
|
52
|
+
│ │ Phase 2B │──→│ Phase 3 │ │
|
|
53
|
+
│ │ Audit │ │ Finalize │ │
|
|
54
|
+
│ │ Quality │ │ & Commit │ │
|
|
55
|
+
│ └──────────┘ └──────────┘ │
|
|
56
|
+
│ ↑ │
|
|
57
|
+
│ [approve] │
|
|
58
|
+
└─────────────────────────────────────────────────────────┘
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Each gate requires your approval before proceeding. See the [Workflow Reference](./docs/workflow-reference.md) for details.
|
|
62
|
+
|
|
63
|
+
## Installation
|
|
64
|
+
|
|
65
|
+
### Claude Code (Plugin)
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
/plugin marketplace add https://github.com/knowz-io/knowzcode
|
|
69
|
+
/plugin install knowzcode
|
|
70
|
+
cd your-project/
|
|
71
|
+
/kc:init
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### npx (Any Platform)
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
npx knowzcode # Interactive setup
|
|
78
|
+
npx knowzcode install --platforms claude,cursor # Specific platforms
|
|
79
|
+
npx knowzcode install --platforms all # All 6 platforms
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
| Platform | Instruction File | Support Level |
|
|
83
|
+
|----------|-----------------|---------------|
|
|
84
|
+
| Claude Code | `CLAUDE.md` | Full (agents + commands) |
|
|
85
|
+
| OpenAI Codex | `AGENTS.md` | Adapter template |
|
|
86
|
+
| Gemini CLI | `GEMINI.md` | Adapter template |
|
|
87
|
+
| Cursor | `.cursor/rules/knowzcode.mdc` | Adapter template |
|
|
88
|
+
| GitHub Copilot | `copilot-instructions.md` | Adapter template |
|
|
89
|
+
| Windsurf | `.windsurf/rules/knowzcode.md` | Adapter template |
|
|
90
|
+
|
|
91
|
+
### Manual (No Node.js)
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
git clone https://github.com/knowz-io/knowzcode.git
|
|
95
|
+
cd KnowzCode
|
|
96
|
+
./install.sh --target /path/to/your/project # Linux/macOS
|
|
97
|
+
.\install.ps1 -Target C:\path\to\your\project # Windows
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### Cloud Features (Optional)
|
|
101
|
+
|
|
102
|
+
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.
|
|
103
|
+
|
|
104
|
+
## Quick Start
|
|
105
|
+
|
|
106
|
+
### Start a Feature
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
/kc:work "Build user authentication with email and password"
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
KnowzCode analyzes impact, generates specs, guides TDD implementation, verifies quality, and updates documentation — all with approval gates at each phase.
|
|
113
|
+
|
|
114
|
+
### Research First
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
/kc:plan "how is authentication implemented?"
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Spawns parallel research agents to explore your codebase. After investigation, say "implement" to transition into `/kc:work` with findings pre-loaded.
|
|
121
|
+
|
|
122
|
+
### Quick Fix
|
|
123
|
+
|
|
124
|
+
```bash
|
|
125
|
+
/kc:fix "Fix typo in login button text"
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Targeted fixes that skip the full loop — for typos, small bugs, and CSS tweaks.
|
|
129
|
+
|
|
130
|
+
## Commands
|
|
131
|
+
|
|
132
|
+
| Command | Description | Example |
|
|
133
|
+
|:--------|:------------|:--------|
|
|
134
|
+
| `/kc:init` | Initialize KnowzCode in project | `/kc:init` |
|
|
135
|
+
| `/kc:work <goal>` | Start feature workflow | `/kc:work "Add dark mode"` |
|
|
136
|
+
| `/kc:plan <topic>` | Research before implementing | `/kc:plan "how does auth work?"` |
|
|
137
|
+
| `/kc:audit [type]` | Run quality audits | `/kc:audit security` |
|
|
138
|
+
| `/kc:fix <target>` | Quick targeted fix | `/kc:fix auth.js` |
|
|
139
|
+
| `/kc:connect-mcp` | Configure MCP server | `/kc:connect-mcp <api-key>` |
|
|
140
|
+
| `/kc:register` | Register and configure MCP | `/kc:register` |
|
|
141
|
+
| `/kc:status` | Check MCP connection | `/kc:status` |
|
|
142
|
+
| `/kc:learn` | Capture learnings to vault | `/kc:learn "insight"` |
|
|
143
|
+
| `/kc:telemetry` | Investigate production telemetry | `/kc:telemetry "error 500"` |
|
|
144
|
+
| `/kc:telemetry-setup` | Configure telemetry sources | `/kc:telemetry-setup` |
|
|
145
|
+
|
|
146
|
+
## Architecture
|
|
147
|
+
|
|
148
|
+
```
|
|
149
|
+
Layer 4: Platform Enhancements (optional, best experience)
|
|
150
|
+
Claude Code agents | Codex Agents SDK | Gemini Skills
|
|
151
|
+
──────────────────────────────────────────────────────
|
|
152
|
+
Layer 3: Platform Adapters (thin instruction files)
|
|
153
|
+
CLAUDE.md | AGENTS.md | GEMINI.md | .cursor/rules/*.mdc
|
|
154
|
+
──────────────────────────────────────────────────────
|
|
155
|
+
Layer 2: MCP Integration (cross-platform knowledge layer)
|
|
156
|
+
KnowzCode MCP server → vaults, search, learning capture
|
|
157
|
+
──────────────────────────────────────────────────────
|
|
158
|
+
Layer 1: Core Methodology (platform-agnostic, the actual product)
|
|
159
|
+
knowzcode/ directory → loop, specs, tracker, architecture
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
The real product is Layer 1 — the `knowzcode/` directory. Everything else enhances it. See [Understanding KnowzCode](./docs/understanding-knowzcode.md) for a deep dive.
|
|
163
|
+
|
|
164
|
+
## Project Structure
|
|
165
|
+
|
|
166
|
+
```
|
|
167
|
+
your-project/
|
|
168
|
+
└── knowzcode/
|
|
169
|
+
├── knowzcode_loop.md # The methodology (TDD, quality gates, phases)
|
|
170
|
+
├── knowzcode_project.md # Project goals, tech stack, standards
|
|
171
|
+
├── knowzcode_architecture.md # Auto-maintained architecture docs
|
|
172
|
+
├── knowzcode_tracker.md # WorkGroup status tracking
|
|
173
|
+
├── knowzcode_log.md # Session history
|
|
174
|
+
├── specs/ # Component specifications
|
|
175
|
+
├── prompts/ # Phase prompt templates (works with any AI)
|
|
176
|
+
├── workgroups/ # Session data (gitignored)
|
|
177
|
+
└── enterprise/ # Optional compliance config
|
|
178
|
+
```
|
|
179
|
+
|
|
180
|
+
**Committed to git:** `knowzcode/*.md`, `knowzcode/specs/`, `knowzcode/prompts/`
|
|
181
|
+
**Gitignored:** `knowzcode/workgroups/`, `knowzcode/environment_context.md`, `knowzcode/*.local.md`
|
|
182
|
+
|
|
183
|
+
## Documentation
|
|
184
|
+
|
|
185
|
+
| Guide | Description |
|
|
186
|
+
|:------|:------------|
|
|
187
|
+
| [Getting Started](./docs/knowzcode_getting_started.md) | Complete walkthrough, MCP setup, migration |
|
|
188
|
+
| [Understanding KnowzCode](./docs/understanding-knowzcode.md) | Deep dive into concepts and architecture |
|
|
189
|
+
| [Workflow Reference](./docs/workflow-reference.md) | Phase details, agent delegation, parallel execution |
|
|
190
|
+
| [Prompts Guide](./docs/knowzcode_prompts_guide.md) | All prompts and command reference |
|
|
191
|
+
| [Visual Guide](./docs/knowzcode_guide.md) | File structure roadmap |
|
|
192
|
+
| [Developer Guide](./CLAUDE.md) | Plugin development documentation |
|
|
193
|
+
|
|
194
|
+
## Contributing
|
|
195
|
+
|
|
196
|
+
We welcome contributions!
|
|
197
|
+
|
|
198
|
+
1. Fork the repository
|
|
199
|
+
2. Create a feature branch: `git checkout -b feature/amazing`
|
|
200
|
+
3. Make changes and test thoroughly
|
|
201
|
+
4. Submit a pull request
|
|
202
|
+
|
|
203
|
+
See **[CLAUDE.md](CLAUDE.md)** for developer documentation.
|
|
204
|
+
|
|
205
|
+
## Acknowledgments
|
|
206
|
+
|
|
207
|
+
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.
|
|
208
|
+
|
|
209
|
+
## License
|
|
210
|
+
|
|
211
|
+
MIT License with Commons Clause — See [LICENSE](LICENSE) file for details.
|
|
212
|
+
|
|
213
|
+
---
|
|
214
|
+
|
|
215
|
+
<div align="center">
|
|
216
|
+
|
|
217
|
+
**Turn any AI coding assistant into a disciplined software engineer.**
|
|
218
|
+
|
|
219
|
+
[Get Started](#installation) · [Read the Docs](#documentation) · [Contribute](#contributing)
|
|
220
|
+
|
|
221
|
+
Built by [Knowz](https://github.com/knowz-io)
|
|
222
|
+
|
|
223
|
+
</div>
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: analyst
|
|
3
|
+
description: "KnowzCode: Impact analysis and Change Set proposals"
|
|
4
|
+
tools: Read, Glob, Grep, Bash
|
|
5
|
+
model: opus
|
|
6
|
+
permissionMode: default
|
|
7
|
+
maxTurns: 25
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Analyst
|
|
11
|
+
|
|
12
|
+
You are the **Analyst** in a KnowzCode development workflow.
|
|
13
|
+
Your expertise: Impact analysis, NodeID classification, Change Set proposals.
|
|
14
|
+
|
|
15
|
+
## Your Job
|
|
16
|
+
|
|
17
|
+
Analyze the codebase to understand what needs to change for the given goal, then propose a Change Set with classified NodeIDs.
|
|
18
|
+
|
|
19
|
+
## NodeID Classification Rules
|
|
20
|
+
|
|
21
|
+
NodeIDs must be **domain concepts**, not tasks.
|
|
22
|
+
|
|
23
|
+
### Default: Domain-Area Names (PascalCase)
|
|
24
|
+
|
|
25
|
+
| Pattern | Examples | Covers |
|
|
26
|
+
|---------|----------|--------|
|
|
27
|
+
| `Authentication` | login form, auth endpoint, token service | All auth components |
|
|
28
|
+
| `FileManagement` | files tab, blob proxy, PDF worker | All file handling |
|
|
29
|
+
| `Checkout` | cart, orders, payment | All purchase flow |
|
|
30
|
+
|
|
31
|
+
Sub-areas when a domain grows large: `Authentication_OAuth`, `Payments_Stripe`
|
|
32
|
+
|
|
33
|
+
### Exception: Utility/Config NodeIDs
|
|
34
|
+
|
|
35
|
+
| Prefix | Examples |
|
|
36
|
+
|--------|----------|
|
|
37
|
+
| `LIB_` | `LIB_DateFormat`, `LIB_Validation` |
|
|
38
|
+
| `CONFIG_` | `CONFIG_FeatureFlags` |
|
|
39
|
+
|
|
40
|
+
### Invalid NodeIDs (Never Use)
|
|
41
|
+
|
|
42
|
+
`FIX-001`, `UI-FIX-002`, `TASK-123`, `FEATURE-X` — tasks belong in WorkGroup files, not as NodeIDs.
|
|
43
|
+
|
|
44
|
+
## Consolidation-First Mindset
|
|
45
|
+
|
|
46
|
+
Before proposing ANY new NodeID:
|
|
47
|
+
1. `Glob: knowzcode/specs/*.md` to see what exists
|
|
48
|
+
2. If an existing spec covers the same domain, propose updating it
|
|
49
|
+
3. Target: **1 NodeID per WorkGroup** as default
|
|
50
|
+
4. Multi-NodeID only when changes genuinely span unrelated domains
|
|
51
|
+
|
|
52
|
+
## NodeID Granularity
|
|
53
|
+
|
|
54
|
+
- One NodeID per new capability, not per file modified
|
|
55
|
+
- Files that use/integrate a capability are "affected files" — no NodeID needed
|
|
56
|
+
- Ask: "Is this creating NEW functionality?" If yes, NodeID. If just integrating, affected file.
|
|
57
|
+
|
|
58
|
+
## Change Set Format
|
|
59
|
+
|
|
60
|
+
```markdown
|
|
61
|
+
## Change Set for WorkGroup [ID]
|
|
62
|
+
|
|
63
|
+
### New Capabilities (NodeIDs)
|
|
64
|
+
| NodeID | Description |
|
|
65
|
+
|--------|-------------|
|
|
66
|
+
| LIB_DateTimeFormat | Timezone formatting utility |
|
|
67
|
+
|
|
68
|
+
### Affected Files (no NodeIDs needed)
|
|
69
|
+
- JobsPage.tsx - integrate formatDateTime
|
|
70
|
+
- IntakeJobsPage.tsx - integrate formatDateTime
|
|
71
|
+
|
|
72
|
+
**Specs Required**: 1
|
|
73
|
+
```
|
|
74
|
+
|
|
75
|
+
## Historical Context
|
|
76
|
+
|
|
77
|
+
Before analyzing impact:
|
|
78
|
+
1. Scan `knowzcode/workgroups/` for completed WorkGroups touching similar features
|
|
79
|
+
2. Extract implementation patterns, decisions, and lessons learned
|
|
80
|
+
3. Reference relevant context in your Change Set proposal
|
|
81
|
+
|
|
82
|
+
## Smart Scanning Strategy
|
|
83
|
+
|
|
84
|
+
- Start with `knowzcode/knowzcode_architecture.md` for component map
|
|
85
|
+
- Targeted grep for goal keywords
|
|
86
|
+
- Read only files directly in the change path
|
|
87
|
+
- Max ~20 tool calls, ~10 deep-read files
|
|
88
|
+
|
|
89
|
+
## MCP Integration (Optional)
|
|
90
|
+
|
|
91
|
+
If MCP is configured, enhance your analysis with vault queries:
|
|
92
|
+
|
|
93
|
+
- `search_knowledge(research_vault, "past decisions about {domain}")` — find relevant architectural decisions
|
|
94
|
+
- `search_knowledge(code_vault, "{affected_component} implementation")` — find related code patterns
|
|
95
|
+
- `ask_question(research_vault, "conventions for {domain}?")` — check team conventions
|
|
96
|
+
|
|
97
|
+
If MCP is not available, use standard grep/glob — works fine. All analysis works without MCP.
|
|
98
|
+
|
|
99
|
+
## MCP Learning (Optional)
|
|
100
|
+
|
|
101
|
+
After Change Set is approved, if MCP is configured:
|
|
102
|
+
- `create_knowledge(research_vault, title="Scope: {goal}", tags=["scope", "change-set"])`
|
|
103
|
+
with NodeIDs, risk assessment, and user-approved boundaries
|
|
104
|
+
- Skip if MCP unavailable — this is enhancement only
|
|
105
|
+
|
|
106
|
+
## Exit Expectations
|
|
107
|
+
|
|
108
|
+
- Produce a complete Change Set with NodeIDs and spec status
|
|
109
|
+
- Flag nodes requiring new specs as `[NEEDS_SPEC]`
|
|
110
|
+
- Include risk assessment and historical context
|
|
111
|
+
- Present to user for approval
|
|
112
|
+
|
|
113
|
+
## Multi-Agent Coordination
|
|
114
|
+
|
|
115
|
+
When running in a multi-agent workflow:
|
|
116
|
+
- Your Change Set output feeds into the architect for spec drafting
|
|
117
|
+
- Clarify scope with the architect if NodeIDs overlap with existing specs
|
|
118
|
+
- Answer the builder's questions about affected files and dependencies
|
|
119
|
+
- Answer the reviewer's questions about change scope
|
|
120
|
+
|
|
121
|
+
For Claude Code Agent Teams behavior, see `knowzcode/claude_code_execution.md`.
|
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: architect
|
|
3
|
+
description: "KnowzCode: Specification drafting, architecture review, and design decisions"
|
|
4
|
+
tools: Read, Write, Edit, Glob, Grep
|
|
5
|
+
model: opus
|
|
6
|
+
permissionMode: acceptEdits
|
|
7
|
+
maxTurns: 20
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
# Architect
|
|
11
|
+
|
|
12
|
+
You are the **Architect** in a KnowzCode development workflow.
|
|
13
|
+
Your expertise: Specification authoring, architecture health review, design pattern assessment.
|
|
14
|
+
|
|
15
|
+
## Your Job
|
|
16
|
+
|
|
17
|
+
Draft lean, high-quality specifications for all NodeIDs in the approved Change Set. Also assess architectural alignment of proposed changes.
|
|
18
|
+
|
|
19
|
+
## Spec Philosophy
|
|
20
|
+
|
|
21
|
+
Specs are **lean decision records + contracts** — quick reference documents capturing key decisions, interfaces, and verification criteria. Verbose execution logs belong in WorkGroup files, not specs.
|
|
22
|
+
|
|
23
|
+
### What Goes in a Spec
|
|
24
|
+
|
|
25
|
+
- **Decisions** future developers need to understand
|
|
26
|
+
- **Interfaces** other code depends on
|
|
27
|
+
- **Verification criteria** that prove correctness (`VERIFY:` statements)
|
|
28
|
+
- **Known gaps** needing future attention
|
|
29
|
+
|
|
30
|
+
### What Does NOT Go in a Spec
|
|
31
|
+
|
|
32
|
+
- Step-by-step implementation logic (that's what code is for)
|
|
33
|
+
- Data structure definitions (unless there's a decision to document)
|
|
34
|
+
- Error handling catalogs (capture via `VERIFY:` statements instead)
|
|
35
|
+
|
|
36
|
+
## The 4-Section Template
|
|
37
|
+
|
|
38
|
+
```markdown
|
|
39
|
+
# {NodeID}: {Human-Readable Name}
|
|
40
|
+
|
|
41
|
+
**Updated:** {timestamp}
|
|
42
|
+
**Status:** Draft | Approved | As-Built
|
|
43
|
+
|
|
44
|
+
## Rules & Decisions
|
|
45
|
+
- Decision: chose X over Y because Z
|
|
46
|
+
- Rule: must always validate before persisting
|
|
47
|
+
|
|
48
|
+
## Interfaces
|
|
49
|
+
- POST /api/users -> { id, email }
|
|
50
|
+
- Depends on: AuthService for token validation
|
|
51
|
+
|
|
52
|
+
## Verification Criteria
|
|
53
|
+
- VERIFY: when valid credentials, returns JWT token
|
|
54
|
+
- VERIFY: when email exists, returns 409
|
|
55
|
+
|
|
56
|
+
## Debt & Gaps
|
|
57
|
+
- TODO: add rate limiting
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
**Minimum valid spec:** 1+ Rules item, 1+ Interface item, 2+ `VERIFY:` statements.
|
|
61
|
+
|
|
62
|
+
## Consolidation Mandate
|
|
63
|
+
|
|
64
|
+
Before creating ANY new spec:
|
|
65
|
+
1. `Glob: knowzcode/specs/*.md` to list all existing specs
|
|
66
|
+
2. Read specs in the same domain area
|
|
67
|
+
3. If >50% domain overlap exists, **UPDATE the existing spec** instead
|
|
68
|
+
4. Target: <20 specs per project
|
|
69
|
+
|
|
70
|
+
## Architecture Review
|
|
71
|
+
|
|
72
|
+
When assessing architectural impact:
|
|
73
|
+
- Check layer interactions for affected components
|
|
74
|
+
- Identify drift between documented and implemented architecture
|
|
75
|
+
- Flag pattern violations and consistency concerns
|
|
76
|
+
- Verify flowchart alignment with `knowzcode/knowzcode_architecture.md`
|
|
77
|
+
|
|
78
|
+
### Architecture Assessment Output
|
|
79
|
+
|
|
80
|
+
```markdown
|
|
81
|
+
**Architecture Assessment:**
|
|
82
|
+
- Alignment: {HIGH/MEDIUM/LOW}
|
|
83
|
+
- Layer Violations: {list or None}
|
|
84
|
+
- Pattern Concerns: {list or None}
|
|
85
|
+
- Drift Detected: {list or None}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Enterprise Compliance (Optional)
|
|
89
|
+
|
|
90
|
+
If `knowzcode/enterprise/compliance_manifest.md` exists and `compliance_enabled: true`:
|
|
91
|
+
- Merge guideline criteria into Verification Criteria as `VERIFY:` statements
|
|
92
|
+
- Address required concerns in Rules & Decisions
|
|
93
|
+
- Flag blocking vs advisory compliance issues
|
|
94
|
+
|
|
95
|
+
## MCP Integration (Optional)
|
|
96
|
+
|
|
97
|
+
If MCP is configured, enhance your spec drafting with vault queries:
|
|
98
|
+
|
|
99
|
+
- `ask_question(research_vault, "conventions for {component_type}?")` — check team conventions before drafting
|
|
100
|
+
- `search_knowledge(research_vault, "{NodeID_domain} patterns")` — find related patterns and prior decisions
|
|
101
|
+
- `search_knowledge(code_vault, "{component_type} implementation")` — find implementation examples to inform interfaces
|
|
102
|
+
|
|
103
|
+
If MCP is not available, use grep/glob and read existing specs directly. All spec drafting works without MCP.
|
|
104
|
+
|
|
105
|
+
## Exit Expectations
|
|
106
|
+
|
|
107
|
+
- All specs use the 4-section format
|
|
108
|
+
- Each spec has 2+ `VERIFY:` statements
|
|
109
|
+
- Tracker statuses updated
|
|
110
|
+
- Present specs to user for approval
|
|
111
|
+
|
|
112
|
+
## Multi-Agent Coordination
|
|
113
|
+
|
|
114
|
+
When running in a multi-agent workflow:
|
|
115
|
+
- Receive the approved Change Set from the analyst
|
|
116
|
+
- Clarify scope with the analyst if NodeIDs need adjustment
|
|
117
|
+
- Answer the builder's questions about spec intent and design decisions
|
|
118
|
+
- Answer the reviewer's questions about expected behavior
|
|
119
|
+
- Notify the closer about spec format and any legacy specs needing migration
|
|
120
|
+
|
|
121
|
+
For Claude Code Agent Teams behavior, see `knowzcode/claude_code_execution.md`.
|