Installation

Environment

Node.js version >18

Kubb has a minimal support of Node.js version 18.0.0.

WARNING

Node.js versions prior to Node.js 18 are no longer supported. To use Kubb, please migrate to Node.js 18 or higher.

https://nodejs.org/en/blog/announcements/nodejs16-eol

TypeScript version >4.7

Kubb has a minimal support of TypeScript version 4.7.
If you are using an older TypeScript version, please migrate to version 4.7 or later to use Kubb. Please consider that at the moment of writing this TypeScript 4.6 is almost two years old.

Latest 2.24.0

You can install Kubb via bun, pnpm, npm or yarn.

bun

bun add @kubb/cli @kubb/core

pnpm

pnpm add @kubb/cli @kubb/core

npm

npm install @kubb/cli @kubb/core

yarn

yarn add @kubb/cli @kubb/core

Canary canary

Kubb also publishes a canary version on every commit to the main branch.
To install the canary version:

bun

bun add @kubb/cli@canary @kubb/core@canary

pnpm

pnpm add @kubb/cli@canary @kubb/core@canary

npm

npm install @kubb/cli@canary @kubb/core@canary

yarn

yarn add @kubb/cli@canary @kubb/core@canary

Beta beta

Kubb also publishes a beta version which contains experimental features that are not production ready.

bun

bun add @kubb/cli@beta @kubb/core@beta

pnpm

pnpm add @kubb/cli@beta @kubb/core@beta

npm

npm install @kubb/cli@beta @kubb/core@beta

yarn

yarn add @kubb/cli@beta @kubb/core@alpha

Alpha alpha

Kubb also publishes an alpha version which contains experimental features that are not production ready.

bun

bun add @kubb/cli@alpha @kubb/core@alpha

pnpm

pnpm add @kubb/cli@alpha @kubb/core@alpha

npm

npm install @kubb/cli@alpha @kubb/core@alpha

yarn

yarn add @kubb/cli@alpha @kubb/core@alpha