Skip to content

cub run get-yq

cub run get-yq

Returns the result of running yq with the specified expression on the configuration data filtered by WhereResource. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/TOML, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML, AppConfig/Properties, AppConfig/Text

cub run get-yq [flags]

Options

  -h, --help                           help for get-yq
      --param $params.<key>            Parameters passed to the yq expression as key=value strings, accessible as $params.<key> (values are strings; use `| tonumber` or `| tobool` to coerce).
      --yq-expression select() | ...   (required) yq expression. Use select() | ... to get values from a subset of the documents. Params passed via the `param` argument are accessible as `$params.<key>` (e.g. `$params.foo`).

Options inherited from parent commands

      --change-desc string      change description
      --changeset string        changeset to associate units with
      --context string          The context to use for this command
      --debug                   Debug output
      --dry-run                 dry run mode: execute functions but skip updating configuration data
      --executor-space string   Space ID or slug whose executor to use for builtin functions (org-level only)
      --filter string           filter to apply (slug, space/filter, or UUID)
      --livestate-type string   Invoke the function on the live state and use the flag value as the toolchain type for live state.
  -o, --output string           Output format. One of: json, yaml, name, wide, mutations, jq=<expr>, yq=<expr>, custom-columns=<spec>
      --quiet                   No output
      --resource-type string    resource-type filter
      --show string             Select which part of the function response to display. One of: output, values, data
      --space string            space ID to perform command on
      --toolchain string        Toolchain type for the function invocations (default "Kubernetes/YAML")
      --unit strings            target specific units by slug or UUID (can be repeated or comma-separated)
      --wait                    wait for completion
      --where string            where filter
      --where-data string       where data filter
      --where-resource string   filter which resources the function operates on
      --worker string           worker to execute the function

SEE ALSO