CLI

Installation

bun

bun add @kubb/cli

pnpm

pnpm add @kubb/cli

npm

npm install @kubb/cli

yarn

yarn add @kubb/cli

Usage

bun

kubb --bun --config kubb.config.js
bkubb --config kubb.config.js

node

kubb --config kubb.config.js

kubb/2.0.0

Usage:
  $ kubb [input]

Commands:
  [input]           Path of the input file(overrides the one in `kubb.config.js`)
  generate [input]  Path of the input file(overrides the one in `kubb.config.js`)

For more info, run any command with the `--help` flag:
  $ kubb --help
  $ kubb generate --help

Options:
  -h, --help     Display this message
  -v, --version  Display version number

Generate

TIP

kubb generate and kubb are the same.

kubb/2.0.0

Usage:
  $ kubb generate [input]

Options:
  -c, --config <path>     Path to the Kubb config
  -l, --log-level <type>  Info, silent or debug
  -w, --watch             Watch mode based on the input file
  -h, --help              Display this message
  -b, --bun               Run Kubb with Bun

Path of the input file(overrides the one in kubb.config.js)

kubb petStore.yaml

Options

--config (-c)

INFO

Path to the Kubb config.

kubb --config kubb.config.ts

--log-level (-l)

INFO

Type of the logging(overrides the one in kubb.config.js).

silent will hide all information that is not relevant

info will show all information possible(not related to the PluginManager)

debug will show all information possible(related to the PluginManager), handy for seeing logs

kubb --log-level info

--debug

INFO

Alias for kubb generate log-level debug

kubb --debug

--watch (-w)

Watch mode based on the input file.

INFO

kubb --watch

--version (-v)

Output the version number.

INFO

kubb --version

--help (-h)

Display the help.

INFO

kubb --help

--bun (-b)

Run with Bun

INFO

kubb --bun