@inkeep/open-knowledge 0.9.0-beta.29 → 0.9.0-beta.30
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/dist/assets/skills/discovery/SKILL.md +1 -1
- package/dist/assets/skills/project/SKILL.md +4 -3
- package/dist/cli.mjs +43 -43
- package/dist/constants-nygsGL1t.mjs +2 -0
- package/dist/dist-DFlSVgXA.mjs +1 -0
- package/dist/{dist-Bgfgx-ED.mjs → dist-DpfmiCV4.mjs} +6 -6
- package/dist/index.mjs +1 -1
- package/dist/{init-AqwH3_Z1.mjs → init-BnZOMZQO.mjs} +21 -21
- package/dist/init-D1mwIDbj.mjs +1 -0
- package/dist/loader-C_bcUreu.mjs +1 -0
- package/dist/{loader-D--Bn2qd.mjs → loader-DDiDxthB.mjs} +2 -2
- package/dist/{preview-CCsLMa5f.mjs → preview-CSNkLWHD.mjs} +2 -2
- package/dist/preview-CirVU2JW.mjs +1 -0
- package/dist/{repair-launch-json-Cf5aidZ-.mjs → repair-launch-json-D2yuZ2m2.mjs} +2 -2
- package/dist/{repair-mcp-configs-CQcAfhF-.mjs → repair-mcp-configs-BoZZdQfe.mjs} +2 -2
- package/dist/{repair-skills-D8EM4M-V.mjs → repair-skills-BSxYtEdR.mjs} +2 -2
- package/dist/repair-skills-BwSKUIVg.mjs +1 -0
- package/dist/{src-D4PeSWPS.mjs → src-DlZY1w-G.mjs} +2 -2
- package/dist/start-Cenma9Sz.mjs +1 -0
- package/dist/{start-Cx4TGgyT.mjs → start-Gdo8a38H.mjs} +2 -2
- package/dist/{write-project-skill-qNALBb1N.mjs → write-project-skill-PXFMiJn0.mjs} +2 -2
- package/package.json +1 -1
- package/dist/constants-DmtB2F4y.mjs +0 -2
- package/dist/dist-VW9VvVj2.mjs +0 -1
- package/dist/init-WiLkATHG.mjs +0 -1
- package/dist/loader-7XBcgb4m.mjs +0 -1
- package/dist/preview-HzacAuXR.mjs +0 -1
- package/dist/repair-skills-C0yYFa_K.mjs +0 -1
- package/dist/start-CVgnn0ll.mjs +0 -1
|
@@ -3,7 +3,7 @@ name: open-knowledge-discovery
|
|
|
3
3
|
description: "Read when the user asks what Open Knowledge is, wants to install it on a repository, wants to share an Open Knowledge project with collaborators, or asks how `ok init` / `ok install-skill` / OK Desktop set up a project. Do NOT load to perform Open Knowledge reads/writes — the runtime guidance for editing markdown inside an initialized OK project ships as a separate project-local skill at `.claude/skills/open-knowledge/` whenever `ok init` runs. If the user appears to be editing markdown inside a `.ok/` project and this is the only OK skill loaded, advise them to re-run `ok init` to install the project-local skill."
|
|
4
4
|
compatibility: "Any agent host — no MCP server required. Pure discovery + install guidance."
|
|
5
5
|
metadata:
|
|
6
|
-
version: "0.9.0-beta.
|
|
6
|
+
version: "0.9.0-beta.30"
|
|
7
7
|
author: "Inkeep"
|
|
8
8
|
repository: "https://github.com/inkeep/open-knowledge"
|
|
9
9
|
---
|
|
@@ -3,7 +3,7 @@ name: open-knowledge
|
|
|
3
3
|
description: "MUST invoke before reading or editing any `.md` / `.mdx` file, and before any `mcp__open-knowledge__*` tool call (`exec`, `search`, `write_document`, `edit_document`, and the rest). This skill is installed into the repository by `ok init`, so its presence alone means this is an Open Knowledge project — its runtime contract governs every markdown file here, with no need to probe for a `.ok/` directory. Authoritative agent-runtime contract; supersedes the overlapping MCP server `instructions` echo."
|
|
4
4
|
compatibility: "Claude Code, Claude Desktop, Claude Cowork, Claude.ai web. Requires Open Knowledge MCP server + code execution."
|
|
5
5
|
metadata:
|
|
6
|
-
version: "0.9.0-beta.
|
|
6
|
+
version: "0.9.0-beta.30"
|
|
7
7
|
author: "Inkeep"
|
|
8
8
|
repository: "https://github.com/inkeep/open-knowledge"
|
|
9
9
|
---
|
|
@@ -19,7 +19,7 @@ Open Knowledge (OK) is a markdown-CRDT collaboration platform exposed via MCP. T
|
|
|
19
19
|
|
|
20
20
|
1. **Reads:** `exec("cat …")` for a single doc, `exec("ls -A …")` for a directory (with folder defaults + template menu), `exec("grep …")` for literal, `search` for ranked retrieval. Native `Read` / `Grep` only on source code (`.ts` / `.py` / …), never on in-scope `.md` / `.mdx`.
|
|
21
21
|
2. **Writes:** `write_document` for new or full-replace, `edit_document` for body-only find/replace, `edit_frontmatter` for 1-2 frontmatter keys (JSON Merge Patch — preferred). Full frontmatter rewrites use `write_document({ position: "replace" })`. `edit_document` rejects frontmatter (HTTP 400).
|
|
22
|
-
3. **Preview:** every OK read/write response carries a route-only `previewUrl` (`/#/<doc>`, no host:port). If you have a `preview_*` tool, call `preview_start("open-knowledge-ui")`;
|
|
22
|
+
3. **Preview:** every OK read/write response carries a route-only `previewUrl` (`/#/<doc>`, no host:port). If you have a `preview_*` tool, call `preview_start("open-knowledge-ui")`; if you have an in-app browser, call `get_preview_url` once for the full browser URL and navigate to it; on the Claude Code CLI (no browser tool), run `ok open <doc>` to open it in the OK Desktop app. Surface to the user on a `start-ui` warning (no UI running). Don't `preview_screenshot` to confirm edits — the CRDT tool response is the confirmation.
|
|
23
23
|
4. **Workflow tools** (`ingest` / `research` / `consolidate` / `discover`) return procedural guides, not data. Use them when the work fits the layer; follow their numbered steps.
|
|
24
24
|
|
|
25
25
|
Everything below is depth. Read on demand.
|
|
@@ -72,7 +72,7 @@ The user watches your edits land in a live browser preview. Open it once at sess
|
|
|
72
72
|
|
|
73
73
|
- **You have a `preview_*` tool** (e.g. `preview_start`) → call `preview_start("open-knowledge-ui")`; the pane supplies its own origin. To land the pane on a specific target, arm it first: `get_preview_url({ armPaneTarget: true, docName })` (or `folder`) writes a ~30s target so the next base-open lands there. Don't read or edit `.claude/launch.json` — host-managed; the OK lock-collision proxy handles the UI-already-running case. If `preview_start` fails, report it; don't "fix" `launch.json`.
|
|
74
74
|
- **No `preview_*` tool, but you have an in-app / built-in browser tool** — Codex's built-in browser, or any host tool that navigates to a URL (`browser`, `view_url`, `open_url`, `web.browse`, etc.) → call `get_preview_url` once for the **exact** target (`docName` for a doc, `folder` for a folder) and navigate your **in-app browser** straight to the returned `url`. Open that deep URL directly — never the root then navigate. Omit both args only for the root.
|
|
75
|
-
- **Truly no browser-capable tool — if you have ANY tool that navigates to a URL, use the in-app branch above** (a pure stdio host with no URL-navigation tool at all) →
|
|
75
|
+
- **Truly no browser-capable tool — if you have ANY tool that navigates to a URL, use the in-app branch above** (a pure stdio host with no URL-navigation tool at all, e.g. the Claude Code CLI) → for an "open `<doc>`/`<folder>`" request, run **`ok open <doc>`** (`--folder` for a folder) — opens the doc in OK Desktop via deep link (folders in the browser), with browser fallback; an action, not a URL to print. No `ok` on PATH or no shell → `get_preview_url`, then `open <url>` in the system browser as a last resort, and say so plainly. The system browser is the fallback, never the default.
|
|
76
76
|
- **Honor `autoOpen`** (on `get_preview_url`, or on `warning` for write tools). If `false`, do not open or refresh any preview UI; surface the URL only if asked.
|
|
77
77
|
|
|
78
78
|
**Opening or reading a file IS a preview navigation.** On any "open `<file>`" / "read `<file>`" request, navigate the browser to that doc's `previewUrl` route from the tool response — not a separate fetch, not a fresh system-browser launch.
|
|
@@ -396,6 +396,7 @@ The skill carries the trigger ("KB content changed this turn — go look"). The
|
|
|
396
396
|
| Wait for the server to tell you to open preview | Skip the session-start preview open and wait for the `attach-preview-once` hint | Open the preview browser at session start; the hint is a fallback when you didn't |
|
|
397
397
|
| Ignore the attach hint | Skip the `warning: { action: "attach-preview-once" }` hint in write-tool responses | Open the preview when the hint fires (`preview_start`, or `get_preview_url`); otherwise do nothing |
|
|
398
398
|
| Make the Claude Code Desktop preview work | Read / diagnose / edit `.claude/launch.json` (host-managed config) | Call `preview_start("open-knowledge-ui")` and nothing else; the OK lock-collision proxy bridges any port mismatch transparently |
|
|
399
|
+
| Open a doc in the app from the Claude Code CLI | Print the `previewUrl` / `openknowledge://` string for the user to click | Run `ok open <doc>` — it opens the OK Desktop app (folders open in the browser), with browser fallback |
|
|
399
400
|
| Reference another doc | `` `[text](./page.md)` `` (backticked) or HTML `<a>` | `[text](./page.md)` (raw markdown) |
|
|
400
401
|
| Embed an image | `<img src="...">` (HTML) or hot-linked external URL | Fetch + save locally + `` |
|
|
401
402
|
| Write a factual claim in a KB doc | plausible prose without citation, OR inline `[source](https://URL)` | `ingest` the source first, then cite the local path per Grounding |
|