kongctl patch file

Uses: kongctl
Related Documentation
Related Resources

Apply patches from a declarative config file.

Command usage

Usage:
  kongctl patch file <input-file> [patch-files...] [flags]

Examples:
  # Set timeouts on all services
  kongctl patch file kong.yaml -s '$..services[*]' -v 'read_timeout:30000'
  
  # Set multiple values
  kongctl patch file kong.yaml -s '$..services[*]' -v 'read_timeout:30000' -v 'write_timeout:30000'
  
  # Remove a key from the root object
  kongctl patch file config.yaml -s '$' -v 'debug:'
  
  # Append to an array
  kongctl patch file kong.yaml -s '$..routes[*].methods' -v '["OPTIONS"]'
  
  # Apply a patch file
  kongctl patch file kong.yaml patches.yaml
  
  # Apply multiple patch files in order
  kongctl patch file kong.yaml base.yaml env.yaml team.yaml
  
  # Read from stdin, write to a file
  cat kong.yaml | kongctl patch file - -s '$' -v 'version:"2.0"' --output-file output.yaml
  
  # Output as JSON
  kongctl patch file kong.yaml patches.yaml --format json --output-file output.json


Flags:
      --color-theme string      Configures the CLI UI/theme (prompt, tables, TUI elements).
                                - Config path: [ color-theme ]
                                - Examples   : [ auto, 3024_day, 3024_night, aardvark_blue, abernathy ]
                                - Reference  : [ https://github.com/lrstanley/bubbletint/blob/master/DEFAULT_TINTS.md ] (default "auto")
      --config-file string      Path to the configuration file to load.
                                - Default: [ $XDG_CONFIG_HOME/kongctl/config.yaml ]
      --format string           Output format: yaml or json (default "yaml")
  -h, --help                    help for file
      --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")
      --no-telemetry            Disable telemetry for this command invocation. Overrides config and env.
                                - Config path: [ telemetry.enabled ]
                                - Env var    : [ KONGCTL_NO_TELEMETRY ]
                                - Default    : [ false ]
  -o, --output string           Configures the format of data written to STDOUT.
                                - Config path: [ output ]
                                - Allowed    : [ json|yaml|text ] (default "text")
      --output-file string      Output file path (default: stdout) (default "-")
  -p, --profile string          Specify the profile to use for this command. (default "default")
  -s, --selector stringArray    JSONPath expression to select target nodes (repeatable)
      --text-id-format string   Configure UUID rendering in static text-table ID columns.
                                - Config path: [ text.id-format ]
                                - Allowed    : [ compact|full ]
                                - Default    : [ compact ]
      --text-layout string      Configure static text-table column selection.
                                - Config path: [ text.layout ]
                                - Allowed    : [ compact|auto|wide ]
                                - Default    : [ compact ]
  -v, --value stringArray       Value to set: "key:json-value", "key:" (remove), or "[values]" (append). Repeatable.

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!