open-knowledge-discovery
Read when the user asks what OpenKnowledge is, wants to install it on a repository, wants to open or preview a single markdown file that is not part of an OpenKnowledge project, wants to share an OpenKnowledge project with collaborators, asks whether OpenKnowledge supports a particular capability, 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 installed into each detected agent's skills dir (for example `.claude/skills/open-knowledge/`) whenever `ok init` runs.
Choose how to use this skill
You do not need every option. Choose the path your AI client supports. The stable page stays the same; versioned files are immutable.
1. Native installer
This listing has no registered native installer command. Use the complete package or source fallback below, depending on what your client supports.
Do not guess an installer command or replace an existing version without reviewing the diff.
2. Complete package recommended
Download the ZIP when available. It includes SKILL.md plus the references, security notes and version metadata.
No complete ProSkills package is published for this listing yet.3. Prompt-only
Copy the prompt above when the agent can read the stable page or when you want to adopt the workflow without installing a skill.
Need only the instruction file?
Download SKILL.md only if your client requires a single file. The complete ZIP is safer for a full installation because it preserves the references and release context.
No path installs or executes anything by itself. Your agent still needs access to the project files. Before updating, compare the installed version and review the diff.
// RATINGS
Not yet listed on ClawHub or SkillsMP
// README
Features
Highlights:
- Full true WYSIWYG so that editing markdown files feels like editing a Google Doc or Notion page.
- Desktop app (macOS, Windows, Linux) and web UI with file navigator, search, tabs, graph wiki link viewer, and more.
- Integrated side-by-side AI-editing with Claude, Codex, OpenCode, Pi and others. Can be used with any harness/agent via MCP/CLI.
- Out-of-the-box MCP, skills, and agentic search for LLM Wikis, second brains, and knowledge graphs.
- No-code Team sharing and Auto-sync powered by git/GitHub under the hood.
- Embeddable HTML and rich components for writing engineering specs and visualized reports.
Install
Desktop app — download it from openknowledge.ai/download (or grab an installer from the latest release):
- macOS (Apple Silicon): open the DMG and drag OpenKnowledge to Applications.
- Windows 10+ (x64 / Arm64): run the Setup installer — per-user, no admin prompt.
- Linux (x64 / arm64): install the deb (Debian/Ubuntu) or rpm (Fedora/RHEL) package.
Web app — on any platform (including Intel Macs and servers), run the same editor as a local web app via the CLI (Node.js 24+ and git required):
npm install -g @inkeep/open-knowledge
cd your-project
ok init # scaffold the project + wire up your AI editors (Claude Code, Claude Desktop, Cursor, Codex, OpenCode, OpenClaw)
ok start --open # serve the web editor and open it in your browser
Usage
Use OpenKnowledge by opening any existing folder on your computer that contains markdown or mdx files. The app can be used with existing codebases, wikis, Obsidian vaults, etc.
Think of it as Notion meets VS Code.
You can use it simply as a rich, WYSIWYG markdown editor to start. For existing files or plain notes/docs.
To get more complex, you can use the starter packs to create LLM Wikis, second brains, or more structured knowledge bases.
Either way, the app will walk you through installing the MCP and skills for agent harnesses detected on your computer. These are designed to help agents with enriched search + authoring of documents.
Git/GitHub based sync and sharing can optionally be enabled.
Docs for general usage: https://openknowledge.ai/docs.
Contributions
The best way to contribute is a detailed issue: the problem you hit and how to reproduce it, or what you are trying to do. CONTRIBUTING.md has tips on writing one we can act on quickly.
License
OpenKnowledge is licensed under GNU General Public License v3.0 or later, an OSI-Approved open source license.
Community & Support
Feel free to file an issue or ask questions on the Discord community. We're always looking for ideas and requests.
// HOW IT'S BUILT
// FILES
2 files shipped with this skill. Inline text is the catalog copy. The upstream link is the source repository.
packages/server/assets/skills/discovery/SKILL.md7.7 KBupstream ↗
--- name: open-knowledge-discovery description: "Read when the user asks what OpenKnowledge is, wants to install it on a repository, wants to open or preview a single markdown file that is not part of an OpenKnowledge project, wants to share an OpenKnowledge project with collaborators, asks whether OpenKnowledge supports a particular capability, 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 installed into each detected agent's skills dir (for example `.claude/skills/open-knowledge/`) whenever `ok init` runs." compatibility: "Any agent host — no MCP server required. Pure discovery + install guidance." metadata: author: "Inkeep" repository: "https://github.com/inkeep/open-knowledge-skills" --- # OpenKnowledge — what it is and how to install it OpenKnowledge (OK) is a markdown-CRDT collaboration platform. It turns a directory of `.md` / `.mdx` files into a live, multi-writer knowledge base: agents and humans edit the same documents in real time, every change is attributed, and a browser preview renders edits as they land. This skill covers **discovery, install, and opening OpenKnowledge files** — including single files that are not part of a project (see *Opening a file outside a project* below). It does **not** carry the in-project read/write runtime contract (the STOP rules for native file tools, the grounding and linking rules, the MCP routing table) — that ships separately as the project-local skill installed by `ok init` (see *Working inside a project* below). ## Install OpenKnowledge on a repository Run `ok init` from the repository root: ```bash npx @inkeep/open-knowledge init # or, after a global install: npm install -g @inkeep/open-knowledge ok init ``` `ok init` is the one setup verb. It: - scaffolds a `.ok/` directory (project config — `content.dir` defaults to `.`); - wires the OpenKnowledge MCP server into the coding agents it detects on this machine — skip with `--no-mcp`; - installs the **project-local runtime skill** into each detected agent's skills dir (`<agent-dir>/skills/open-knowledge/`) so agents working in this repo get the full read/write contract. OK only writes into agent directories that already exist — it never creates one, so nothing appears for agents you don't use, and `ok init` says so when it finds none; - ensures the project has a `.git/`. Re-run `ok init` any time to refresh wiring and skills to the installed CLI version. ## Share an OpenKnowledge project with collaborators An OK project travels with its repository. To share one: 1. Commit the `.ok/` directory and whichever project-local `<agent-dir>/skills/open-knowledge/` directories `ok init` created, along with your `.md` content. 2. Collaborators clone the repo and run `ok init` once — that registers the MCP server on their machine and refreshes the project skill. 3. Start the editor + preview with `ok start` (or open the project in OK Desktop). Collaboration is real-time once two writers have the project open against the same content directory. ## `ok cowork` — Claude Chat & Cowork `ok init`'s editor wiring does not reach Claude Chat or Cowork — those read a separate Skills list inside the Claude Desktop App. Run `ok cowork` to build `openknowledge.skill` and open Claude Desktop so the user can upload it (Customize → Skills → + → Create skill → Upload skill). ## OK Desktop OK Desktop is the standalone macOS app (`@inkeep/open-knowledge-desktop`). It bundles its own CLI, opens a project as an editor + preview window, and keeps the project's MCP wiring and skills current on every launch. Download DMGs from the releases page. ## Opening a file outside a project OpenKnowledge can open a single markdown file that is **not** part of an OK project — a loose `.md` / `.mdx`, **or a file that lives inside a regular repo/folder which was never `ok init`'d**. It opens in a throwaway session (a temp project in the OS temp dir — your repo is never touched, no `.ok/` is written into it) with the same live preview you get inside a project. **Never run `ok init` just to view or open a file.** `ok init` turns a repo into a shared OpenKnowledge project; it is not a prerequisite for opening one file. Opening a file needs no project, no `.ok/`, and no server already running — each path below boots the session itself. When asked to open or preview such a file, **decide by the viewing surface you actually have** — check the tool, not the host name. Only open a browser when you genuinely have one; never pop a browser tab on a host that has none. - **You have an in-app / built-in browser** (Claude Code Desktop's Browser pane, Cursor, Codex, and similar) — this is the default: call the **`preview_url` MCP tool** with `file` set to the absolute path (it finds, or boots on demand, the session and returns a full `url`), then **immediately open that `url` in your in-app browser**. "Open it" means navigate your browser — don't just print the URL and stop. This is also the only way to view it in a browser when the OK Desktop app is installed (`ok open` prefers the Desktop app). Get the URL from `preview_url` only — never hunt for it via `ok ps` / `ok status` / `ok start` or a guessed port. - **No in-app browser** (a pure-stdio CLI) — run `ok open /abs/path/to/file.md`: it opens the Desktop app when installed, else a browser, and boots the session itself. Don't force a browser tab the user didn't ask for; `ok open` is the right default here. If `ok` isn't on PATH, `npx @inkeep/open-knowledge open /abs/path/to/file.md` does the same. If the OK MCP server isn't wired into this host there is no `preview_url` to call — use the `ok open` path above. Don't reconstruct what `preview_url` does by hand (spawning `ok mcp` yourself, scraping ports from `ok ps`). Give an absolute path. `ok open` prints the absolute project root it resolved for that path, and names the enclosing project too when the resolved root sits inside another one. Read that line rather than assuming which project you got. To name the project yourself, pass `--project <dir>`. It is honored wherever it appears: `--project <dir>` or `--project=<dir>`, before or after the path, with or without the `.md` extension. If it cannot be honored the command exits non-zero and says why, so you never need a second command to find out where it landed, and never need to stop a server to correct it. Re-opening the same file lands on the same session. Never construct or guess the URL — use the one `preview_url` returns. ## What else OK does This skill does not enumerate OK's capabilities, and they change between releases. When asked whether OK supports something, read rather than guess: - **Docs** — <https://openknowledge.ai/docs> - **Source** — <https://github.com/inkeep/open-knowledge> ## Working inside a project — use the project-local skill, not this one Do **not** use this skill to perform OpenKnowledge reads or writes. The runtime contract — STOP rules for native file tools on in-scope markdown, the preview-attach handshake, grounding and linking rules, the MCP tool routing table — lives in a **separate project-local skill** installed into each detected agent's skills dir (`<agent-dir>/skills/open-knowledge/SKILL.md`) whenever `ok init` runs. If the user is editing markdown inside a project that has a `.ok/` directory and this discovery skill is the only OpenKnowledge skill loaded, the project-local skill is missing (the repo was never `ok init`'d, or the skill directory was not committed). Advise the user to run `ok init` to install it. ## Learn more - Run `ok --help` for the full command list.README.mdupstream ↗
Contents are not inlined in the catalog. Open the upstream file.
Plain-text copy, no login: /skill-bundles/inkeep-open-knowledge-packages-server-assets-skills-discovery.md