Commands
This section documents all available commands in the CLI Wizard.
cli-wizard
CLI Wizard - Generate modern CLI from OpenAPI.
Usage
cli-wizard [OPTIONS] COMMAND [ARGS]...
Options
- --version
Show the version and exit.
- -d, --debug
Enable debug output
bootstrap
Bootstrap a new CLI project.
You will be guided through a step by step procedure to generate a basic CLI and an extensible configuration file to evolve it. No OpenAPI file is required.
PATH is the directory where the project will be created. It can be a relative or absolute path.
Usage
cli-wizard bootstrap [OPTIONS] PATH
Options
- -f, --force
Skip confirmation prompt if directory exists and is not empty
- -c, --configuration <configuration>
Path for cli-wizard.yaml (default: ./cli-wizard.yaml)
Arguments
- PATH
Required argument
config
Manage configurations.
Usage
cli-wizard config [OPTIONS] COMMAND [ARGS]...
get
Get a configuration value.
Usage
cli-wizard config get [OPTIONS] KEY
Arguments
- KEY
Required argument
reset
Reset configuration to defaults and delete local config file.
Usage
cli-wizard config reset [OPTIONS]
set
Set a configuration value.
Usage
cli-wizard config set [OPTIONS] KEY VALUE
Arguments
- KEY
Required argument
- VALUE
Required argument
show
Show all configuration values as JSON.
Usage
cli-wizard config show [OPTIONS]
unset
Unset a configuration value (set to None).
Usage
cli-wizard config unset [OPTIONS] KEY
Arguments
- KEY
Required argument
generate
Generate the CLI from config and OpenAPI spec.
PATH is the output directory where the CLI project will be generated. It can be a relative or absolute path.
If –api is provided, API commands will be generated from the OpenAPI spec. Otherwise, a functional CLI is generated without API commands.
Usage
cli-wizard generate [OPTIONS] PATH
Options
- -c, --configuration <configuration>
Required Path to cli-wizard.yaml configuration file
- -a, --api <api>
Path to OpenAPI spec file in YAML or JSON format (optional)
Arguments
- PATH
Required argument