From 75bb4f94974f5a52fa474b50e3f42b015aeb410b Mon Sep 17 00:00:00 2001 From: Andrey Avtomonov Date: Tue, 19 May 2026 16:41:01 +0200 Subject: [PATCH] docs: align CLI install package manager guidance (#148) * docs: align CLI install package manager guidance * test: update CLI install docs expectation --- README.md | 2 +- docs-site/content/docs/ai-resources/prompt-recipes.mdx | 2 +- scripts/examples-docs.test.mjs | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index eb78b1a3..517d3923 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ to install and configure ktx ## Quick Start ```bash -pnpm add --global @kaelio/ktx +npm install -g @kaelio/ktx ktx setup ktx status ``` diff --git a/docs-site/content/docs/ai-resources/prompt-recipes.mdx b/docs-site/content/docs/ai-resources/prompt-recipes.mdx index 35f8a4ae..6498fc1d 100644 --- a/docs-site/content/docs/ai-resources/prompt-recipes.mdx +++ b/docs-site/content/docs/ai-resources/prompt-recipes.mdx @@ -14,7 +14,7 @@ Read https://docs.kaelio.com/ktx/llms.txt first. Then fetch only the KTX Markdow ## Set up a project ```text -Set up KTX in this repository. Start by reading /docs/ai-resources/agent-quickstart.md and /docs/getting-started/quickstart.md. Use pnpm, not npm. After setup, run ktx status and summarize which steps are complete, which files changed, and what still needs credentials or user input. +Set up KTX in this repository. Start by reading /docs/ai-resources/agent-quickstart.md and /docs/getting-started/quickstart.md. Install the published CLI with npm; use pnpm only when working from a KTX source checkout. After setup, run ktx status and summarize which steps are complete, which files changed, and what still needs credentials or user input. ``` ## Find a command diff --git a/scripts/examples-docs.test.mjs b/scripts/examples-docs.test.mjs index 2f6c9ef6..b3c5d3b4 100644 --- a/scripts/examples-docs.test.mjs +++ b/scripts/examples-docs.test.mjs @@ -192,7 +192,7 @@ describe('standalone example docs', () => { const quickstart = await readText('docs-site/content/docs/getting-started/quickstart.mdx'); const packageArtifacts = await readText('examples/package-artifacts/README.md'); - assert.match(rootReadme, publicPackagePattern('pnpm add --global {package}')); + assert.match(rootReadme, publicPackagePattern('npm install -g {package}')); assert.match(quickstart, publicPackagePattern('npm install -g {package}')); assert.match(quickstart, /ktx dev runtime install --feature local-embeddings --yes/); assert.match(quickstart, /ktx dev runtime start --feature local-embeddings/);