kubb generate

Run kubb generate to read your kubb.config.ts and run the code-generation pipeline. This is the default command. Run kubb with no arguments and it runs kubb generate.

Terminal

command: kubb generate
output:
  - ◆  Generation started
  - ◇  @kubb/plugin-ts          completed in 98ms
  - ◇  @kubb/plugin-zod         completed in 134ms
  - ◇  @kubb/plugin-react-query completed in 201ms
  - ◇  @kubb/plugin-axios       completed in 77ms
  - ◇  Generation completed
  -
  -  Plugins  4 passed (4)
  -    Files  156 generated
  - Duration  1.2s
  -   Output  ./src/gen

Usage

Generate from the input set in your config:

Terminal

kubb generate

Pass an input file to override the config:

Terminal

kubb generate ./petStore.yaml

Arguments

Argument	Description
[input]	Optional path or URL to a Swagger/OpenAPI document. Overrides the input set in the config.

Options

Option	Default	Description
--config=<path>, -c <path>		Path to a config file, such as ./kubb.staging.ts.
--logLevel=<silent|info|verbose>, -l	info	Set the verbosity. Use verbose to see plugin timings.
--silent, -s	false	Force logLevel to silent. Suppresses output.
--verbose, -v	false	Force logLevel to verbose. Shows slow plugins.
--reporter=<cli|json|file>		Pick which reporters to trigger, comma separated. Defaults to cli.
--watch, -w	false	Re-run the pipeline whenever the input spec changes.

--reporter takes no short flag.

Reporters

A reporter decides how a run is rendered. The config registers the available reporters with reporters, and --reporter picks which ones to trigger by name (comma separated, like --reporter cli,file). Without the flag, the cli reporter runs. Three ship out of the box.

Reporter	Output
cli	The end-of-run summary in the terminal. This runs when you pass no flag.
json	A machine-readable report on stdout (status, counts, timings, diagnostics) for CI.
file	The run's diagnostics, written to .kubb/kubb-<name>-<timestamp>.log.

Write a log file:

Terminal

kubb generate --reporter file

Print a JSON report for CI. The exit code is non-zero on any error:

Terminal

kubb generate --reporter json

Examples

Run with a custom config:

Terminal

kubb generate --config ./kubb.staging.ts

Watch the spec and regenerate on every change:

Terminal

kubb generate --watch

Run with verbose plugin timings:

Terminal

kubb generate --verbose

See also

• Configuration: full reference for kubb.config.ts
• Basic usage: end-to-end walkthrough
• Plugins: available plugins for code generation