Skip to content

cub unit list

cub unit list

List units

Synopsis

List units you have access to in a space. The output includes slugs, data size, head revision, apply gates, 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 with approval gates
  cub unit list --space my-space --where "ApplyGates.require-approval/vet-approvedby = true"

  # List units with any apply gates
  cub unit list --space my-space --where "LEN(ApplyGates) > 0"

  # List units that have been approved
  cub unit list --space my-space --where "LEN(ApprovedBy) > 0"

  # List units approved by a specific user
  cub unit list --space my-space --where "ApprovedBy ? 'd1b98309-874c-44ab-b1f2-a505e53dd9e8'"

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

  # 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: ApplyGates, LastChangeDescription, LiveRevisionNum, LiveState, ApprovedBy
  • Relationships: TargetID, ToolchainType
  • Revisions: LastAppliedRevisionNum, PreviousLiveRevisionNum
  • Dynamic: Labels., Annotations.

Example extended available columns (not exhaustive):

  • Basic: Space.Slug, Target.Slug
  • Status: UnitStatus.Status
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
      --no-headers              Don't print headers for table output
  -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 slug or UUID to apply column definitions and optional filtering
      --web                     Open in web UI instead of executing
      --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. Examples: "Slug LIKE 'app-%'", "DisplayName ILIKE '%backend%'", "Slug ~ '^[a-z]+-[0-9]+$'"
      --where-data string       where data filter
      --where-trigger string    where expression to match triggers for validation filtering

Options inherited from parent commands

      --context string   The context to use for this command
      --debug            Debug output
      --space string     space ID to perform command on

SEE ALSO