kongctl scaffold

Beta and uses: kongctl
Related Documentation
Incompatible with
on-prem

Scaffold emits a commented YAML starter configuration for a supported declarative resource path.

The output is intended to be edited and then used with declarative commands such as apply or sync.

Command usage

Usage:
  kongctl scaffold <resource-path> [flags]

Examples:
  # Generate a starter API configuration
  kongctl scaffold api
  # Generate a root-level child resource scaffold
  kongctl scaffold api_version
  # Generate a nested child scaffold
  kongctl scaffold api.versions


Flags:
      --color-theme string   Configures the CLI UI/theme (prompt, tables, TUI elements).
                             - Config path: [ color-theme ]
                             - Examples   : [ 3024_day, 3024_night, aardvark_blue, abernathy, adventure ]
                             - Reference  : [ https://github.com/lrstanley/bubbletint/blob/master/DEFAULT_TINTS.md ] (default "kong-light")
      --config-file string   Path to the configuration file to load.
                             - Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
  -h, --help                 help for scaffold
      --log-file string      Write execution logs to the specified file instead of STDERR.
                             - Config path: [ log-file ]
      --log-level string     Configures the logging level. Execution logs are written to STDERR.
                             - Config path: [ log-level ]
                             - Allowed    : [ trace|debug|info|warn|error ] (default "error")
  -o, --output string        Configures the format of data written to STDOUT.
                             - Config path: [ output ]
                             - Allowed    : [ json|yaml|text ] (default "text")
  -p, --profile string       Specify the profile to use for this command. (default "default")

Help us make these docs great!

Kong Developer docs are open source. If you find these useful and want to make them better, contribute today!