open-kioku 0.1.4 → 1.0.1

package/README.md

@@ -18,27 +18,62 @@ ok --version
 
 ## Quick Start
 
-Create and index a sample repository:
+### Index Your Repository
 
 ```sh
-ok demo --force
+npm install -g open-kioku
+ok init /absolute/path/to/repo
+ok index /absolute/path/to/repo
+ok doctor /absolute/path/to/repo
 ```
 
-Search and inspect the demo:
+Verify that the local index has useful evidence:
 
 ```sh
-ok --repo ./open-kioku-demo search token
-ok --repo ./open-kioku-demo symbol find issue_token
-ok --repo ./open-kioku-demo impact --file src/auth.rs
+ok --repo /absolute/path/to/repo search "auth flow" --limit 5
+ok --repo /absolute/path/to/repo plan "change auth flow" --format markdown
 ```
 
-Generate MCP client configuration:
+Connect the same indexed repo to your LLM client:
 
 ```sh
 ok mcp install claude --repo /absolute/path/to/repo
 ok mcp install cursor --repo /absolute/path/to/repo
 ```
 
+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.
+
+Ask the agent to use the index before editing:
+
+```text
+Use Open Kioku before editing. Check repo_status, search_code, get_definition,
+get_references, impact_analysis, and find_tests_for_change. Build a plan first.
+```
+
+Keep the index fresh while you work:
+
+```sh
+ok watch /absolute/path/to/repo
+```
+
+### Try The Demo
+
+Create and index a sample repository:
+
+```sh
+ok demo --force
+```
+
+Search and inspect the demo:
+
+```sh
+ok --repo ./open-kioku-demo search token
+ok --repo ./open-kioku-demo symbol find issue_token
+ok --repo ./open-kioku-demo impact --file src/auth.rs
+ok --repo ./open-kioku-demo plan token --format markdown
+ok prove ./open-kioku-demo --task token
+```
+
 ## Package Layout
 
 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.
@@ -55,5 +90,5 @@ Supported packages:
 
 - Repository: https://github.com/shivyadavus/open-kioku
 - Releases: https://github.com/shivyadavus/open-kioku/releases
-- Demo: https://shivyadavus.github.io/open-kioku/demo/index.html
-
+- Demo: https://shivyadavus.github.io/open-kioku/
+- Security: https://github.com/shivyadavus/open-kioku/blob/main/SECURITY.md

package/package.json

@@ -1,17 +1,17 @@
 {
   "name": "open-kioku",
-  "version": "0.1.4",
-  "description": "A blazing-fast, language-aware codebase index and semantic search engine for AI agents (MCP)",
+  "version": "1.0.1",
+  "description": "Local-first code intelligence MCP for AI coding agents",
   "bin": {
     "ok": "./bin/ok.js",
     "open-kioku": "./bin/ok.js"
   },
   "optionalDependencies": {
-    "@open-kioku/darwin-x64": "0.1.4",
-    "@open-kioku/darwin-arm64": "0.1.4",
-    "@open-kioku/linux-x64": "0.1.4",
-    "@open-kioku/linux-arm64": "0.1.4",
-    "@open-kioku/win32-x64": "0.1.4"
+    "@open-kioku/darwin-x64": "1.0.1",
+    "@open-kioku/darwin-arm64": "1.0.1",
+    "@open-kioku/linux-x64": "1.0.1",
+    "@open-kioku/linux-arm64": "1.0.1",
+    "@open-kioku/win32-x64": "1.0.1"
   },
   "repository": {
     "type": "git",
@@ -19,17 +19,22 @@
   },
   "keywords": [
     "mcp",
+    "mcp-server",
     "ai",
+    "ai-agents",
     "llm",
-    "semantic-search",
+    "claude",
+    "cursor",
+    "code-intelligence",
     "tree-sitter",
     "code-index",
-    "context"
+    "context",
+    "local-first"
   ],
   "author": "Open Kioku",
   "license": "Elastic-2.0",
   "bugs": {
     "url": "https://github.com/shivyadavus/open-kioku/issues"
   },
-  "homepage": "https://shivyadavus.github.io/open-kioku/demo/index.html"
+  "homepage": "https://shivyadavus.github.io/open-kioku/"
 }