UDS CLI
UDS CLI is the primary interface for working with UDS bundles. It handles the full bundle lifecycle: building from a uds-bundle.yaml, publishing to OCI registries, deploying to clusters, and removing bundles when no longer needed. It also provides UDS Runner for task automation and access to the vendored Zarf CLI.
Key Commands
Section titled “Key Commands”| Command | Description |
|---|---|
uds create | Build a UDS Bundle from a uds-bundle.yaml |
uds deploy | Deploy a bundle from a local file or OCI registry |
uds inspect | Inspect bundle metadata, images, SBOMs, and variables |
uds publish | Publish a bundle to an OCI registry |
uds remove | Remove a deployed bundle from a cluster |
uds run | Execute tasks from a tasks.yaml via UDS Runner |
uds monitor pepr | Stream Pepr admission and operator logs |
uds zarf | Access the vendored Zarf CLI |
Full command reference is available via uds --help and uds <command> --help.
Getting Started Install UDS CLI and deploy your first bundle.
How-to Guides Common operational patterns.
Schema Validation & IDE Setup
Section titled “Schema Validation & IDE Setup”UDS CLI ships with a JSON schema for uds-bundle.yaml. To enable IDE autocompletion and validation, see the schema validation docs.
Ecosystem Context
Section titled “Ecosystem Context”UDS CLI works alongside UDS Core, the platform layer providing networking, identity, security, and observability. To understand how bundles fit into the broader UDS ecosystem, see:
Get Involved