Kubb v5.0.0-beta.104

Appearance

kubb generate ​

Run kubb generate to read your kubb.config.ts and run the code-generation pipeline. It's the default command, so running kubb with no arguments does the same.

kubb generate

Usage ​

Generate from the input set in your config:

Terminal
shell
kubb generate

Pass an input file to override the config:

Terminal
shell
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 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 available reporters with reporters. --reporter picks which ones to trigger by name, comma separated (--reporter cli,file). 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 for CI. See Diagnostics for the full JSON shape.
file The run's diagnostics, written to .kubb/kubb-<name>-<timestamp>.log.

Write a log file:

Terminal
shell
kubb generate --reporter file

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

Terminal
shell
kubb generate --reporter json

Examples ​

Run with a custom config:

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

Watch the spec and regenerate on every change:

Terminal
shell
kubb generate --watch

Run with verbose plugin timings:

Terminal
shell
kubb generate --verbose

See also ​