kodebrain 0.1.0__tar.gz
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.
- kodebrain-0.1.0/.gitignore +5 -0
- kodebrain-0.1.0/PKG-INFO +65 -0
- kodebrain-0.1.0/README.md +56 -0
- kodebrain-0.1.0/SKILL.md +572 -0
- kodebrain-0.1.0/docs/design/agents.md +247 -0
- kodebrain-0.1.0/docs/design/open-decisions.md +210 -0
- kodebrain-0.1.0/docs/design/skills.md +347 -0
- kodebrain-0.1.0/docs/design/taxonomy.md +160 -0
- kodebrain-0.1.0/docs/design/workflows.md +334 -0
- kodebrain-0.1.0/kodebrain/__init__.py +1 -0
- kodebrain-0.1.0/kodebrain/cli.py +116 -0
- kodebrain-0.1.0/kodebrain/hook.py +90 -0
- kodebrain-0.1.0/kodebrain/install.py +179 -0
- kodebrain-0.1.0/obsidian-vault-config/app.json +6 -0
- kodebrain-0.1.0/obsidian-vault-config/graph.json +59 -0
- kodebrain-0.1.0/pyproject.toml +21 -0
- kodebrain-0.1.0/schema/edge.schema.json +123 -0
- kodebrain-0.1.0/schema/knowledge-base.schema.json +89 -0
- kodebrain-0.1.0/schema/node.schema.json +138 -0
- kodebrain-0.1.0/scripts/harvest.py +749 -0
- kodebrain-0.1.0/templates/capability.md +69 -0
- kodebrain-0.1.0/templates/concept.md +57 -0
- kodebrain-0.1.0/templates/decision.md +43 -0
- kodebrain-0.1.0/templates/domain.md +69 -0
- kodebrain-0.1.0/templates/flow.md +77 -0
- kodebrain-0.1.0/templates/model.md +63 -0
- kodebrain-0.1.0/templates/risk.md +50 -0
kodebrain-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: kodebrain
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Living knowledge map for codebases — install agent instructions across AI platforms
|
|
5
|
+
Project-URL: Homepage, https://github.com/mekku/kb-builder
|
|
6
|
+
License: MIT
|
|
7
|
+
Requires-Python: >=3.9
|
|
8
|
+
Description-Content-Type: text/markdown
|
|
9
|
+
|
|
10
|
+
# kb-builder
|
|
11
|
+
|
|
12
|
+
**Kode Brain** — a living knowledge system for evolving software projects.
|
|
13
|
+
|
|
14
|
+
Converts an imperfect, growing codebase into a structured, searchable knowledge map of domains, capabilities, concepts, flows, runtime behavior, dependencies, legacy areas, migration states, and source evidence — so humans and AI agents can understand and modify the system without rediscovering everything from scratch.
|
|
15
|
+
|
|
16
|
+
## Design Documents
|
|
17
|
+
|
|
18
|
+
| Document | Purpose |
|
|
19
|
+
|---|---|
|
|
20
|
+
| [Taxonomy](docs/design/taxonomy.md) | Finalized node types, edge types, status labels, confidence labels |
|
|
21
|
+
| [Skills](docs/design/skills.md) | Skill API contracts — inputs, outputs, guarantees |
|
|
22
|
+
| [Agents](docs/design/agents.md) | Agent role boundaries — responsibilities, allowed skills, forbidden actions |
|
|
23
|
+
| [Workflows](docs/design/workflows.md) | Core workflow sequence diagrams |
|
|
24
|
+
| [Open Decisions](docs/design/open-decisions.md) | Unresolved architectural decisions |
|
|
25
|
+
|
|
26
|
+
## Schemas
|
|
27
|
+
|
|
28
|
+
| File | Purpose |
|
|
29
|
+
|---|---|
|
|
30
|
+
| [schema/node.schema.json](schema/node.schema.json) | JSON Schema for KnowledgeNode |
|
|
31
|
+
| [schema/edge.schema.json](schema/edge.schema.json) | JSON Schema for KnowledgeEdge |
|
|
32
|
+
| [schema/knowledge-base.schema.json](schema/knowledge-base.schema.json) | Top-level graph container schema |
|
|
33
|
+
|
|
34
|
+
## Design Order
|
|
35
|
+
|
|
36
|
+
Per the Kode Brain spec (§20.7):
|
|
37
|
+
|
|
38
|
+
```
|
|
39
|
+
Taxonomy → Workflow → Skills → Agents → Plugin/CLI
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
This repository is currently at the **design phase**. Implementation comes after the design is validated.
|
|
43
|
+
|
|
44
|
+
## Commands
|
|
45
|
+
|
|
46
|
+
```
|
|
47
|
+
/kodebrain init [path] Scan project, scaffold docs/kodebrain/
|
|
48
|
+
/kodebrain scan [path] Re-scan and update knowledge graph
|
|
49
|
+
/kodebrain query "<task or symptom>" Query the KB by task description
|
|
50
|
+
/kodebrain reading-pack "<task>" Generate + save a context pack
|
|
51
|
+
/kodebrain detect-legacy [--domain slug] Flag suspected dead code
|
|
52
|
+
/kodebrain review [--page path] Review KB pages for stale claims
|
|
53
|
+
/kodebrain update [--diff] [--files ...] Update KB from changed files
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Installation
|
|
57
|
+
|
|
58
|
+
The skill must be installed into Claude Code's skills directory:
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
# From the repo root
|
|
62
|
+
ln -s "$(pwd)" ~/.claude/skills/kodebrain
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
After symlinking, `SKILL.md` is discoverable by Claude Code and `/kodebrain` becomes available in any Claude Code session.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# kb-builder
|
|
2
|
+
|
|
3
|
+
**Kode Brain** — a living knowledge system for evolving software projects.
|
|
4
|
+
|
|
5
|
+
Converts an imperfect, growing codebase into a structured, searchable knowledge map of domains, capabilities, concepts, flows, runtime behavior, dependencies, legacy areas, migration states, and source evidence — so humans and AI agents can understand and modify the system without rediscovering everything from scratch.
|
|
6
|
+
|
|
7
|
+
## Design Documents
|
|
8
|
+
|
|
9
|
+
| Document | Purpose |
|
|
10
|
+
|---|---|
|
|
11
|
+
| [Taxonomy](docs/design/taxonomy.md) | Finalized node types, edge types, status labels, confidence labels |
|
|
12
|
+
| [Skills](docs/design/skills.md) | Skill API contracts — inputs, outputs, guarantees |
|
|
13
|
+
| [Agents](docs/design/agents.md) | Agent role boundaries — responsibilities, allowed skills, forbidden actions |
|
|
14
|
+
| [Workflows](docs/design/workflows.md) | Core workflow sequence diagrams |
|
|
15
|
+
| [Open Decisions](docs/design/open-decisions.md) | Unresolved architectural decisions |
|
|
16
|
+
|
|
17
|
+
## Schemas
|
|
18
|
+
|
|
19
|
+
| File | Purpose |
|
|
20
|
+
|---|---|
|
|
21
|
+
| [schema/node.schema.json](schema/node.schema.json) | JSON Schema for KnowledgeNode |
|
|
22
|
+
| [schema/edge.schema.json](schema/edge.schema.json) | JSON Schema for KnowledgeEdge |
|
|
23
|
+
| [schema/knowledge-base.schema.json](schema/knowledge-base.schema.json) | Top-level graph container schema |
|
|
24
|
+
|
|
25
|
+
## Design Order
|
|
26
|
+
|
|
27
|
+
Per the Kode Brain spec (§20.7):
|
|
28
|
+
|
|
29
|
+
```
|
|
30
|
+
Taxonomy → Workflow → Skills → Agents → Plugin/CLI
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
This repository is currently at the **design phase**. Implementation comes after the design is validated.
|
|
34
|
+
|
|
35
|
+
## Commands
|
|
36
|
+
|
|
37
|
+
```
|
|
38
|
+
/kodebrain init [path] Scan project, scaffold docs/kodebrain/
|
|
39
|
+
/kodebrain scan [path] Re-scan and update knowledge graph
|
|
40
|
+
/kodebrain query "<task or symptom>" Query the KB by task description
|
|
41
|
+
/kodebrain reading-pack "<task>" Generate + save a context pack
|
|
42
|
+
/kodebrain detect-legacy [--domain slug] Flag suspected dead code
|
|
43
|
+
/kodebrain review [--page path] Review KB pages for stale claims
|
|
44
|
+
/kodebrain update [--diff] [--files ...] Update KB from changed files
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
## Installation
|
|
48
|
+
|
|
49
|
+
The skill must be installed into Claude Code's skills directory:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
# From the repo root
|
|
53
|
+
ln -s "$(pwd)" ~/.claude/skills/kodebrain
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
After symlinking, `SKILL.md` is discoverable by Claude Code and `/kodebrain` becomes available in any Claude Code session.
|