kubb init#

Run kubb init for an interactive setup wizard. Answer a few questions and Kubb creates a package.json if one is missing, installs your chosen plugins, and writes a ready-to-use kubb.config.ts.

command: npx kubb init
output:
  - ◆ Kubb Init
  - ◇ Detected package manager: pnpm
  - ◇ Where is your OpenAPI specification located?
  - │ ./openapi.yaml
  - ◇ Where should the generated files be output?
  - │ ./src/gen
  - ◇ Select plugins to use:
  - │ plugin-ts, plugin-axios, plugin-zod
  - ◇ Installed 4 packages
  - ◇ Created kubb.config.ts
  - ◇ All set! Run `npx kubb generate` to start generating.

Usage#

Run the command in the directory where your Kubb project lives:

npx kubb init

The wizard prompts for three things:

• The path to your OpenAPI/Swagger spec, a local file or a URL.
• The output directory for generated files.
• Which plugins to install, such as clients, hooks, validators, and mocks.

Kubb detects the package manager (bun, pnpm, npm, or yarn) from your project, so it does not prompt for one.

When the wizard finishes, you have:

• A kubb.config.ts wired up with the plugins you selected.
• A package.json with kubb and the chosen plugins added as dependencies.
• All selected dependencies installed.

The wizard installs kubb at the exact version of the CLI you ran and takes the plugins from that same release channel, so npx kubb@beta init scaffolds a beta project and a stable CLI scaffolds a stable one.

Options#

Each flag skips only its own prompt and combines with --yes. Pass all three value flags and the wizard runs without prompts, no --yes needed.

Examples#

Run with the defaults and no prompts:

npx kubb init --yes

Run with no prompts and a specific spec, output directory, and plugins:

npx kubb init --input ./openapi.yaml --output ./src/gen --plugins plugin-ts,plugin-zod

Pass a plugin selection but still prompt for the spec path:

npx kubb init --plugins plugin-ts,plugin-axios,plugin-react-query

Preview what the wizard would install and write, without changing anything:

npx kubb init --yes --dry-run

See also#

• Installation: manual setup guide
• Configuration: full kubb.config.ts reference
• Plugins: browse available plugins