These are the commands wxctl exposes. Each block is the live --help output for this build. The everyday workflow runs them in order: initvalidateplanapplytestdestroy.

Global flags

FlagDescription
-p, --profile <NAME>Configuration profile name (default default).
--profile-path <PATH>Path to a custom profile configuration file.
--full-traceCapture full-fidelity run records (also via WXCTL_FULL_TRACE=1).
All three are global and accepted on every command. -f, --filename is repeatable on the file-taking commands.

wxctl init

Set up a profile with service URLs and auth settings

Usage: wxctl init [OPTIONS]

Options:
  -f, --filename <FILE>      Config file(s) to scan for required services. If omitted, configures all services
  -p, --profile <NAME>       Configuration profile name [default: default]
      --profile-path <PATH>  Path to a custom profile configuration file
      --template             Print a profile template with placeholders instead of prompting interactively
      --full-trace           Capture full-fidelity run records: redacted bodies for all exchanges, debug/trace internals, hook payload diffs, and `src` on every event. Also settable via `WXCTL_FULL_TRACE=1`
  -h, --help                 Print help

Examples:
  wxctl init -f config.yaml   Set up profile for services in config
  wxctl init --template        Print a profile template to fill in manually

wxctl validate

Validate configuration files against schemas

Usage: wxctl validate [OPTIONS] --filename <FILE>

Options:
  -f, --filename <FILE>                 Config file(s), directory, or '-' for stdin. Can be specified multiple times
  -p, --profile <NAME>                  Configuration profile name [default: default]
      --fix-prompt [<ORIGINAL_PROMPT>]  On validation failure, output an LLM fix prompt instead of the normal summary. Optionally pass the path to the original generation prompt to produce a Guardrails-style retry prompt (original prompt + failed output + errors)
      --profile-path <PATH>             Path to a custom profile configuration file
      --full-trace                      Capture full-fidelity run records: redacted bodies for all exchanges, debug/trace internals, hook payload diffs, and `src` on every event. Also settable via `WXCTL_FULL_TRACE=1`
      --output <OUTPUT>                 Output format for structured output [possible values: json]
      --skip-post-validate              Skip post-validation checks (e.g. source_path existence) for pre-scaffold validation
  -h, --help                            Print help

Examples:
  wxctl validate -f config.yaml                              Check configuration is valid
  wxctl validate -f config.yaml --fix-prompt                 Output LLM fix prompt for errors
  wxctl validate -f config.yaml --fix-prompt prompt.md       Include original prompt for retry
  wxctl validate -f config.yaml --output json                Output structured JSON errors

wxctl plan

Preview changes without applying them

Usage: wxctl plan [OPTIONS] --filename <FILE>

Options:
  -f, --filename <FILE>      Config file(s), directory, or '-' for stdin. Can be specified multiple times
  -p, --profile <NAME>       Configuration profile name [default: default]
      --profile-path <PATH>  Path to a custom profile configuration file
      --full-trace           Capture full-fidelity run records: redacted bodies for all exchanges, debug/trace internals, hook payload diffs, and `src` on every event. Also settable via `WXCTL_FULL_TRACE=1`
  -h, --help                 Print help

wxctl apply

Apply configuration and provision resources

Usage: wxctl apply [OPTIONS] --filename <FILE>

Options:
  -f, --filename <FILE>      Config file(s), directory, or '-' for stdin. Can be specified multiple times
  -p, --profile <NAME>       Configuration profile name [default: default]
      --profile-path <PATH>  Path to a custom profile configuration file
      --full-trace           Capture full-fidelity run records: redacted bodies for all exchanges, debug/trace internals, hook payload diffs, and `src` on every event. Also settable via `WXCTL_FULL_TRACE=1`
  -h, --help                 Print help

Examples:
  wxctl apply -f config.yaml                 Provision resources
  wxctl apply -f agents.yaml -f tools.yaml   Merge multiple files
  wxctl apply -f ./configs/                  All YAML in a directory
  cat config.yaml | wxctl apply -f -         Read from stdin

wxctl test

Run tests against deployed resources

Usage: wxctl test [OPTIONS] --filename <FILE>

Options:
  -f, --filename <FILE>      Config file(s), directory, or '-' for stdin. Can be specified multiple times
  -p, --profile <NAME>       Configuration profile name [default: default]
      --profile-path <PATH>  Path to a custom profile configuration file
      --full-trace           Capture full-fidelity run records: redacted bodies for all exchanges, debug/trace internals, hook payload diffs, and `src` on every event. Also settable via `WXCTL_FULL_TRACE=1`
  -h, --help                 Print help

wxctl destroy

Destroy all resources defined in configuration

Usage: wxctl destroy [OPTIONS] --filename <FILE>

Options:
  -f, --filename <FILE>      Config file(s), directory, or '-' for stdin. Can be specified multiple times
  -p, --profile <NAME>       Configuration profile name [default: default]
      --profile-path <PATH>  Path to a custom profile configuration file
      --full-trace           Capture full-fidelity run records: redacted bodies for all exchanges, debug/trace internals, hook payload diffs, and `src` on every event. Also settable via `WXCTL_FULL_TRACE=1`
  -h, --help                 Print help

wxctl resources

List the resource kinds wxctl supports

Usage: wxctl resources [OPTIONS]

Options:
  -p, --profile <NAME>           Configuration profile name [default: default]
      --service <NAME>           Show only kinds belonging to this service (e.g. watsonx_data)
      --deployment <DEPLOYMENT>  Show only kinds available on this deployment [possible values: saas, software]
      --profile-path <PATH>      Path to a custom profile configuration file
      --full-trace               Capture full-fidelity run records: redacted bodies for all exchanges, debug/trace internals, hook payload diffs, and `src` on every event. Also settable via `WXCTL_FULL_TRACE=1`
  -o, --output <OUTPUT>          Output format [default: table] [possible values: table, json, yaml, markdown]
  -h, --help                     Print help

Examples:
  wxctl resources                                List all supported kinds
  wxctl resources --service watsonx_data         Filter to one service
  wxctl resources --deployment software          Kinds available on Software
  wxctl resources -o json                        Machine-readable output
  wxctl resources -o markdown                    Markdown table (coverage docs)

wxctl explain

Show one resource kind's fields, dependencies, and endpoints

Usage: wxctl explain [OPTIONS] <KIND>

Arguments:
  <KIND>  Resource kind to describe (e.g. presto_engine, tool, agent)

Options:
  -o, --output <OUTPUT>      Output format [default: table] [possible values: table, json, yaml, markdown]
  -p, --profile <NAME>       Configuration profile name [default: default]
      --profile-path <PATH>  Path to a custom profile configuration file
      --full-trace           Capture full-fidelity run records: redacted bodies for all exchanges, debug/trace internals, hook payload diffs, and `src` on every event. Also settable via `WXCTL_FULL_TRACE=1`
  -h, --help                 Print help

Examples:
  wxctl explain presto_engine             Fields + dependencies for a kind
  wxctl explain presto_engine -o json     Full descriptor as JSON
  wxctl explain tool -o yaml              Full descriptor as YAML

Other commands

wxctl also ships hidden subcommands used internally by LLM-driven configuration pipelines. They are not part of the supported user-facing surface and are omitted here.