mirror of
https://github.com/rohitg00/skillkit.git
synced 2026-11-18 18:04:26 +00:00
docs: add npx usage guidance for add command
npx skillkit add <owner/repo> 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.
This commit is contained in:
@@ -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 <owner/repo>` 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).
|
||||
|
||||
@@ -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 <owner/repo>` 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
|
||||
|
||||
@@ -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 <owner/repo>` 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
|
||||
|
||||
@@ -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`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Using npx (no install)</h3>
|
||||
<p className="text-zinc-300 text-sm">
|
||||
<code className="text-zinc-200">npx skillkit add <owner/repo></code> runs with zero install.
|
||||
First call caches the package at <code className="text-zinc-200">~/.npm/_npx/</code>; every
|
||||
run after that is instant until a new version ships.
|
||||
</p>
|
||||
<CodeBlock>{`# Full (default):
|
||||
npx skillkit add anthropics/skills
|
||||
|
||||
# Slim — core only, 75% fewer packages, 0 warnings:
|
||||
npx --omit=optional skillkit add anthropics/skills`}</CodeBlock>
|
||||
<p className="text-zinc-300 text-sm">
|
||||
Using npx more than a couple times? Install globally to skip the
|
||||
prompt-to-proceed and avoid the per-release cache refetch:
|
||||
</p>
|
||||
<CodeBlock>{`npm install -g skillkit --omit=optional
|
||||
skillkit add anthropics/skills`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Verify Installation</h3>
|
||||
<CodeBlock>{`skillkit --version
|
||||
skillkit --help`}</CodeBlock>
|
||||
|
||||
@@ -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`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Using npx (no install)</h3>
|
||||
<p className="text-zinc-300 text-sm">
|
||||
<code className="text-zinc-200">npx skillkit add <owner/repo></code> runs with zero install.
|
||||
First call caches the package at <code className="text-zinc-200">~/.npm/_npx/</code>; every
|
||||
run after that is instant until a new version ships.
|
||||
</p>
|
||||
<CodeBlock>{`# Full (default):
|
||||
npx skillkit add anthropics/skills
|
||||
|
||||
# Slim — core only, 75% fewer packages, 0 warnings:
|
||||
npx --omit=optional skillkit add anthropics/skills`}</CodeBlock>
|
||||
<p className="text-zinc-300 text-sm">
|
||||
Using npx more than a couple times? Install globally to skip the
|
||||
prompt-to-proceed and avoid the per-release cache refetch:
|
||||
</p>
|
||||
<CodeBlock>{`npm install -g skillkit --omit=optional
|
||||
skillkit add anthropics/skills`}</CodeBlock>
|
||||
|
||||
<h3 className="text-lg font-semibold text-white mt-6">Verify Installation</h3>
|
||||
<CodeBlock>{`skillkit --version
|
||||
skillkit --help`}</CodeBlock>
|
||||
|
||||
Reference in New Issue
Block a user