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.
Usage
Run the command in the directory where your Kubb project lives:
npx kubb initThe 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. The list comes from the Kubb registry.
Kubb detects the package manager (bun, pnpm, npm, or yarn) from your project. It installs kubb at the exact version of the CLI you ran. Each plugin is added the way kubb add adds it: at the version the registry pins, and only when it supports the running Kubb and Node.js versions.
Before it installs anything, Kubb checks the manifest of each chosen plugin. If a plugin's dependencies are not all chosen, or a plugin with role: "consumer" (such as plugin-react-query) has no client plugin next to it, kubb init names what is missing and stops.
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 registry ids of the plugins to add, the same ids kubb add takes, such as plugin-ts,plugin-zod. Bypasses the plugin selection prompt. An id that is not in the registry stops kubb init. | |
--dry-run | false | Preview the wizard without installing packages or writing kubb.config.ts. |
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 --yesRun with no prompts and a specific spec, output directory, and plugins:
npx kubb init --input ./openapi.yaml --output ./src/gen --plugins plugin-ts,plugin-zodAdd --dry-run to preview what the wizard would install and write.