diff --git a/README.md b/README.md index 7b83e1ca..415b3e5b 100644 --- a/README.md +++ b/README.md @@ -375,6 +375,45 @@ bun add -g skillkit # bun npx skillkit # no install ``` +### Install sizes + +Core commands — `install`, `list`, `find`, `translate`, `recommend`, `publish` — +ship in the default package. Four power features are shipped as **optional +dependencies** so a bare CLI install stays small: + +| Feature | Package | Command | +| ------------------------ | -------------------- | --------------------------- | +| Interactive terminal UI | `@skillkit/tui` | `skillkit ui` / `skillkit tui` | +| REST/OpenAPI server | `@skillkit/api` | `skillkit serve` | +| Peer mesh networking | `@skillkit/mesh` | `skillkit mesh …` | +| Inter-agent messaging | `@skillkit/messaging`| `skillkit message …` | + +```bash +# Full install — every feature, everything works out of the box (default): +npm install -g skillkit + +# Slim install — core commands only, ~75% smaller, no native addons: +npm install -g skillkit --omit=optional +pnpm add -g skillkit --prod --no-optional +``` + +Cold `npm install` measurements on a fresh cache: + +| Install mode | Packages | Time | Deprecations | +| --------------------- | -------- | ---- | ------------ | +| `skillkit` | 475 | 18 s | 3 | +| `skillkit --omit=optional` | 118 | 9 s | 0 | + +If you skipped optional deps and later want the UI, server, mesh, or +messaging, add just the one you need: + +```bash +npm install -g @skillkit/tui # skillkit ui +npm install -g @skillkit/api # skillkit serve +npm install -g @skillkit/mesh # skillkit mesh +npm install -g @skillkit/messaging # skillkit message +``` + ## License Apache License 2.0 — see [LICENSE](LICENSE). diff --git a/apps/skillkit/README.md b/apps/skillkit/README.md index 54eab357..98d43b72 100644 --- a/apps/skillkit/README.md +++ b/apps/skillkit/README.md @@ -5,9 +5,28 @@ Universal skills manager for AI coding agents. Install, manage, and sync skills ## Installation ```bash +# Full install (default) — every feature, everything works: npm install -g skillkit + +# Slim install — core commands only, ~75% smaller, no native addons: +npm install -g skillkit --omit=optional ``` +### What's optional + +Four power features ship as **optional dependencies** so the core CLI +stays lean. They install automatically with `npm install -g skillkit`, +and are skipped with `--omit=optional`: + +| Feature | Package | Command | +| ------------------------ | -------------------- | ------------------------------ | +| Interactive terminal UI | `@skillkit/tui` | `skillkit ui` / `skillkit tui` | +| REST/OpenAPI server | `@skillkit/api` | `skillkit serve` | +| Peer mesh networking | `@skillkit/mesh` | `skillkit mesh …` | +| Inter-agent messaging | `@skillkit/messaging`| `skillkit message …` | + +Add one later with `npm install -g @skillkit/tui` (or `api` / `mesh` / `messaging`). + ## Quick Start ```bash diff --git a/apps/skillkit/src/index.ts b/apps/skillkit/src/index.ts index 6906db39..e77a86bb 100644 --- a/apps/skillkit/src/index.ts +++ b/apps/skillkit/src/index.ts @@ -1,6 +1,7 @@ -// Re-export all public APIs from packages export * from '@skillkit/core'; export * from '@skillkit/agents'; -// Re-export TUI entry point -export { startTUI } from '@skillkit/tui'; +export async function startTUI(...args: unknown[]): Promise { + const mod = await import('@skillkit/tui'); + return mod.startTUI(...(args as Parameters)); +} diff --git a/docs/fumadocs/content/docs/installation.mdx b/docs/fumadocs/content/docs/installation.mdx index 84c09e66..977bd4e8 100644 --- a/docs/fumadocs/content/docs/installation.mdx +++ b/docs/fumadocs/content/docs/installation.mdx @@ -33,6 +33,39 @@ bun add -g skillkit Both `skillkit` and `sk` work as command aliases. +## Full vs slim install + +SkillKit ships four power features as **optional dependencies** so the +core install stays small. The default `npm install -g skillkit` installs +every feature; `--omit=optional` installs only the core CLI. + +| Feature | Package | Command | +| ------------------------ | -------------------- | ------------------------------ | +| Interactive terminal UI | `@skillkit/tui` | `skillkit ui` / `skillkit tui` | +| REST/OpenAPI server | `@skillkit/api` | `skillkit serve` | +| Peer mesh networking | `@skillkit/mesh` | `skillkit mesh …` | +| Inter-agent messaging | `@skillkit/messaging`| `skillkit message …` | + +```bash +# Full (default) — every feature works out of the box: +npm install -g skillkit + +# Slim — core commands only, ~75% smaller, no native addons, 0 deprecation warnings: +npm install -g skillkit --omit=optional +``` + +Add one later: + +```bash +npm install -g @skillkit/tui # enables: skillkit ui +npm install -g @skillkit/api # enables: skillkit serve +npm install -g @skillkit/mesh # enables: skillkit mesh +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. + ## Verify ```bash diff --git a/docs/fumadocs/src/components/Documentation.tsx b/docs/fumadocs/src/components/Documentation.tsx index 8ce011ff..f1648ff1 100644 --- a/docs/fumadocs/src/components/Documentation.tsx +++ b/docs/fumadocs/src/components/Documentation.tsx @@ -61,14 +61,24 @@ const sections: DocSection[] = [ content: (

Quick Start

- {`# Install globally via npm + {`# Full install — every feature works out of the box (default): npm install -g skillkit -# Or use npx directly -npx skillkit --help +# Slim install — core commands only, ~75% smaller, 0 deprecation warnings: +npm install -g skillkit --omit=optional -# Or install via pnpm -pnpm add -g skillkit`} +# Or use npx directly: +npx skillkit --help`} + +

Optional Features

+

+ TUI, REST server, peer mesh, and inter-agent messaging ship as optional + dependencies. They install by default, or add later à la carte: +

+ {`npm install -g @skillkit/tui # enables: skillkit ui +npm install -g @skillkit/api # enables: skillkit serve +npm install -g @skillkit/mesh # enables: skillkit mesh +npm install -g @skillkit/messaging # enables: skillkit message`}

Verify Installation

{`skillkit --version diff --git a/docs/skillkit/components/Documentation.tsx b/docs/skillkit/components/Documentation.tsx index 8c89ff08..b3950656 100644 --- a/docs/skillkit/components/Documentation.tsx +++ b/docs/skillkit/components/Documentation.tsx @@ -60,14 +60,24 @@ const sections: DocSection[] = [ content: (

Quick Start

- {`# Install globally via npm + {`# Full install — every feature works out of the box (default): npm install -g skillkit -# Or use npx directly -npx skillkit --help +# Slim install — core commands only, ~75% smaller, 0 deprecation warnings: +npm install -g skillkit --omit=optional -# Or install via pnpm -pnpm add -g skillkit`} +# Or use npx directly: +npx skillkit --help`} + +

Optional Features

+

+ TUI, REST server, peer mesh, and inter-agent messaging ship as optional + dependencies. They install by default, or add later à la carte: +

+ {`npm install -g @skillkit/tui # enables: skillkit ui +npm install -g @skillkit/api # enables: skillkit serve +npm install -g @skillkit/mesh # enables: skillkit mesh +npm install -g @skillkit/messaging # enables: skillkit message`}

Verify Installation

{`skillkit --version