Skip to content

cub unit list

cub unit list

List units

Synopsis

List units you have access to in a space, or across the organization without --space. The output includes slugs, data size, head revision, validation errors, and last change timestamp.

Examples: 

  # List all units in a space
  cub unit list --space my-space

  # List units without headers for scripting
  cub unit list --space my-space --no-headers

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

  # List units with specific labels
  cub unit list --space my-space --where "Labels.tier = 'Backend'"

  # List units a particular Trigger gates
  cub unit list --space my-space --where "ValidationErrors.my-space/no-latest/vet-cel = true"

  # List units with any validation errors
  cub unit list --space my-space --where "LEN(ValidationErrors) > 0"

  # List the units a Release of a variant's space publishes
  cub unit list --variant my-app/prod

  # List every unit of a variant, including those no Release publishes
  cub unit list --variant my-app/prod --include-unreleasable

  # List the units a Release publishes, in every space
  cub unit list --where "TargetID IS NOT NULL"

  # List units with upstream revisions
  cub unit list --space my-space --where "UpstreamRevisionNum > 0"

  # List units that need a value and have none of it bound to a link yet
  cub unit list --where "NeededPaths.*.AttributeName IS NOT NULL AND NeededPaths.*.Details.BoundLinkID IS NULL"

  # List units that provide a named attribute
  cub unit list --where "ProvidedPaths.*.AttributeName = 'image'"

  # List units with jq filtering
  cub unit list --space my-space --quiet -o jq='.[].Unit.Slug'

  # List units with custom columns
  cub unit list --space my-space --columns Unit.Slug,Target.Slug

  # List units showing label and annotation values
  cub unit list --space my-space --columns Unit.Slug,Unit.Labels.Environment,Unit.Labels.Tier,Unit.Annotations.Owner

Available columns (prefixed with Unit.):

  • Basic: Slug (or Name), DataBytes, HeadRevisionNum, HeadMutationNum
  • Metadata: CreatedAt, UpdatedAt, SpaceID, OrganizationID, UnitID
  • Status: ValidationErrors, LastChangeDescription
  • Relationships: TargetID, ToolchainType, Unreleasable
  • Revisions: LastReleasedRevisionNum
  • Dynamic: Labels., Annotations.

Example extended available columns (not exhaustive):

  • Basic: Space.Slug, Target.Slug
cub unit 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
      --include-unreleasable          with --variant, also list the Unreleasable units, which a Release of the variant's space does not publish, such as AppConfig units
      --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.
      --resource-type string          resource-type filter
      --select string                 Comma-separated list of fields to retrieve and display. Entity IDs and Slug are always included. Example: "DisplayName,CreatedAt,Labels"
      --trigger-filter string         Filter UUID (with From=Trigger) for trigger validation filtering
      --triggers-passed               return units passing trigger validation (default: return failing units)
      --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]+$'". 'cub <entity> explain --where' lists the attributes an entity's expressions can name
      --where-data string             where data filter
      --where-permission string       Only list the entities on which you have this permission, as well as View, which every entity listed needs: those an action that needs it would not be refused on. One of Manage, Edit, Use or View, or another the entity type's Permissions grant, such as CreateChildren on a space, Approve on a unit, or Impersonate on a service account. Example: "Edit" to list the entities you can change
      --where-trigger string          where expression to match triggers for validation filtering

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