From 49bcd85abf5795a04895456a8663156dc44d1a53 Mon Sep 17 00:00:00 2001 From: Rohit Ghumare <48523873+rohitg00@users.noreply.github.com> Date: Mon, 20 Apr 2026 22:11:42 +0100 Subject: [PATCH] docs: add npx usage guidance for add command npx skillkit add is the most common first-touch path, so call it out explicitly. Cover: - Full vs slim invocation (npx skillkit add vs npx --omit=optional skillkit add), with the same 118/9s slim numbers. - How the npx cache at ~/.npm/_npx/ makes subsequent runs instant until a new version ships. - When to graduate to a global install: skips the prompt-to-proceed and kills the per-release refetch cost. Updated in all four install-docs surfaces: root README, apps/skillkit README (npm landing), docs/fumadocs/content/docs/installation.mdx, and the Documentation.tsx components used on the website and the fumadocs mirror. --- README.md | 22 +++++++++++++++++++ apps/skillkit/README.md | 19 ++++++++++++++++ docs/fumadocs/content/docs/installation.mdx | 22 +++++++++++++++++++ .../fumadocs/src/components/Documentation.tsx | 18 +++++++++++++++ docs/skillkit/components/Documentation.tsx | 18 +++++++++++++++ 5 files changed, 99 insertions(+) diff --git a/README.md b/README.md index 415b3e5b..83d7f928 100644 --- a/README.md +++ b/README.md @@ -414,6 +414,28 @@ npm install -g @skillkit/mesh # skillkit mesh npm install -g @skillkit/messaging # skillkit message ``` +### Using `npx` (no install) + +`npx skillkit add ` is the fastest way to try it. First run +downloads the package into the npx cache (`~/.npm/_npx/`); every run +after that is instant. + +```bash +# Full (defaults to installing optional features): +npx skillkit add anthropics/skills + +# Slim — core commands only, ~75% fewer packages, 0 warnings: +npx --omit=optional skillkit add anthropics/skills +``` + +Run `npx skillkit` a few times and you will want the global install — +it skips the prompt-to-proceed and kills the per-release cache refetch: + +```bash +npm install -g skillkit --omit=optional # 9 s, 118 packages, one time +skillkit add anthropics/skills # instant every run +``` + ## License Apache License 2.0 — see [LICENSE](LICENSE). diff --git a/apps/skillkit/README.md b/apps/skillkit/README.md index 98d43b72..9a37a039 100644 --- a/apps/skillkit/README.md +++ b/apps/skillkit/README.md @@ -27,6 +27,25 @@ and are skipped with `--omit=optional`: Add one later with `npm install -g @skillkit/tui` (or `api` / `mesh` / `messaging`). +### Using `npx` + +`npx skillkit add ` works with zero install. First run pulls +the package into the npx cache (`~/.npm/_npx/`); every subsequent run +from the same cache is instant. + +```bash +npx skillkit add anthropics/skills # full +npx --omit=optional skillkit add anthropics/skills # slim, 118 pkgs, 9 s +``` + +Running `npx` more than a couple of times? Install globally — no +prompt-to-proceed, no refetch on each release: + +```bash +npm install -g skillkit --omit=optional +skillkit add anthropics/skills +``` + ## Quick Start ```bash diff --git a/docs/fumadocs/content/docs/installation.mdx b/docs/fumadocs/content/docs/installation.mdx index 977bd4e8..73cb4c92 100644 --- a/docs/fumadocs/content/docs/installation.mdx +++ b/docs/fumadocs/content/docs/installation.mdx @@ -66,6 +66,28 @@ npm install -g @skillkit/messaging # enables: skillkit message The CLI catches a missing optional feature and prints a one-line hint, so you'll never see an unhandled stack trace. +## Using `npx` + +`npx skillkit add ` runs without a global install. First run +downloads into the npx cache (`~/.npm/_npx/`); every call after that is +instant until the cache expires or a new version ships. + +```bash +# Full — every feature works: +npx skillkit add anthropics/skills + +# Slim — core commands only, 75% fewer packages, 0 warnings: +npx --omit=optional skillkit add anthropics/skills +``` + +If you use `npx skillkit` more than a couple of times, install globally +to skip the prompt-to-proceed and avoid the per-release cache refetch: + +```bash +npm install -g skillkit --omit=optional +skillkit add anthropics/skills +``` + ## Verify ```bash diff --git a/docs/fumadocs/src/components/Documentation.tsx b/docs/fumadocs/src/components/Documentation.tsx index f1648ff1..b3f95b90 100644 --- a/docs/fumadocs/src/components/Documentation.tsx +++ b/docs/fumadocs/src/components/Documentation.tsx @@ -80,6 +80,24 @@ npm install -g @skillkit/api # enables: skillkit serve npm install -g @skillkit/mesh # enables: skillkit mesh npm install -g @skillkit/messaging # enables: skillkit message`} +

Using npx (no install)

+

+ npx skillkit add <owner/repo> runs with zero install. + First call caches the package at ~/.npm/_npx/; every + run after that is instant until a new version ships. +

+ {`# Full (default): +npx skillkit add anthropics/skills + +# Slim — core only, 75% fewer packages, 0 warnings: +npx --omit=optional skillkit add anthropics/skills`} +

+ Using npx more than a couple times? Install globally to skip the + prompt-to-proceed and avoid the per-release cache refetch: +

+ {`npm install -g skillkit --omit=optional +skillkit add anthropics/skills`} +

Verify Installation

{`skillkit --version skillkit --help`} diff --git a/docs/skillkit/components/Documentation.tsx b/docs/skillkit/components/Documentation.tsx index b3950656..c88f73f9 100644 --- a/docs/skillkit/components/Documentation.tsx +++ b/docs/skillkit/components/Documentation.tsx @@ -79,6 +79,24 @@ npm install -g @skillkit/api # enables: skillkit serve npm install -g @skillkit/mesh # enables: skillkit mesh npm install -g @skillkit/messaging # enables: skillkit message`} +

Using npx (no install)

+

+ npx skillkit add <owner/repo> runs with zero install. + First call caches the package at ~/.npm/_npx/; every + run after that is instant until a new version ships. +

+ {`# Full (default): +npx skillkit add anthropics/skills + +# Slim — core only, 75% fewer packages, 0 warnings: +npx --omit=optional skillkit add anthropics/skills`} +

+ Using npx more than a couple times? Install globally to skip the + prompt-to-proceed and avoid the per-release cache refetch: +

+ {`npm install -g skillkit --omit=optional +skillkit add anthropics/skills`} +

Verify Installation

{`skillkit --version skillkit --help`}