@inkeep/open-knowledge 0.20.0-beta.9 → 0.20.1-beta.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.
Files changed (47) hide show
  1. package/dist/assets/skills/discovery/SKILL.md +53 -4
  2. package/dist/assets/skills/project/SKILL.md +1 -1
  3. package/dist/assets/skills/write-skill/SKILL.md +1 -1
  4. package/dist/cli.mjs +31 -31
  5. package/dist/constants-BqbOfSoK.mjs +2 -0
  6. package/dist/dist-Ca3Ag5Ao.mjs +1 -0
  7. package/dist/{dist-ctsYjUwZ.mjs → dist-Cr0_LDkC.mjs} +27 -22
  8. package/dist/index.mjs +1 -1
  9. package/dist/init-CwADts1i.mjs +1 -0
  10. package/dist/init-DJH9fDpw.mjs +305 -0
  11. package/dist/loader-3W_GUyq_.mjs +1 -0
  12. package/dist/{loader-DJ2_1TJm.mjs → loader-DkRFzG9j.mjs} +2 -2
  13. package/dist/preview-D6V1_jLj.mjs +1 -0
  14. package/dist/{preview-DZhqYol8.mjs → preview-xUtZ_Wnl.mjs} +2 -2
  15. package/dist/public/assets/{ActivityModeContent-DGw5iUid.js → ActivityModeContent-BeKprPnC.js} +1 -1
  16. package/dist/public/assets/{DocumentContext-CmO1rPM6.js → DocumentContext-Dsy-V9Ut.js} +1 -1
  17. package/dist/public/assets/{ManagedArtifactProperties-Cr8eMUCF.js → ManagedArtifactProperties-BjUj1ege.js} +1 -1
  18. package/dist/public/assets/{PropertyPanel-ze_4e3n_.js → PropertyPanel-WP7faSjK.js} +1 -1
  19. package/dist/public/assets/{SettingsDialogBody-hP9Vzn5G.js → SettingsDialogBody-v_uU85KY.js} +1 -1
  20. package/dist/public/assets/{SourceEditor-4T4loRia.js → SourceEditor-BCTvGEN3.js} +1 -1
  21. package/dist/public/assets/TerminalPanel-yQbrCG8i.js +146 -0
  22. package/dist/public/assets/{config-validation-events-CA8jFSci.js → config-validation-events-DeNSFunr.js} +1 -1
  23. package/dist/public/assets/{index-DNKaMY7F.js → index-D9ORkIyY.js} +94 -94
  24. package/dist/public/assets/{selection-context-kDVHDAV2.js → selection-context-DrXM_FlV.js} +1 -1
  25. package/dist/public/assets/{telemetry-impl-Cbuwv6dZ.js → telemetry-impl-DXv9s3r6.js} +1 -1
  26. package/dist/public/assets/{typing-burst-detector-zGrvqSf8.js → typing-burst-detector-C9kWtkXV.js} +1 -1
  27. package/dist/public/index.html +6 -6
  28. package/dist/{repair-launch-json-CW3DFdqJ.mjs → repair-launch-json-CpkMEneP.mjs} +2 -2
  29. package/dist/{repair-mcp-configs-DE4EVC8e.mjs → repair-mcp-configs-Da9zV1zG.mjs} +2 -2
  30. package/dist/{repair-skills-DmGQPZy4.mjs → repair-skills-Bv465NK-.mjs} +2 -2
  31. package/dist/repair-skills-D1vWIYJn.mjs +1 -0
  32. package/dist/src-ajPS5oto.mjs +3 -0
  33. package/dist/start-Csz506Fz.mjs +3 -0
  34. package/dist/start-J-h6TGAI.mjs +1 -0
  35. package/dist/{write-project-skill-BU5uV78y.mjs → write-project-skill-TvNCLXKO.mjs} +2 -2
  36. package/package.json +1 -1
  37. package/dist/constants-nTyY9ahE.mjs +0 -2
  38. package/dist/dist-Bf8Vy08L.mjs +0 -1
  39. package/dist/init-B55_K_T8.mjs +0 -1
  40. package/dist/init-DZYYr4Qo.mjs +0 -305
  41. package/dist/loader-DD-AnN5t.mjs +0 -1
  42. package/dist/preview-BEK2Jwjs.mjs +0 -1
  43. package/dist/public/assets/TerminalPanel-C9rmhBG2.js +0 -146
  44. package/dist/repair-skills-DIh6L29_.mjs +0 -1
  45. package/dist/src-3-Gxdiww.mjs +0 -7
  46. package/dist/start-79nR1Eky.mjs +0 -3
  47. package/dist/start-DGfnJdwS.mjs +0 -1
@@ -3,7 +3,7 @@ name: open-knowledge-discovery
3
3
  description: "Read when the user asks what OpenKnowledge is, wants to install it on a repository, wants to share an OpenKnowledge project with collaborators, or asks how `ok init` / `ok cowork` / OK Desktop set up a project. Do NOT load to perform OpenKnowledge 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.20.0-beta.9"
6
+ version: "0.20.1-beta.0"
7
7
  author: "Inkeep"
8
8
  repository: "https://github.com/inkeep/open-knowledge"
9
9
  ---
@@ -14,9 +14,13 @@ directory of `.md` / `.mdx` files into a live, multi-writer knowledge base:
14
14
  agents and humans edit the same documents in real time, every change is
15
15
  attributed, and a browser preview renders edits as they land.
16
16
 
