Skip to content

Clarify installation instructions for OpenKnowledge CLI #533

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
robert-inkeep wants to merge 2 commits into from
Closed

Clarify installation instructions for OpenKnowledge CLI #533

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0adbbe3
Clarify installation instructions for OpenKnowledge CLI
robert-inkeep Jul 8, 2026
4fa26ef
newline
robert-inkeep Jul 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/content/reference/cli.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: CLI & web app
icon: LuTerminal
description: Install the ok CLI and run the OpenKnowledge web app in your browser — on Linux, Windows, or an Intel Mac.
---

On macOS, use the [desktop app](/docs/get-started/quickstart) for the smoothest experience. On **Linux**, **Windows**, or an **Intel Mac**, install the `ok` CLI from npm and run the **same editor as a local web app** in your browser.

<Callout type="info" title="Prerequisites">
Expand All @@ -13,7 +14,7 @@ On macOS, use the [desktop app](/docs/get-started/quickstart) for the smoothest

## Install

Install the OpenKnowledge CLI globally to put `ok` on your `PATH`:
Install the OpenKnowledge CLI globally so you can run `ok` from anywhere:

```bash
npm install -g @inkeep/open-knowledge
Expand Down
Loading