@vonneollc/knbase 0.1.0 → 0.1.1
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/LICENSE +21 -0
- package/README.md +28 -15
- package/package.json +1 -1
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 vonneollc
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -35,20 +35,14 @@ System artifacts live in `.knbase/` (`config.json`, `index.json`,
|
|
|
35
35
|
|
|
36
36
|
## Quick setup (recommended, no clone)
|
|
37
37
|
|
|
38
|
-
|
|
39
|
-
you can use it without cloning this repo.
|
|
40
|
-
|
|
41
|
-
Install it once, globally:
|
|
42
|
-
|
|
43
|
-
```bash
|
|
44
|
-
npm install -g knbase
|
|
45
|
-
```
|
|
38
|
+
The package is published as [`@vonneollc/knbase`](https://www.npmjs.com/package/@vonneollc/knbase),
|
|
39
|
+
so you can use it without cloning this repo.
|
|
46
40
|
|
|
47
41
|
**1. Initialize governance in your project:**
|
|
48
42
|
|
|
49
43
|
```bash
|
|
50
44
|
cd /path/to/your/project
|
|
51
|
-
knbase init
|
|
45
|
+
npx -y --package @vonneollc/knbase knbase init
|
|
52
46
|
```
|
|
53
47
|
|
|
54
48
|
**2. Register the MCP server** with your agent. Cursor example
|
|
@@ -58,28 +52,39 @@ knbase init
|
|
|
58
52
|
{
|
|
59
53
|
"mcpServers": {
|
|
60
54
|
"knbase": {
|
|
61
|
-
"command": "
|
|
55
|
+
"command": "npx",
|
|
56
|
+
"args": ["-y", "--package", "@vonneollc/knbase", "knbase-mcp"],
|
|
62
57
|
"env": { "KNBASE_ROOT": "/absolute/path/to/your/project" }
|
|
63
58
|
}
|
|
64
59
|
}
|
|
65
60
|
}
|
|
66
61
|
```
|
|
67
62
|
|
|
68
|
-
|
|
63
|
+
> **macOS / GUI apps:** apps like Cursor often don't inherit your shell `PATH`,
|
|
64
|
+
> so `npx` (or `knbase-mcp`) may not be found. If the server fails to start, use
|
|
65
|
+
> an absolute path for `command`. Find it with `which npx` (e.g.
|
|
66
|
+
> `/opt/homebrew/bin/npx` for Homebrew Node), then set
|
|
67
|
+
> `"command": "/opt/homebrew/bin/npx"`.
|
|
68
|
+
|
|
69
|
+
Prefer a global install? Then the bins are available directly:
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
npm install -g @vonneollc/knbase
|
|
73
|
+
which knbase-mcp # e.g. /opt/homebrew/bin/knbase-mcp
|
|
74
|
+
```
|
|
69
75
|
|
|
70
76
|
```json
|
|
71
77
|
{
|
|
72
78
|
"mcpServers": {
|
|
73
79
|
"knbase": {
|
|
74
|
-
"command": "
|
|
75
|
-
"args": ["-y", "--package", "knbase", "knbase-mcp"],
|
|
80
|
+
"command": "/opt/homebrew/bin/knbase-mcp",
|
|
76
81
|
"env": { "KNBASE_ROOT": "/absolute/path/to/your/project" }
|
|
77
82
|
}
|
|
78
83
|
}
|
|
79
84
|
}
|
|
80
85
|
```
|
|
81
86
|
|
|
82
|
-
…and run CLI commands with `
|
|
87
|
+
…and run CLI commands with `knbase <command>` (e.g. `knbase init`).
|
|
83
88
|
|
|
84
89
|
`KNBASE_ROOT` is optional; if omitted the server resolves the project root by
|
|
85
90
|
walking up from the working directory (looking for `.knbase/` or `.git`). Each
|
|
@@ -177,6 +182,14 @@ npm run dev:mcp # run the MCP server with tsx
|
|
|
177
182
|
npm run dev:cli -- status
|
|
178
183
|
```
|
|
179
184
|
|
|
185
|
+
## Contributing
|
|
186
|
+
|
|
187
|
+
Contributions are welcome from everyone. Fork the repo, create a branch, and
|
|
188
|
+
open a pull request. Bug reports and feature ideas via issues are equally
|
|
189
|
+
appreciated. By contributing you agree that your contributions are licensed
|
|
190
|
+
under the project's MIT license.
|
|
191
|
+
|
|
180
192
|
## License
|
|
181
193
|
|
|
182
|
-
MIT
|
|
194
|
+
Released under the [MIT License](./LICENSE) — free to use, modify, distribute,
|
|
195
|
+
and build upon, including commercially.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vonneollc/knbase",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Agent-agnostic AI project governance and memory system. Forces AI agents to read governance docs before acting, bootstraps them if missing, forces updates after each task, and maintains a combined mind map and activity log.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|