@knolo/cli 3.1.2 → 3.1.3
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 +117 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
# @knolo/cli
|
|
2
|
+
|
|
3
|
+
The official CLI for building `.knolo` knowledge packs.
|
|
4
|
+
|
|
5
|
+
It indexes structured content and produces a deterministic, local-first knowledge bundle for use with `@knolo/core`.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 📦 Installation
|
|
10
|
+
|
|
11
|
+
Global:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install -g @knolo/cli
|
|
15
|
+
````
|
|
16
|
+
|
|
17
|
+
Or use via npx:
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
npx knolo build
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
---
|
|
24
|
+
|
|
25
|
+
## 🚀 Commands
|
|
26
|
+
|
|
27
|
+
### Build a Knowledge Pack
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
knolo build
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Indexes your configured content and outputs:
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
dist/knowledge.knolo
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## 📁 Expected Project Structure
|
|
42
|
+
|
|
43
|
+
Example:
|
|
44
|
+
|
|
45
|
+
```
|
|
46
|
+
/knowledge
|
|
47
|
+
mobile.json
|
|
48
|
+
backend.json
|
|
49
|
+
knolo.config.ts
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## ⚙️ knolo.config.ts Example
|
|
55
|
+
|
|
56
|
+
```ts
|
|
57
|
+
export default {
|
|
58
|
+
input: "./knowledge",
|
|
59
|
+
output: "./dist/knowledge.knolo"
|
|
60
|
+
};
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
---
|
|
64
|
+
|
|
65
|
+
## 🧱 What the CLI Does
|
|
66
|
+
|
|
67
|
+
* Parses structured documents
|
|
68
|
+
* Normalizes metadata
|
|
69
|
+
* Indexes namespaces
|
|
70
|
+
* Extracts agent routing profiles
|
|
71
|
+
* Validates agent registry
|
|
72
|
+
* Generates compact `.knolo` bundle
|
|
73
|
+
|
|
74
|
+
All builds are deterministic.
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
## 🧠 Agent Features
|
|
79
|
+
|
|
80
|
+
Phase 2 includes:
|
|
81
|
+
|
|
82
|
+
* Routing profile extraction
|
|
83
|
+
* Tool policy validation
|
|
84
|
+
* Mount-time registry validation
|
|
85
|
+
* Deterministic selection logic
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## 🔍 Why No Embeddings?
|
|
90
|
+
|
|
91
|
+
KnoLo intentionally avoids:
|
|
92
|
+
|
|
93
|
+
* Vector databases
|
|
94
|
+
* Similarity search
|
|
95
|
+
* External inference APIs
|
|
96
|
+
|
|
97
|
+
This ensures:
|
|
98
|
+
|
|
99
|
+
* Reproducibility
|
|
100
|
+
* Security
|
|
101
|
+
* Low memory usage
|
|
102
|
+
* Predictable results
|
|
103
|
+
|
|
104
|
+
---
|
|
105
|
+
|
|
106
|
+
## 🗺 Roadmap
|
|
107
|
+
|
|
108
|
+
* Watch mode
|
|
109
|
+
* Incremental indexing
|
|
110
|
+
* Rust-powered build engine
|
|
111
|
+
* WASM build output
|
|
112
|
+
|
|
113
|
+
---
|
|
114
|
+
|
|
115
|
+
## 📄 License
|
|
116
|
+
|
|
117
|
+
MIT
|