From 8bd502108618b224a20f3d747c36e7f1c09833f5 Mon Sep 17 00:00:00 2001 From: "inkeep-oss-sync[bot]" <274976938+inkeep-oss-sync[bot]@users.noreply.github.com> Date: Wed, 8 Jul 2026 06:24:26 +0000 Subject: [PATCH] chore(sync): mirror inkeep/open-knowledge#533: Clarify installation instructions for OpenKnowledge CLI (#2502) Commits: 1. [0adbbe3](https://github.com/inkeep/open-knowledge/commit/0adbbe31e73d6681faca09ec38d7183a56043b1b) Clarify installation instructions for OpenKnowledge CLI Author: robert-inkeep <123133375+robert-inkeep@users.noreply.github.com> Reword the installation note to describe the result ("run `ok` from anywhere") instead of implying that the installer adds `ok` to PATH. 2. [4fa26ef](https://github.com/inkeep/open-knowledge/commit/4fa26efabce2c86c741881bf5aa00840f1daaa49) newline Author: robert-inkeep <123133375+robert-inkeep@users.noreply.github.com> Co-authored-by: inkeep-oss-sync[bot] <274976938+inkeep-oss-sync[bot]@users.noreply.github.com> Co-authored-by: robert-inkeep <123133375+robert-inkeep@users.noreply.github.com> GitOrigin-RevId: 08d4b834babf115c7423d1732eaceba10757eb24 --- docs/content/reference/cli.mdx | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/content/reference/cli.mdx b/docs/content/reference/cli.mdx index 99a9a4d9..45d7ed80 100644 --- a/docs/content/reference/cli.mdx +++ b/docs/content/reference/cli.mdx @@ -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. @@ -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