17
- This skill is **discovery-only**. It explains what OpenKnowledge is and how
18
- to set it up. It carries **no runtime rules** for reading or editing markdown
19
- that guidance ships separately (see *Working inside a project* below).
17
+ This skill covers **discovery, install, and opening OpenKnowledge files**
18
+ including single files that are not part of a project (see *Opening a file
19
+ outside a project* below). It does **not** carry the in-project read/write
20
+ runtime contract (the STOP rules for native file tools, the grounding and
21
+ linking rules, the MCP routing table) — that ships separately as the
22
+ project-local skill installed by `ok init` (see *Working inside a project*
23
+ below).
20
24
 
21
25
  ## Install OpenKnowledge on a repository
22
26
 
@@ -71,6 +75,51 @@ bundles its own CLI, opens a project as an editor + preview window, and keeps
71
75
  the project's MCP wiring and skills current on every launch. Download DMGs
72
76
  from the releases page.
73
77
 
78
+ ## Opening a file outside a project
79
+
80
+ OpenKnowledge can open a single markdown file that is **not** part of an OK
81
+ project — a loose `.md` / `.mdx`, **or a file that lives inside a regular
82
+ repo/folder which was never `ok init`'d**. It opens in a throwaway session (a
83
+ temp project in the OS temp dir — your repo is never touched, no `.ok/` is
84
+ written into it) with the same live preview you get inside a project.
85
+
86
+ **Never run `ok init` just to view or open a file.** `ok init` turns a repo
87
+ into a shared OpenKnowledge project; it is not a prerequisite for opening one
88
+ file. Opening a file needs no project, no `.ok/`, and no server already
89
+ running — each path below boots the session itself.
90
+
91
+ When asked to open or preview such a file, **decide by the viewing surface you
92
+ actually have** — check the tool, not the host name. Only open a browser when
93
+ you genuinely have one; never pop a browser tab on a host that has none.
94
+
95
+ - **You have an in-app / built-in browser** (Cursor, Codex, and similar) — this
96
+ is the default: call the **`preview_url` MCP tool** with `file` set to the
97
+ absolute path (it finds, or boots on demand, the session and returns a full
98
+ `url`), then **immediately open that `url` in your in-app browser**. "Open it"
99
+ means navigate your browser — don't just print the URL and stop. This is also
100
+ the only way to view it in a browser when the OK Desktop app is installed
101
+ (`ok open` prefers the Desktop app). Get the URL from `preview_url` only —
102
+ never hunt for it via `ok ps` / `ok status` / `ok ui` / `ok start` or a guessed
103
+ port.
104
+ - **You have a Claude Code Desktop preview *pane* but no general browser** — the
105
+ pane is project-only: it shows in-project docs via `preview_start`, but it
106
+ **cannot host a file from outside the project**. For such a file run
107
+ `ok open /abs/path/to/file.md` (the Desktop app) instead; don't try to force
108
+ the file into the pane.
109
+ - **No in-app browser and no pane** (a pure-stdio CLI) — run
110
+ `ok open /abs/path/to/file.md`: it opens the Desktop app when installed, else a
111
+ browser, and boots the session itself. Don't force a browser tab the user
112
+ didn't ask for; `ok open` is the right default here. If `ok` isn't on PATH,
113
+ `npx @inkeep/open-knowledge open /abs/path/to/file.md` does the same.
114
+
115
+ If the OK MCP server isn't wired into this host there is no `preview_url` to
116
+ call — use the `ok open` path above. Don't reconstruct what `preview_url` does
117
+ by hand (spawning `ok mcp` yourself, scraping ports from `ok ps`).
118
+
119
+ The path must be absolute (a file outside a project has no cwd to anchor a
120
+ relative path). Re-opening the same file lands on the same session. Never
121
+ construct or guess the URL — use the one `preview_url` returns.
122
+
74
123
  ## Working inside a project — use the project-local skill, not this one
75
124
 
76
125
  Do **not** use this skill to perform OpenKnowledge reads or writes. The
@@ -3,7 +3,7 @@ name: open-knowledge
3
3
  description: "Authoritative agent-runtime contract for working inside an OpenKnowledge project — a markdown-CRDT knowledge base exposed over MCP. Use whenever reading, listing, searching, or editing any `.md` or `.mdx` file in the project, and before any `mcp__open-knowledge__*` tool call (`exec`, `search`, `write`, `edit`, and the rest). Installed by `ok init`, so its presence means this is an OpenKnowledge project and it governs every markdown file here. Covers the read/write tool surface, grounding and linking rules, folder/template conventions, the live browser preview, and the rule that OK's MCP tools — never native file tools — handle in-scope markdown."
4
4
  compatibility: "Claude Code, Claude Desktop, Claude Cowork, Claude.ai web. Requires OpenKnowledge MCP server + code execution."
5
5
  metadata:
6
- version: "0.20.0-beta.9"
6
+ version: "0.20.1-beta.0"
7
7
  author: "Inkeep"
8
8
  repository: "https://github.com/inkeep/open-knowledge"
9
9
  ---
@@ -3,7 +3,7 @@ name: open-knowledge-write-skill
3
3
  description: "Use when the user wants to create, author, write, or design a new Agent Skill (a SKILL.md) — for OpenKnowledge or for their editors — including requests like 'help me write a skill', 'make a skill that…', 'turn this workflow into a skill', or improving an existing skill's triggering and discipline. Also use when capturing reusable agent guidance that should live as an installable skill rather than a one-off prompt. Covers choosing scope (project vs global), the SKILL.md frontmatter contract, progressive-disclosure structure, evaluating the skill, and installing it into the user's editors."
4
4
  compatibility: "OpenKnowledge project recommended (uses the `write` / `edit` / `install` MCP verbs). Authoring + validation are pure file ops; live preview + eval want a running server (`ok start`)."
5
5
  metadata:
6
- version: "0.9.1"
6
+ version: "0.20.0"
7
7
  author: "Inkeep"
8
8
  repository: "https://github.com/inkeep/open-knowledge"
9
9
  ---