Commands

kubb update

The update command moves installed Kubb extensions to the version the Kubb extension registry pins, or lists the available updates with --dry-run.

Run kubb update to move installed extensions to the version the Kubb registry pins. It shows each installed extension's version change and bump, asks which updates to install, and installs them with your project's package manager. Then it generates from kubb.config.ts with the new versions and summarizes the files that changed. With --yes, it installs every update except majors, unless you name the extension. It does not change kubb.config.ts.

Usage

Update every installed extension the registry lists:

Terminal

kubb update

Output

◇  Checked 3 extensions against the registry
│  Extension         Current  Latest
│  @kubb/plugin-ts   5.0.0    5.2.0       minor
│  @kubb/plugin-zod  5.2.0    6.0.0       major · breaking
│  @kubb/plugin-msw  5.4.2    up to date
│
◆  Select the updates to install
│  ◼ @kubb/plugin-ts (5.0.0 → 5.2.0)
│  ◻ @kubb/plugin-zod (5.2.0 → 6.0.0)
│  ↑/↓ to navigate • Space: select • Enter: confirm

Minor and patch updates start selected. A major starts unselected, since it can break the generated code. The hint is the version change.

After the install, kubb update asks whether to regenerate now, since that rewrites the generated files. --yes installs only. The summary starts with the outcome and duration, then lists the packages, the skipped updates, and the file changes:

Output

✓ Update complete  2.16s

  Packages  1 installed with pnpm · 1 skipped
  Skipped   Plugin @kubb/plugin-zod 6.0.0  run kubb update plugin-zod later
  Files     1 added · 1 modified · 0 deleted

List the updates without installing them:

Terminal

kubb update --dry-run

Output

◇ Checked 2 extensions against the registry
│  Extension         Current  Latest  
│  @kubb/plugin-ts   5.0.0    5.2.0   minor
│  @kubb/plugin-zod  5.2.0    6.0.0   major · breaking
│
◇ Updates available  138ms

Dry run: nothing was installed. Run kubb update to install them.

The preview exits with code 0 when the check succeeds, including when updates are available. It installs no packages and does not regenerate files.

Install the updates for two extensions without the prompt:

Terminal

kubb update plugin-zod plugin-ts --yes

Arguments

Argument	Required	Description
`[ids...]`	`false`	Registry ids to update, as `<owner>/<slug>` or a bare `<slug>` for `kubb-labs/<slug>`. Without ids, every installed extension the registry lists is checked.

Options

Option	Default	Description
`--dry-run`	`false`	List the available updates without installing them.
`--yes`, `-y`	`false`	Install every update without asking. A major is only installed when its id is named.

Which extensions it updates

kubb update checks the registry extensions listed in dependencies or devDependencies of the package.json in the current directory. An extension gets an update when its installed version is older than the pinned one, or when it is not installed. A version newer than the pin is left alone, so kubb update never downgrades.

An update that does not support your Kubb or Node.js version is skipped with Skipped <id>: <reason>. An extension pinned to a GitHub release installs as github:<owner>/<repo>#<commit>.

An id that matches no installed extension prints <id> is not installed, or not in the registry. and exits with code 1. The other ids still update. When nothing is outdated, the summary says Already up to date. An incompatible update is reported as skipped.

Environment variables

Variable	Default	Description
`KUBB_REGISTRY`	`https://kubb.dev/registry`	Base URL of the registry to read. See Host your own registry.

Exit codes

kubb update exits with code 1 when an id is invalid or not installed, the registry index cannot be read or is invalid, or the install fails. It exits with code 0 when there is nothing to update and when you cancel at the prompt. A failed generation after installation produces a warning summary that distinguishes installed extensions from failed regeneration and does not change the exit code.

kubb add

kubb list