Skip to content

cub run list-paths

cub run list-paths

Returns every path present in the configuration data, in the syntax the set-* functions accept, together with its value and the registered attribute it belongs to, if any. Reports what the data contains, not what its schema permits. Restrict the output with path-prefix, depth, and attributes-only; WhereResource restricts which resources are walked. Supported toolchains: AppConfig/Env, AppConfig/INI, AppConfig/JSON, AppConfig/Properties, AppConfig/TOML, AppConfig/Text, AppConfig/YAML, ConfigHub/YAML, Kubernetes/YAML

cub run list-paths [flags]

Options

      --attributes-only      Report only paths bound to a registered attribute, which is the set reachable through named setters such as set-image. See https://docs.confighub.com/guide/functions/#getters-and-setters-attributes-and-the-path-registry.
      --depth int            Report only paths within this many segments of the resource root. 0, the default, reports every depth. An associative segment counts as one segment, as does a list index.
  -h, --help                 help for list-paths
      --include-subtrees     Also report the paths of maps and lists, which set-path can target whole. Subtree rows carry a YAML DataType and no Value; only leaf paths have values.
      --path-prefix string   Report only paths at or below this one. Matched segment by segment against both the indexed and the associative spelling of each path, so either form of a list element selects it. See https://docs.confighub.com/guide/functions/#configuration-path-syntax for path syntax.

Options inherited from parent commands

      --change-desc string      change description
      --changeset string        changeset to associate units with
      --clearance stringArray   class of guarded reason this change is cleared for, as KEY, KEY=VALUE[,VALUE...], KEY!=VALUE[,VALUE...], or !KEY to refuse any path carrying KEY (repeatable). A guarded path this does not cover is not written, and the withheld change is reported as a conflict
      --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)
      --guard stringArray       reason to record on the paths this change writes, as KEY=VALUE (repeatable). A later operation must be cleared for it before overwriting those paths. Adds and overwrites only; retiring a guard is cub unit set-guard --remove-guard
  -o, --output string           Output format. One of: json, yaml, name, wide, mutations, jq=<expr>, yq=<expr>, custom-columns=<spec>
      --protect                 record the paths this change writes as protected local overrides, so a later merge from upstream does not overwrite them; by default a change claims nothing and each path keeps the protection it already has
      --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