Skip to content

cub link list

List links

Synopsis

List links you have access to in a space or across all spaces. The output includes slugs, source unit slugs (From-Unit), target unit slugs (To-Unit), and target space slugs (To-Space).

Examples: 

  # List all links in a space
  cub link list --space my-space

  # List links across all spaces
  cub link list --where "DisplayName = 'app-to-db'"

  # List links without headers for scripting
  cub link list --space my-space --no-headers

  # List only link names
  cub link list --space my-space --no-headers -o name

  # List links in JSON format
  cub link list --space my-space -o json

  # List links with custom JQ filter
  cub link list --space my-space --quiet -o jq=".[].Slug"

  # List links to a specific unit
  cub link list --space my-space --where "ToUnitID = 'c871ca3a-d9ca-4eeb-a576-79c3b5a2ca97'"

  # List links from a specific unit
  cub link list --space my-space --where "FromUnitID = 'c871ca3a-d9ca-4eeb-a576-79c3b5a2ca97'"

  # List cross-space links across all spaces
  cub link list --where "ToSpaceID != SpaceID"

  # List the links that are behind their upstream unit and do not update themselves
  cub link list --where "Stale = true AND AutoUpdate = false"

  # List the links that carry a named attribute
  cub link list --where "Bindings.*.AttributeName = 'image'"

  # List the transform links that write a path
  cub link list --where "DownstreamPaths.*.Path LIKE 'spec.replicas%'"

  # List the links that stamp a guard on what they write
  cub link list --where "Guards.owner = 'transform-link'"

cub link list [flags]

Options

      --columns strings               columns to display; can be repeated or comma-separated (e.g., Slug,Labels.Environment)
      --contains string               Free text search for entities containing the specified text. Searches across string fields (like Slug, DisplayName) and map fields (like Labels, Annotations). Case-insensitive matching. Can be combined with --where using AND logic. Example: "backend" to find entities with backend in any searchable field
      --filter string                 Filter entity to apply to the list. Specify as 'space/filter' for cross-space filters or just 'filter' for current space. Supports both slugs and UUIDs. The filter will be combined with any --where clause using AND logic. Examples: "production-filters/security-check", "my-filter-uuid", "validation-rules"
  -h, --help                          help for list
      --include-hidden string[="*"]   Also select hidden entities, to list or to act on: those hidden for the given HiddenReasons, comma-separated, as in --include-hidden=BackingUnit, or for any reason when given no value or "*". ConfigHub/YAML Units, which hold the configuration of other entities, are hidden with the reason BackingUnit. A --where naming entities by Slug or ID selects them whether hidden or not
      --limit int                     Return at most this many entities; 0 returns all of them. They are read from the server in pages of at most 1000
      --no-headers                    Don't print headers for table output
      --order-by string               Order the entities by these fields, as comma-separated 'ASC:Field', 'DESC:Field' or 'Field' terms, such as "DESC:CreatedAt". Entities with equal values are ordered by ID. With --limit, this decides which entities are returned
  -o, --output string                 Output format. One of: json, yaml, name, wide, mutations, jq=<expr>, yq=<expr>, custom-columns=<spec>
      --quiet                         No default output.
      --select string                 Comma-separated list of fields to retrieve and display. Entity IDs and Slug are always included. Example: "DisplayName,CreatedAt,Labels"
      --verbose                       Detailed output, additive with default output
      --view string                   View, by slug or UUID, whose columns to display. The View's Filter, if it has one, selects the entities as --filter does
      --where string                  Filter expression using SQL-inspired syntax. Supports conjunctions with AND. String operators: =, !=, <, >, <=, >=, LIKE, NOT LIKE, ILIKE, ~~, !~~, ~, ~*, !~, !~*. Pattern matching with LIKE/ILIKE uses % and _ wildcards. Regex operators (~, ~*, !~, !~*) support POSIX regular expressions. A related entity is referenced by prefix, as in "UpstreamUnit.Slug = 'base'"; when the reference names a list, a * segment matches any element, as in "FromLink.*.Slug = 'upgrade-app'". Examples: "Slug LIKE 'app-%'", "DisplayName ILIKE '%backend%'", "Slug ~ '^[a-z]+-[0-9]+$'"

Options inherited from parent commands

      --component string   the Component of --variant, when that names the variant alone; --variant <component>/<variant> says the same in one flag
      --context string     The context to use for this command
      --debug              Debug output
      --space string       space to operate in, by slug or UUID. Omitted, a list or bulk operation spans the organization and a single entity is named as <space>/<slug>; "*" means the same as omitting it
      --variant string     variant to operate in, as <component>/<variant>, or as <variant> with --component: the space naming that Component whose Variant label is <variant>. The same scope as --space, named by what it is rather than by the space's slug; the two cannot be combined

SEE ALSO