# Open Knowledge Discovery

Read when the user asks what OpenKnowledge is, wants to install it on a repository...

- Repository: https://github.com/inkeep/open-knowledge (4756 stars)
- Category: AI and agents
- License: GPL-3.0
- Last updated: 2026-10-31
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add inkeep/open-knowledge --skill open-knowledge-discovery -g -a claude-code -y`
Codex: `npx skills add inkeep/open-knowledge --skill open-knowledge-discovery -g -a codex -y`
Cursor: `npx skills add inkeep/open-knowledge --skill open-knowledge-discovery -g -a cursor -y`
Gemini CLI: `npx skills add inkeep/open-knowledge --skill open-knowledge-discovery -g -a gemini-cli -y`

## 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.

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# 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).

> **CLI name.** Commands below use Stable's `ok` (`open-knowledge`). OpenKnowledge
> Beta's terminal commands are `ok-beta` (`open-knowledge-beta`), with `~/.ok-beta/`
> in place of `~/.ok/`.

## 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

The rest: https://github.com/inkeep/open-knowledge/blob/HEAD/packages/server/assets/skills/discovery/SKILL.md
