open-kioku 0.1.3 → 1.0.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/README.md +61 -0
- package/package.json +15 -10
package/README.md
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# Open Kioku
|
|
2
|
+
|
|
3
|
+
Local-first code intelligence for AI coding agents.
|
|
4
|
+
|
|
5
|
+
Open Kioku indexes a repository on your machine and exposes fast code search, symbol navigation, impact analysis, context packs, and MCP tools through the `ok` CLI.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```sh
|
|
10
|
+
npm install -g open-kioku
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Then verify the installed binary:
|
|
14
|
+
|
|
15
|
+
```sh
|
|
16
|
+
ok --version
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Quick Start
|
|
20
|
+
|
|
21
|
+
Create and index a sample repository:
|
|
22
|
+
|
|
23
|
+
```sh
|
|
24
|
+
ok demo --force
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Search and inspect the demo:
|
|
28
|
+
|
|
29
|
+
```sh
|
|
30
|
+
ok --repo ./open-kioku-demo search token
|
|
31
|
+
ok --repo ./open-kioku-demo symbol find issue_token
|
|
32
|
+
ok --repo ./open-kioku-demo impact --file src/auth.rs
|
|
33
|
+
ok --repo ./open-kioku-demo plan token --format markdown
|
|
34
|
+
ok prove ./open-kioku-demo --task token
|
|
35
|
+
```
|
|
36
|
+
|
|
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
|
+
## Package Layout
|
|
45
|
+
|
|
46
|
+
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.
|
|
47
|
+
|
|
48
|
+
Supported packages:
|
|
49
|
+
|
|
50
|
+
- `@open-kioku/darwin-x64`
|
|
51
|
+
- `@open-kioku/darwin-arm64`
|
|
52
|
+
- `@open-kioku/linux-x64`
|
|
53
|
+
- `@open-kioku/linux-arm64`
|
|
54
|
+
- `@open-kioku/win32-x64`
|
|
55
|
+
|
|
56
|
+
## Links
|
|
57
|
+
|
|
58
|
+
- Repository: https://github.com/shivyadavus/open-kioku
|
|
59
|
+
- Releases: https://github.com/shivyadavus/open-kioku/releases
|
|
60
|
+
- Demo: https://shivyadavus.github.io/open-kioku/
|
|
61
|
+
- Security: https://github.com/shivyadavus/open-kioku/blob/main/SECURITY.md
|
package/package.json
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "open-kioku",
|
|
3
|
-
"version": "0.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "1.0.0",
|
|
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": "0.
|
|
11
|
-
"@open-kioku/darwin-arm64": "0.
|
|
12
|
-
"@open-kioku/linux-x64": "0.
|
|
13
|
-
"@open-kioku/linux-arm64": "0.
|
|
14
|
-
"@open-kioku/win32-x64": "0.
|
|
10
|
+
"@open-kioku/darwin-x64": "1.0.0",
|
|
11
|
+
"@open-kioku/darwin-arm64": "1.0.0",
|
|
12
|
+
"@open-kioku/linux-x64": "1.0.0",
|
|
13
|
+
"@open-kioku/linux-arm64": "1.0.0",
|
|
14
|
+
"@open-kioku/win32-x64": "1.0.0"
|
|
15
15
|
},
|
|
16
16
|
"repository": {
|
|
17
17
|
"type": "git",
|
|
@@ -19,17 +19,22 @@
|
|
|
19
19
|
},
|
|
20
20
|
"keywords": [
|
|
21
21
|
"mcp",
|
|
22
|
+
"mcp-server",
|
|
22
23
|
"ai",
|
|
24
|
+
"ai-agents",
|
|
23
25
|
"llm",
|
|
24
|
-
"
|
|
26
|
+
"claude",
|
|
27
|
+
"cursor",
|
|
28
|
+
"code-intelligence",
|
|
25
29
|
"tree-sitter",
|
|
26
30
|
"code-index",
|
|
27
|
-
"context"
|
|
31
|
+
"context",
|
|
32
|
+
"local-first"
|
|
28
33
|
],
|
|
29
34
|
"author": "Open Kioku",
|
|
30
35
|
"license": "Elastic-2.0",
|
|
31
36
|
"bugs": {
|
|
32
37
|
"url": "https://github.com/shivyadavus/open-kioku/issues"
|
|
33
38
|
},
|
|
34
|
-
"homepage": "https://shivyadavus.github.io/open-kioku/
|
|
39
|
+
"homepage": "https://shivyadavus.github.io/open-kioku/"
|
|
35
40
|
}
|