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.

Terminal

command: npx kubb@beta 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:

Terminal

npx kubb@beta 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.

Options

Option	Default	Description
--yes, -y	false	Skip all prompts and use the default values.
--input, -i		Path to the OpenAPI specification (local file or URL). Bypasses the spec path prompt.
--output, -o		Output directory for generated files. Bypasses the output directory prompt.
--plugins		Comma-separated list of plugins to install. Bypasses the plugin selection prompt. Valid values: plugin-ts, plugin-axios, plugin-fetch, plugin-react-query, plugin-vue-query, plugin-zod, plugin-faker, plugin-msw, plugin-cypress, plugin-mcp, plugin-redoc.

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

Examples

Run with the defaults and no prompts:

Terminal

npx kubb@beta init --yes

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

Terminal

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

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

Terminal

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

TIP

Prefer to wire things up by hand? See the Installation guide for a manual walkthrough.

See also

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