Skip to content

Beautiful, AI-native markdown IDE and LLM wiki

1.8 KB
Raw Blame

@inkeep/open-knowledge

OpenKnowledge is a local-first, agent-friendly Markdown knowledge base with a rich editor. It is available as a desktop app for macOS, Windows, and Linux, or as the same local web app served from your terminal.

This package installs the cross-platform ok / open-knowledge CLI and bundles the web app. Use it on Linux, Windows, macOS, an Intel Mac, or a server. The macOS desktop app currently requires Apple silicon, so Intel Mac users should use this CLI and the web app.

Install

npm install -g @inkeep/open-knowledge

Requires Node.js 24+ and Git.

To remove OpenKnowledge later, run ok uninstall (whole machine) or ok deinit (one project).

Quick start

cd your-project
ok init          # scaffold .ok/ and connect supported AI tools
ok start         # serve the editor and open it in your browser
  • ok init — turn a folder into an OpenKnowledge project and register the MCP server with supported AI tools.
  • ok start — run the local server and web editor, then open it in your browser.
  • ok open <target> — open a doc, a folder, or a path to a Markdown file in the editor. It prints the project root it resolved; pass --project <dir> anywhere in the command to name one yourself.
  • ok --help — list every command.

Desktop app

For the native desktop experience, download OpenKnowledge for macOS, Windows, or Linux.

Documentation

Full docs, integrations, and configuration: https://openknowledge.ai/docs.

License

GPL-3.0-or-later.