Kubb@kubb/cli 🦙 ​
Installation ​
shell
bun add @kubb/clibun add @kubb/clishell
pnpm add @kubb/clipnpm add @kubb/clishell
npm install @kubb/clinpm install @kubb/clishell
yarn add @kubb/cliyarn add @kubb/cliUsage ​
sh
kubb --config kubb.config.jskubb --config kubb.config.jsmdx
kubb/1.2.1
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`)
init Init Kubb
For more info, run any command with the `--help` flag:
$ kubb --help
$ kubb generate --help
$ kubb init --help
Options:
-h, --help Display this message
-v, --version Display version numberkubb/1.2.1
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`)
init Init Kubb
For more info, run any command with the `--help` flag:
$ kubb --help
$ kubb generate --help
$ kubb init --help
Options:
-h, --help Display this message
-v, --version Display version numberGenerate ​
WARNING
kubb generate and kubb are the same.
mdx
kubb/1.2.1
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 messagekubb/1.2.1
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 messagePath of the input file(overrides the one in kubb.config.js)
sh
kubb petStore.yamlkubb petStore.yamlOptions ​
--config (-c) ​
INFO
Path to the Kubb config.
sh
kubb --config kubb.config.tskubb --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
sh
kubb --log-level infokubb --log-level info--watch (-w) ​
Watch mode based on the input file.
INFO
sh
kubb --watchkubb --watch--version (-v) ​
Output the version number.
INFO
sh
kubb --versionkubb --version--help (-h) ​
Display the help.
INFO
sh
kubb --helpkubb --helpInit ​
Create a starting package.json with dependencies needed to get started with generating files.
mdx
kubb/1.2.1
Usage:
$ kubb init
Options:
-h, --help Display this messagekubb/1.2.1
Usage:
$ kubb init
Options:
-h, --help Display this messageDepended ​
See getting-started on how to configure Kubb.