open-kioku 1.0.0 → 1.0.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/README.md +40 -7
- package/package.json +6 -6
package/README.md
CHANGED
|
@@ -18,6 +18,46 @@ ok --version
|
|
|
18
18
|
|
|
19
19
|
## Quick Start
|
|
20
20
|
|
|
21
|
+
### Index Your Repository
|
|
22
|
+
|
|
23
|
+
```sh
|
|
24
|
+
npm install -g open-kioku
|
|
25
|
+
ok init /absolute/path/to/repo
|
|
26
|
+
ok index /absolute/path/to/repo
|
|
27
|
+
ok doctor /absolute/path/to/repo
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Verify that the local index has useful evidence:
|
|
31
|
+
|
|
32
|
+
```sh
|
|
33
|
+
ok --repo /absolute/path/to/repo search "auth flow" --limit 5
|
|
34
|
+
ok --repo /absolute/path/to/repo plan "change auth flow" --format markdown
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Connect the same indexed repo to your LLM client:
|
|
38
|
+
|
|
39
|
+
```sh
|
|
40
|
+
ok mcp install claude --repo /absolute/path/to/repo
|
|
41
|
+
ok mcp install cursor --repo /absolute/path/to/repo
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Paste the printed MCP config snippet into Claude Code, Cursor, or another MCP-compatible client. Open Kioku runs locally over stdio and is read-only by default.
|
|
45
|
+
|
|
46
|
+
Ask the agent to use the index before editing:
|
|
47
|
+
|
|
48
|
+
```text
|
|
49
|
+
Use Open Kioku before editing. Check repo_status, search_code, get_definition,
|
|
50
|
+
get_references, impact_analysis, and find_tests_for_change. Build a plan first.
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
Keep the index fresh while you work:
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
ok watch /absolute/path/to/repo
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
### Try The Demo
|
|
60
|
+
|
|
21
61
|
Create and index a sample repository:
|
|
22
62
|
|
|
23
63
|
```sh
|
|
@@ -34,13 +74,6 @@ ok --repo ./open-kioku-demo plan token --format markdown
|
|
|
34
74
|
ok prove ./open-kioku-demo --task token
|
|
35
75
|
```
|
|
36
76
|
|
|
37
|
-
Generate MCP client configuration:
|
|
38
|
-
|
|
39
|
-
```sh
|
|
40
|
-
ok mcp install claude --repo /absolute/path/to/repo
|
|
41
|
-
ok mcp install cursor --repo /absolute/path/to/repo
|
|
42
|
-
```
|
|
43
|
-
|
|
44
77
|
## Package Layout
|
|
45
78
|
|
|
46
79
|
The `open-kioku` npm package is a small JavaScript wrapper. It installs one platform-specific optional dependency containing the native `ok` binary for your operating system and CPU architecture.
|
package/package.json
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "open-kioku",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "Local-first code intelligence MCP for AI coding agents",
|
|
5
5
|
"bin": {
|
|
6
6
|
"ok": "./bin/ok.js",
|
|
7
7
|
"open-kioku": "./bin/ok.js"
|
|
8
8
|
},
|
|
9
9
|
"optionalDependencies": {
|
|
10
|
-
"@open-kioku/darwin-x64": "1.0.
|
|
11
|
-
"@open-kioku/darwin-arm64": "1.0.
|
|
12
|
-
"@open-kioku/linux-x64": "1.0.
|
|
13
|
-
"@open-kioku/linux-arm64": "1.0.
|
|
14
|
-
"@open-kioku/win32-x64": "1.0.
|
|
10
|
+
"@open-kioku/darwin-x64": "1.0.1",
|
|
11
|
+
"@open-kioku/darwin-arm64": "1.0.1",
|
|
12
|
+
"@open-kioku/linux-x64": "1.0.1",
|
|
13
|
+
"@open-kioku/linux-arm64": "1.0.1",
|
|
14
|
+
"@open-kioku/win32-x64": "1.0.1"
|
|
15
15
|
},
|
|
16
16
|
"repository": {
|
|
17
17
|
"type": "git",
|