CLI Reference

up

The Upbound CLI.

Please report issues and feature requests at https://github.com/upbound/upbound.

Options

`--help`

Shorthand: -h
Show context-sensitive help.

`--format`

Default: default
Format for get/list commands. Can be: json, yaml, default

`--quiet`

Shorthand: -q
Suppress all output.

`--pretty`

Pretty print output.

`--dry-run`

dry-run output.

up alpha

Alpha features. Commands may be removed in future releases.

up alpha ctx

Select an Upbound kubeconfig context.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

`--short`

Shorthand: -s
Short output.

`--context`

Default: upbound
Kubernetes context to operate on.

`--file`

Shorthand: -f
Kubeconfig to modify when saving a new context. Overrides the --kubeconfig flag. Use '-' to write to standard output.

up alpha migration

Migrate control planes to Upbound Managed Control Planes.

Options

`--kubeconfig`

Override default kubeconfig path.

up alpha migration export

The 'export' command is used to export the current state of a Crossplane or Universal Crossplane (xp/uxp) control plane into an archive file. This file can then be used for migration to Upbound Managed Control Planes.

Options

`--yes`

Default: false
When set to true, automatically accepts any confirmation prompts that may appear during the export process.

`--output`

Shorthand: -o
Default: xp-state.tar.gz
Specifies the file path where the exported archive will be saved. Defaults to 'xp-state.tar.gz'.

`--include-extra-resources`

Default: namespaces,configmaps,secrets
A list of extra resource types to include in the export in "resource.group" format in addition to all Crossplane resources. By default, it includes namespaces, configmaps, secrets.

`--exclude-resources`

A list of resource types to exclude from the export in "resource.group" format. No resources are excluded by default.

`--include-namespaces`

A list of specific namespaces to include in the export. If not specified, all namespaces are included by default.

`--exclude-namespaces`

Default: kube-system,kube-public,kube-node-lease,local-path-storage
A list of specific namespaces to exclude from the export. Defaults to 'kube-system', 'kube-public', 'kube-node-lease', and 'local-path-storage'.

`--pause-before-export`

Default: false
When set to true, pauses all claim,composite and managed resources before starting the export process. This can help ensure a consistent state for the export. Defaults to false.

up alpha migration import

The 'import' command imports a control plane state from an archive file into an Upbound managed control plane.

Options

`--yes`

Default: false
When set to true, automatically accepts any confirmation prompts that may appear during the import process.

`--input`

Shorthand: -i
Default: xp-state.tar.gz
Specifies the file path of the archive to be imported. The default path is 'xp-state.tar.gz'.

`--unpause-after-import`

Default: false
When set to true, automatically unpauses all managed resources that were paused during the import process. This helps in resuming normal operations post-import. Defaults to false, requiring manual unpausing of resources if needed.

`--mcp-connector-cluster-id`

MCP Connector cluster ID. Required for importing claims supported my MCP Connector.

`--mcp-connector-claim-namespace`

MCP Connector claim namespace. Required for importing claims supported by MCP Connector.

`--skip-target-check`

Default: false
When set to true, skips the check for a local or managed control plane during import.

up alpha migration pause-toggle

The 'pause-toggle' command is used to pause or unpause resources affected by a migration, ensuring that only migration-induced pauses are undone.

Options

`--pause`

Default: false
Set to 'true' to pause all resources in the target control plane after a faulty migration, or 'false' to remove the paused annotation in the source control plane after a failed migration.

`--yes`

Default: false
When set to true, automatically accepts any confirmation prompts that may appear during the process.

up alpha space

Interact with Spaces.

up alpha space billing

up alpha space billing export

Export a billing report for submission to Upbound.

Options

`--out`

Shorthand: -o
Default: upbound_billing_report.tgz
Name of the output file.

`--provider`

Storage provider. Must be one of: aws, gcp, azure.

`--bucket`

Storage bucket.

`--endpoint`

Custom storage endpoint.

`--account`

Name of the Upbound account whose billing report is being collected.

`--azure-storage-account`

Name of the Azure storage account. Required for --provider=azure.

`--billing-month`

Export a report for a billing period of one calendar month. Format: 2006-01.

`--billing-custom`

Export a report for a custom billing period. Date range is inclusive. Format: 2006-01-02/2006-01-02.

`--force-incomplete`

Export a report for an incomplete billing period.

up alpha space connect (attach)

Connect an Upbound Space to the Upbound web console.

Options

`--registry-repository`

Default: xpkg.upbound.io/spaces-artifacts
Set registry for where to pull OCI artifacts from. This is an OCI registry reference, i.e. a URL without the scheme or protocol prefix.

`--registry-endpoint`

Default: https://xpkg.upbound.io
Set registry endpoint, including scheme, for authentication.

`--token-file`

File containing authentication token. Expecting a JSON file with "accessId" and "token" keys.

`--registry-username`

Set the registry username.

`--registry-password`

Set the registry password.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

`--robot-token`

The Upbound robot token contents used to authenticate the connection.

`--up-environment`

Default: prod
Override the default Upbound Environment.

up alpha space destroy

Remove the Upbound Spaces deployment.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

`--registry-repository`

Default: xpkg.upbound.io/spaces-artifacts
Set registry for where to pull OCI artifacts from. This is an OCI registry reference, i.e. a URL without the scheme or protocol prefix.

`--registry-endpoint`

Default: https://xpkg.upbound.io
Set registry endpoint, including scheme, for authentication.

`--yes-really-delete-space-and-all-data`

Bypass safety checks and destroy Spaces

`--orphan`

Remove Space components but retain Control Planes and data

up alpha space disconnect (detach)

Disconnect an Upbound Space from the Upbound web console.

Options

`--registry-repository`

Default: xpkg.upbound.io/spaces-artifacts
Set registry for where to pull OCI artifacts from. This is an OCI registry reference, i.e. a URL without the scheme or protocol prefix.

`--registry-endpoint`

Default: https://xpkg.upbound.io
Set registry endpoint, including scheme, for authentication.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up alpha space init

Initialize an Upbound Spaces deployment.

Options

`--registry-repository`

Default: xpkg.upbound.io/spaces-artifacts
Set registry for where to pull OCI artifacts from. This is an OCI registry reference, i.e. a URL without the scheme or protocol prefix.

`--registry-endpoint`

Default: https://xpkg.upbound.io
Set registry endpoint, including scheme, for authentication.

`--token-file`

File containing authentication token. Expecting a JSON file with "accessId" and "token" keys.

`--registry-username`

Set the registry username.

`--registry-password`

Set the registry password.

`--set`

Set parameters.

`--file`

Shorthand: -f
Parameters file.

`--bundle`

Local bundle path.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

`--yes`

Answer yes to all questions

`--public-ingress`

For AKS,EKS,GKE expose ingress publically

up alpha space list

List all accessible spaces in Upbound.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up alpha space mirror

Managing the mirroring of artifacts to local storage or private container registries.

Options

`--registry-repository`

Default: xpkg.upbound.io/spaces-artifacts
Set registry for where to pull OCI artifacts from. This is an OCI registry reference, i.e. a URL without the scheme or protocol prefix.

`--registry-endpoint`

Default: https://xpkg.upbound.io
Set registry endpoint, including scheme, for authentication.

`--token-file`

File containing authentication token. Expecting a JSON file with "accessId" and "token" keys.

`--registry-username`

Set the registry username.

`--registry-password`

Set the registry password.

`--output-dir`

Shorthand: -t
The local directory path where exported artifacts will be saved as .tgz files.

`--destination-registry`

Shorthand: -d
The target container registry where the artifacts will be mirrored.

`--version`

Shorthand: -v
The specific Spaces version for which the artifacts will be mirrored.

up alpha space upgrade

Upgrade the Upbound Spaces deployment.

Options

`--registry-repository`

Default: xpkg.upbound.io/spaces-artifacts
Set registry for where to pull OCI artifacts from. This is an OCI registry reference, i.e. a URL without the scheme or protocol prefix.

`--registry-endpoint`

Default: https://xpkg.upbound.io
Set registry endpoint, including scheme, for authentication.

`--token-file`

File containing authentication token. Expecting a JSON file with "accessId" and "token" keys.

`--registry-username`

Set the registry username.

`--registry-password`

Set the registry password.

`--set`

Set parameters.

`--file`

Shorthand: -f
Parameters file.

`--bundle`

Local bundle path.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

`--yes`

Answer yes to all questions

`--rollback`

Rollback to previously installed version on failed upgrade.

up completion

Generate shell autocompletions

Options

`--uninstall`

up composition

Manage Compositions.

up composition generate

Generate an Composition.

Options

`--name`

Name for the new composition.

`--plural`

Optional custom plural for the CompositeTypeRef.Kind

`--path`

Optional path to the output file where the generated Composition will be saved.

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

`--output`

Shorthand: -o
Default: file
Output format for the results: 'file' to save to a file, 'yaml' to print XRD in YAML format, 'json' to print XRD in JSON format.

`--cache-dir`

Default: ~/.up/cache/
Directory used for caching dependency images.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up composition render

Run a composition locally to render an XR into composed resources.

Options

`--xrd`

A YAML file specifying the CompositeResourceDefinition (XRD) to validate the XR against.

`--context-files`

Comma-separated context key-value pairs to pass to the Function pipeline. Values must be files containing JSON.

`--context-values`

Comma-separated context key-value pairs to pass to the Function pipeline. Values must be JSON. Keys take precedence over --context-files.

`--include-function-results`

Shorthand: -r
Include informational and warning messages from Functions in the rendered output as resources of kind: Result.

`--include-full-xr`

Shorthand: -x
Include a direct copy of the input XR's spec and metadata fields in the rendered output.

`--observed-resources`

Shorthand: -o
A YAML file or directory of YAML files specifying the observed state of composed resources.

`--extra-resources`

Shorthand: -e
A YAML file or directory of YAML files specifying extra resources to pass to the Function pipeline.

`--include-context`

Shorthand: -c
Include the context in the rendered output as a resource of kind: Context.

`--function-credentials`

A YAML file or directory of YAML files specifying credentials to use for Functions to render the XR.

`--timeout`

Default: 1m
How long to run before timing out.

`--max-concurrency`

Default: 8
Maximum number of functions to build at once.

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

`--cache-dir`

Default: ~/.up/cache/
Directory used for caching dependency images.

`--no-build-cache`

Default: false
Don't cache image layers while building.

`--build-cache-dir`

Default: ~/.up/build-cache
Path to the build cache directory.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up controlplane (ctp)

Interact with control planes in the current context, both in the cloud and in a local Space.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up controlplane (ctp) configuration

Manage Configurations.

up controlplane (ctp) configuration install

Install a Configuration.

Options

`--name`

Name of Configuration.

`--package-pull-secrets`

List of secrets used to pull Configuration.

`--wait`

Shorthand: -w
Wait duration for successful Configuration installation.

up controlplane (ctp) connect

Deprecated: Connect kubectl to control plane.

Options

`--token`

API token used to authenticate. Required for Upbound Cloud; ignored otherwise.

`--group`

Shorthand: -g
The control plane group that the control plane is contained in. By default, this is the group specified in the current profile.

up controlplane (ctp) connector

Connect an App Cluster to a control plane.

up controlplane (ctp) connector install

Install mcp-connector into an App Cluster.

Options

`--token`

API token used to authenticate. If not provided, a new robot and a token will be created.

`--cluster-name`

Name of the cluster connecting to the control plane. If not provided, the namespace argument value will be used.

`--kubeconfig`

Override the default kubeconfig path.

`--installation-namespace`

Shorthand: -n
Default: kube-system
Kubernetes namespace for MCP Connector. Default is kube-system.

`--control-plane-secret`

Name of the secret that contains the kubeconfig for a control plane.

`--set`

Set parameters.

`--file`

Shorthand: -f
Parameters file.

`--bundle`

Local bundle path.

up controlplane (ctp) connector uninstall

Uninstall mcp-connector from an App Cluster.

Options

`--cluster-name`

Name of the cluster connecting to the control plane. If not provided, the namespace argument value will be used.

`--kubeconfig`

Override the default kubeconfig path.

`--installation-namespace`

Shorthand: -n
Default: kube-system
Kubernetes namespace for MCP Connector. Default is kube-system.

up controlplane (ctp) create

Create a control plane.

Options

`--group`

Shorthand: -g
The control plane group that the control plane is contained in. This defaults to the group specified in the current context

`--crossplane-version`

The version of Universal Crossplane to use. The default depends on the selected auto-upgrade channel.

`--crossplane-channel`

Default: Stable
The Crossplane auto-upgrade channel to use. Must be one of: None, Patch, Stable, Rapid

`--secret-name`

The name of the control plane's secret. Defaults to kubeconfig-{control plane name}. Only applicable for Space control planes.

up controlplane (ctp) delete

Delete a control plane.

Options

`--group`

Shorthand: -g
The control plane group that the control plane is contained in. This defaults to the group specified in the current context

up controlplane (ctp) disconnect

Deprecated: Disconnect kubectl from control plane.

up controlplane (ctp) function

Manage Functions.

up controlplane (ctp) function install

Install a Function.

Options

`--name`

Name of Function.

`--package-pull-secrets`

List of secrets used to pull Function.

`--wait`

Shorthand: -w
Wait duration for successful Function installation.

up controlplane (ctp) get

Get a single control plane.

Options

`--group`

Shorthand: -g
The control plane group that the control plane is contained in. This defaults to the group specified in the current context

up controlplane (ctp) list

List control planes for the organization.

Options

`--all-groups`

Shorthand: -A
Default: false
List control planes across all groups.

`--group`

Shorthand: -g
The control plane group that the control plane is contained in. This defaults to the group specified in the current context

up controlplane (ctp) provider

Manage Providers.

up controlplane (ctp) provider install

Install a Provider.

Options

`--name`

Name of Provider.

`--package-pull-secrets`

List of secrets used to pull Provider.

`--wait`

Shorthand: -w
Wait duration for successful Provider installation.

up controlplane (ctp) pull-secret

Manage package pull secrets.

up controlplane (ctp) pull-secret create

Create a package pull secret.

Options

`--file`

Shorthand: -f
Path to credentials file. Credentials from profile are used if not specified.

`--namespace`

Shorthand: -n
Default: crossplane-system
Kubernetes namespace for pull secret.

up controlplane (ctp) simulate

Alias for 'up controlplane simulation create'.

Options

`--group`

Shorthand: -g
The control plane group that the control plane is contained in. This defaults to the group specified in the current context

`--simulation-name`

Shorthand: -n
The name of the simulation resource

`--changeset`

Shorthand: -f
Path to the resources that will be applied as part of the simulation. Can either be a single file or a directory

`--recursive`

Shorthand: -r
Default: false
Process the directory used in -f, --changeset recursively.

`--complete-after`

Default: 60s
The maximum amount of time the simulated control plane should run before ending the simulation

`--fail-on`

Default: none
Fail and exit with a code of '1' if a certain condition is met

`--output`

Shorthand: -o
Output the results of the simulation to the provided file. Defaults to standard out if not specified

`--wait`

Default: true
Wait for the simulation to complete. If set to false, the command will exit immediately after the changeset is applied

`--terminate-on-finish`

Default: false
Terminate the simulation after the completion criteria is met

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up controlplane (ctp) simulation (sim)

Manage control plane simulations.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up controlplane (ctp) simulation (sim) create

Start a new control plane simulation and wait for the results.

Options

`--group`

Shorthand: -g
The control plane group that the control plane is contained in. This defaults to the group specified in the current context

`--simulation-name`

Shorthand: -n
The name of the simulation resource

`--changeset`

Shorthand: -f
Path to the resources that will be applied as part of the simulation. Can either be a single file or a directory

`--recursive`

Shorthand: -r
Default: false
Process the directory used in -f, --changeset recursively.

`--complete-after`

Default: 60s
The maximum amount of time the simulated control plane should run before ending the simulation

`--fail-on`

Default: none
Fail and exit with a code of '1' if a certain condition is met

`--output`

Shorthand: -o
Output the results of the simulation to the provided file. Defaults to standard out if not specified

`--wait`

Default: true
Wait for the simulation to complete. If set to false, the command will exit immediately after the changeset is applied

`--terminate-on-finish`

Default: false
Terminate the simulation after the completion criteria is met

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up controlplane (ctp) simulation (sim) delete

Delete a control plane simulation.

Options

`--group`

Shorthand: -g
The group that the simulation is contained in. This defaults to the group specified in the current context

up controlplane (ctp) simulation (sim) list

List control plane simulations for the account.

Options

`--all-groups`

Shorthand: -A
Default: false
List simulations across all groups.

`--group`

Shorthand: -g
The group that the simulation is contained in. This defaults to the group specified in the current context

up ctx

Select an Upbound kubeconfig context.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

`--short`

Shorthand: -s
Short output.

`--context`

Default: upbound
Kubernetes context to operate on.

`--file`

Shorthand: -f
Kubeconfig to modify when saving a new context. Overrides the --kubeconfig flag. Use '-' to write to standard output.

up dependency (dep)

Manage configuration dependencies.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up dependency (dep) add

Add a dependency to the current project.

Options

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

`--cache-dir`

Default: ~/.up/cache/
Directory used for caching package images.

up dependency (dep) clean-cache

Clean the dependency cache.

Options

`--cache-dir`

Default: ~/.up/cache/
Directory used for caching package images.

up dependency (dep) update-cache

Update the dependency cache for the current project.

Options

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

`--cache-dir`

Default: ~/.up/cache/
Directory used for caching package images.

up example

Manage Claim(XRC) or Composite Resource(XR).

up example generate

Generate an Example Claim (XRC) or Composite Resource (XR).

Options

`--path`

Specifies the path to the output file where the Composite Resource (XR) or Composite Resource Claim (XRC) will be saved.

`--output`

Shorthand: -o
Default: file
Specifies the output format for the results. Use 'file' to save to a file, 'yaml' to display the Composite Resource (XR) or Composite Resource Claim (XRC) in YAML format, or 'json' to display in JSON format.

`--type`

Specifies the type of resource to create: 'xrc' for Composite Resource Claim (XRC), 'xr' for Composite Resource (XR).

`--api-group`

Specifies the API group for the resource.

`--api-version`

Specifies the API version for the resource.

`--kind`

Specifies the Kind of the resource.

`--name`

Specifies the Name of the resource.

`--namespace`

Specifies the Namespace of the resource.

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

up function

Manage Functions.

up function generate

Generate an Function for a Composition.

Options

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

`--repository`

Repository for the built package. Overrides the repository specified in the project file.

`--cache-dir`

Default: ~/.up/cache/
Directory used for caching dependency images.

`--language`

Shorthand: -l
Default: kcl
Language for function.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up group

Interact with groups inside Spaces.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up group create

Create a group.

up group delete

Delete a group.

Options

`--force`

Default: false
Force the deletion of the group.

up group get

Get a group.

up group list

List groups in the space.

up help

Show help.

up license

Show license information.

Options

`--username`

Shorthand: -u
Username used to execute command.

`--password`

Shorthand: -p
Password for specified user. '-' to read from stdin.

`--token`

Shorthand: -t
Upbound API token (personal access token) used to execute command. '-' to read from stdin.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up logout

Logout of Upbound.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up organization (org)

Interact with Upbound organizations.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up organization (org) create

Create an organization.

up organization (org) delete

Delete an organization.

Options

`--force`

Default: false
Force deletion of the organization.

up organization (org) get

Get an organization.

up organization (org) list

List organizations.

up organization (org) token

Generates an organization-scoped token to authenticate with a Cloud space.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

`--token`

Shorthand: -t
Token used to execute command. Overrides the token present in the profile.

up organization (org) user

Manage organization users.

up organization (org) user invite

Invite a user to the organization.

Options

`--permission`

Shorthand: -p
Default: member
Role of the user to invite (owner or member).

up organization (org) user list

List users of an organization.

up organization (org) user remove

Remove a member from the organization.

Options

`--force`

Default: false
Force removal of the member.

up profile

Manage configuration profiles.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up profile create

Create a new Upbound Profile without logging in.

Options

`--use`

Default: true
Use the new profile after it's created. Defaults to true.

`--type`

Default: cloud
Type of profile to create: cloud or disconnected.

up profile current

Get current Upbound Profile.

up profile delete

Delete an Upbound Profile.

up profile list

List Upbound Profiles.

up profile rename

Rename an Upbound Profile.

up profile set

Set Upbound Profile parameters.

up profile use

Select an Upbound Profile as the default.

up profile view

View the Upbound Profile settings across profiles.

up project

Manage Upbound development projects.

up project build

Build a project into a Crossplane package.

Options

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

`--repository`

Repository for the built package. Overrides the repository specified in the project file.

`--output-dir`

Shorthand: -o
Default: _output
Path to the output directory, where packages will be written.

`--no-build-cache`

Default: false
Don't cache image layers while building.

`--build-cache-dir`

Default: ~/.up/build-cache
Path to the build cache directory.

`--max-concurrency`

Default: 8
Maximum number of functions to build at once.

`--cache-dir`

Default: ~/.up/cache/
Directory used for caching dependencies.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up project init

Initialize a new project.

Options

`--template`

Default: project-template
The template name or URL to use to initialize the new project.

`--directory`

The directory to initialize. It must be empty. It will be created if it doesn't exist.

`--ref-name`

Default: main
The branch or tag to clone from the template repository.

`--method`

Default: https
Specify the method to access the repository: 'https' or 'ssh'.

`--ssh-key`

Optional. Specify an SSH key for authentication when initializing the new package. Used when method is 'ssh'.

`--username`

Optional. Specify a username for authentication. Used when the method is 'https' and an SSH key is not provided, or with an SSH key when the method is 'ssh'.

`--password`

Optional. Specify a password for authentication. Used with the username when the method is 'https', or with an SSH key that requires a password when the method is 'ssh'.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up project move

Update the repository for a project

Options

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to the project definition file.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up project push

Push a project's packages to the Upbound Marketplace.

Options

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

`--repository`

Repository to push to. Overrides the repository specified in the project file.

`--tag`

Shorthand: -t
Tag for the built package. If not provided, a semver tag will be generated.

`--package-file`

Package file to push. Discovered by default based on repository and tag.

`--max-concurrency`

Default: 8
Maximum number of functions to build at once.

`--public`

Create new repositories with public visibility.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up project run

Run a project on a development control plane for testing.

Options

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

`--repository`

Repository for the built package. Overrides the repository specified in the project file.

`--no-build-cache`

Default: false
Don't cache image layers while building.

`--build-cache-dir`

Default: ~/.up/build-cache
Path to the build cache directory.

`--max-concurrency`

Default: 8
Maximum number of functions to build and push at once.

`--control-plane-group`

The control plane group that the control plane to use is contained in. This defaults to the group specified in the current context.

`--control-plane-name`

Name of the control plane to use. It will be created if not found. Defaults to the project name.

`--skip-control-plane-check`

Allow running on a control plane without the development control plane annotation.

`--cache-dir`

Default: ~/.up/cache/
Directory used for caching dependencies.

`--public`

Create new repositories with public visibility.

`--timeout`

Default: 5m
Maximum time to wait for the project to become ready in the control plane. Set to zero to wait forever.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up project simulate

Run a project as a simulation against an existing control plane.

Options

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

`--repository`

Repository for the built package. Overrides the repository specified in the project file.

`--no-build-cache`

Default: false
Don't cache image layers while building.

`--build-cache-dir`

Default: ~/.up/build-cache
Path to the build cache directory.

`--max-concurrency`

Default: 8
Maximum number of functions to build and push at once.

`--name`

Shorthand: -n
The name of the simulation resource

`--tag`

An existing tag of the project to simulate. If not specified, defaults to building and pushing a new version

`--output`

Shorthand: -o
Output the results of the simulation to the provided file. Defaults to standard out if not specified

`--terminate-on-finish`

Default: true
Terminate the simulation after the completion criteria is met

`--wait`

Default: true
Wait until the simulation completes and output the difference.

`--complete-after`

Default: 60s
The amount of time the simulated control plane should run before ending the simulation

`--control-plane-group`

Shorthand: -g
The control plane group that the control plane to use is contained in. This defaults to the group specified in the current context.

`--cache-dir`

Default: ~/.up/cache/
Directory used for caching dependencies.

`--public`

Create new repositories with public visibility.

`--timeout`

Default: 5m
Maximum time to wait for the project to become ready in the control plane. Set to zero to wait forever.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up project simulation

Manage project simulations.

up project simulation complete

Force complete an in-progress project simulation

Options

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

`--output`

Shorthand: -o
Output the results of the simulation to the provided file. Defaults to standard out if not specified

`--terminate-on-finish`

Default: true
Terminate the simulation after the completion criteria is met

`--control-plane-group`

Shorthand: -g
The control plane group that the control plane to use is contained in. This defaults to the group specified in the current context.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up project simulation create

Start a new project simulation and wait for the results.

Options

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

`--repository`

Repository for the built package. Overrides the repository specified in the project file.

`--no-build-cache`

Default: false
Don't cache image layers while building.

`--build-cache-dir`

Default: ~/.up/build-cache
Path to the build cache directory.

`--max-concurrency`

Default: 8
Maximum number of functions to build and push at once.

`--name`

Shorthand: -n
The name of the simulation resource

`--tag`

An existing tag of the project to simulate. If not specified, defaults to building and pushing a new version

`--output`

Shorthand: -o
Output the results of the simulation to the provided file. Defaults to standard out if not specified

`--terminate-on-finish`

Default: true
Terminate the simulation after the completion criteria is met

`--wait`

Default: true
Wait until the simulation completes and output the difference.

`--complete-after`

Default: 60s
The amount of time the simulated control plane should run before ending the simulation

`--control-plane-group`

Shorthand: -g
The control plane group that the control plane to use is contained in. This defaults to the group specified in the current context.

`--cache-dir`

Default: ~/.up/cache/
Directory used for caching dependencies.

`--public`

Create new repositories with public visibility.

`--timeout`

Default: 5m
Maximum time to wait for the project to become ready in the control plane. Set to zero to wait forever.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up project simulation delete

Delete a control plane simulation.

Options

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

`--control-plane-group`

Shorthand: -g
The control plane group that the control plane to use is contained in. This defaults to the group specified in the current context.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up repository (repo)

Interact with repositories.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up repository (repo) create

Create a repository.

Options

`--private`

Make the new repository private.

`--publish`

Enable Upbound Marketplace listing page for the new repository.

up repository (repo) delete

Delete a repository.

Options

`--force`

Default: false
Force deletion of repository.

up repository (repo) get

Get a repository for the account.

up repository (repo) list

List repositories for the account.

up repository (repo) permission

Manage permissions of a repository for a team in the account.

up repository (repo) permission grant

Grant repository permission for a team.

up repository (repo) permission list

List all repository permissions for teams.

up repository (repo) permission revoke

Revoke repository permission from a team.

Options

`--force`

Default: false
Force the revoke of the repository permission even if conflicts exist.

up repository (repo) update

Update a repository.

Options

`--private`

The desired repository visibility. Required.

`--publish`

The desired repository publishing policy. Required.

`--force`

Default: false
Force the repository update.

up robot

Interact with robots.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up robot create

Create a robot.

Options

`--description`

Default:
Description of robot.

up robot delete

Delete a robot.

Options

`--force`

Default: false
Force delete robot even if conflicts exist.

up robot get

Get a robot for the account.

up robot list

List robots for the account.

up robot team

Interact with robot teams.

up robot team join

Add the robot to a team.

up robot team leave

Remove the robot from a team.

Options

`--force`

Default: false
Force the removal of a robot from a team even if conflicts exist.

up robot team list

List all teams the robot is a member of.

up robot token

Interact with robot tokens.

up robot token create

Create a token for the robot.

Options

`--output`

Shorthand: -o
Path to write JSON file containing access ID and token.

up robot token delete

Delete a token for the robot.

Options

`--force`

Default: false
Force delete token even if conflicts exist.

up robot token get

Get a token for the robot.

up robot token list

List the tokens for the robot.

up space

Interact with Spaces.

up space billing

up space billing export

Export a billing report for submission to Upbound.

Options

`--out`

Shorthand: -o
Default: upbound_billing_report.tgz
Name of the output file.

`--provider`

Storage provider. Must be one of: aws, gcp, azure.

`--bucket`

Storage bucket.

`--endpoint`

Custom storage endpoint.

`--account`

Name of the Upbound account whose billing report is being collected.

`--azure-storage-account`

Name of the Azure storage account. Required for --provider=azure.

`--billing-month`

Export a report for a billing period of one calendar month. Format: 2006-01.

`--billing-custom`

Export a report for a custom billing period. Date range is inclusive. Format: 2006-01-02/2006-01-02.

`--force-incomplete`

Export a report for an incomplete billing period.

up space connect (attach)

Connect an Upbound Space to the Upbound web console.

Options

`--registry-repository`

Default: xpkg.upbound.io/spaces-artifacts
Set registry for where to pull OCI artifacts from. This is an OCI registry reference, i.e. a URL without the scheme or protocol prefix.

`--registry-endpoint`

Default: https://xpkg.upbound.io
Set registry endpoint, including scheme, for authentication.

`--token-file`

File containing authentication token. Expecting a JSON file with "accessId" and "token" keys.

`--registry-username`

Set the registry username.

`--registry-password`

Set the registry password.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

`--robot-token`

The Upbound robot token contents used to authenticate the connection.

`--up-environment`

Default: prod
Override the default Upbound Environment.

up space destroy

Remove the Upbound Spaces deployment.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

`--registry-repository`

Default: xpkg.upbound.io/spaces-artifacts
Set registry for where to pull OCI artifacts from. This is an OCI registry reference, i.e. a URL without the scheme or protocol prefix.

`--registry-endpoint`

Default: https://xpkg.upbound.io
Set registry endpoint, including scheme, for authentication.

`--yes-really-delete-space-and-all-data`

Bypass safety checks and destroy Spaces

`--orphan`

Remove Space components but retain Control Planes and data

up space disconnect (detach)

Disconnect an Upbound Space from the Upbound web console.

Options

`--registry-repository`

Default: xpkg.upbound.io/spaces-artifacts
Set registry for where to pull OCI artifacts from. This is an OCI registry reference, i.e. a URL without the scheme or protocol prefix.

`--registry-endpoint`

Default: https://xpkg.upbound.io
Set registry endpoint, including scheme, for authentication.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up space init

Initialize an Upbound Spaces deployment.

Options

`--registry-repository`

Default: xpkg.upbound.io/spaces-artifacts
Set registry for where to pull OCI artifacts from. This is an OCI registry reference, i.e. a URL without the scheme or protocol prefix.

`--registry-endpoint`

Default: https://xpkg.upbound.io
Set registry endpoint, including scheme, for authentication.

`--token-file`

File containing authentication token. Expecting a JSON file with "accessId" and "token" keys.

`--registry-username`

Set the registry username.

`--registry-password`

Set the registry password.

`--set`

Set parameters.

`--file`

Shorthand: -f
Parameters file.

`--bundle`

Local bundle path.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

`--yes`

Answer yes to all questions

`--public-ingress`

For AKS,EKS,GKE expose ingress publically

up space list

List all accessible spaces in Upbound.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up space mirror

Managing the mirroring of artifacts to local storage or private container registries.

Options

`--registry-repository`

Default: xpkg.upbound.io/spaces-artifacts
Set registry for where to pull OCI artifacts from. This is an OCI registry reference, i.e. a URL without the scheme or protocol prefix.

`--registry-endpoint`

Default: https://xpkg.upbound.io
Set registry endpoint, including scheme, for authentication.

`--token-file`

File containing authentication token. Expecting a JSON file with "accessId" and "token" keys.

`--registry-username`

Set the registry username.

`--registry-password`

Set the registry password.

`--output-dir`

Shorthand: -t
The local directory path where exported artifacts will be saved as .tgz files.

`--destination-registry`

Shorthand: -d
The target container registry where the artifacts will be mirrored.

`--version`

Shorthand: -v
The specific Spaces version for which the artifacts will be mirrored.

up space upgrade

Upgrade the Upbound Spaces deployment.

Options

`--registry-repository`

Default: xpkg.upbound.io/spaces-artifacts
Set registry for where to pull OCI artifacts from. This is an OCI registry reference, i.e. a URL without the scheme or protocol prefix.

`--registry-endpoint`

Default: https://xpkg.upbound.io
Set registry endpoint, including scheme, for authentication.

`--token-file`

File containing authentication token. Expecting a JSON file with "accessId" and "token" keys.

`--registry-username`

Set the registry username.

`--registry-password`

Set the registry password.

`--set`

Set parameters.

`--file`

Shorthand: -f
Parameters file.

`--bundle`

Local bundle path.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

`--yes`

Answer yes to all questions

`--rollback`

Rollback to previously installed version on failed upgrade.

up team

Interact with teams.

Options

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up team create

Create a team.

up team delete

Delete a team.

Options

`--force`

Default: false
Force delete team even if conflicts exist.

up team get

Get a team.

up team list

List teams.

up test

Manage and run tests for projects.

up test generate

Generate a Test for a project.

Options

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

`--cache-dir`

Default: ~/.up/cache/
Directory used for caching dependency images.

`--language`

Shorthand: -l
Default: kcl
Language for test.

`--e2e`

create e2e tests

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up test run

Run project tests.

Options

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

`--repository`

Repository for the built package. Overrides the repository specified in the project file.

`--no-build-cache`

Default: false
Don't cache image layers while building.

`--build-cache-dir`

Default: ~/.up/build-cache
Path to the build cache directory.

`--max-concurrency`

Default: 8
Maximum number of functions to build and push at once.

`--control-plane-group`

The control plane group that the control plane to use is contained in. This defaults to the group specified in the current context.

`--control-plane-name-prefix`

Prefex of the control plane name to use. It will be created if not found.

`--skip-control-plane-check`

Allow running on a control plane without the development control plane annotation.

`--cache-dir`

Default: ~/.up/cache/
Directory used for caching dependencies.

`--kubectl`

Absolute path to the kubectl binary. Defaults to the one in $PATH.

`--public`

Create new repositories with public visibility.

`--e2e`

Run E2E

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up uxp

Interact with UXP.

Options

`--namespace`

Shorthand: -n
Default: upbound-system
Kubernetes namespace for UXP.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up uxp install

Install UXP.

Options

`--unstable`

Allow installing unstable versions.

`--set`

Set parameters.

`--file`

Shorthand: -f
Parameters file.

`--bundle`

Local bundle path.

up uxp uninstall

Uninstall UXP.

up uxp upgrade

Upgrade UXP.

Options

`--rollback`

Rollback to previously installed version on failed upgrade.

`--force`

Force upgrade even if versions are incompatible.

`--unstable`

Allow installing unstable versions.

`--set`

Set parameters.

`--file`

Shorthand: -f
Parameters file.

`--bundle`

Local bundle path.

up version

Show current version.

Options

`--client`

If true, shows client version only (no server required).

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up xpkg

Deprecated. Please migrate to up project or use the crossplane CLI.

up xpkg append

Append additional files to an xpkg.

Options

`--destination`

Optional OCI reference to write to. If not set, the command will modify the input reference.

`--extensions-root`

Default: ./extensions
An optional directory of arbitrary files for additional consumers of the package.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up xpkg batch

Batch build and push a family of service-scoped provider packages.

Options

`--family-base-image`

Family image used as the base for the smaller provider packages.

`--provider-name`

Provider name, such as provider-aws to be used while formatting smaller provider package repositories.

`--family-package-url-format`

Family package URL format to be used for the smaller provider packages. Must be a valid OCI image URL with the format specifier "%s", which will be substituted with <provider name>-<service name>.

`--smaller-providers`

Default: monolith
Smaller provider names to build and push, such as ec2, eks or config.

`--concurrency`

Default: 0
Maximum number of packages to process concurrently. Setting it to 0 puts no limit on the concurrency, i.e., all packages are processed in parallel.

`--push-retry`

Default: 3
Number of retries when pushing a provider package fails.

`--platform`

Default: linux_amd64,linux_arm64
Platforms to build the packages for. Each platform should use the <OS>_<arch> syntax. An example is: linux_arm64.

`--provider-bin-root`

Shorthand: -p
Provider binary paths root. Smaller provider binaries should reside under the platform directories in this folder.

`--output-dir`

Shorthand: -o
Path of the package output directory.

`--store-packages`

Smaller provider names whose provider package should be stored under the package output directory specified with the --output-dir option.

`--package-metadata-template`

Default: ./package/crossplane.yaml.tmpl
Smaller provider metadata template. The template variables {{ .Service }} and {{ .Name }} will be substituted when the template is executed among with the supplied template variable substitutions.

`--template-var`

Smaller provider metadata template variables to be used for the specified template.

`--examples-group-override`

Overrides for the location of the example manifests folder of a smaller provider.

`--crd-group-override`

Overrides for the locations of the CRD folders of the smaller providers.

`--package-repo-override`

Overrides for the package repository names of the smaller providers.

`--providers-with-auth-ext`

Default: monolith,config
Smaller provider names for which we need to configure the authentication extension.

`--examples-root`

Shorthand: -e
Default: ./examples
Path to package examples directory.

`--crd-root`

Default: ./package/crds
Path to package CRDs directory.

`--auth-ext`

Default: ./package/auth.yaml
Path to an authentication extension file.

`--ignore`

Paths to exclude from the smaller provider packages.

`--create`

Create repository on push if it does not exist.

`--build-only`

Default: false
Only build the smaller provider packages and do not attempt to push them to a package repository.

`--provider-name-suffix-for-push`

Suffix for provider name during pushing the packages. This suffix is added to the end of the provider name. If there is a service name for the corresponded provider, then the suffix will be added to the base provider name and the service-scoped name will be after this suffix. Examples: provider-family-aws-suffix, provider-aws-suffix-s3

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up xpkg build

Build a package, by default from the current directory.

Options

`--name`

[DEPRECATED: use --output] Name of the package to be built. Uses name in crossplane.yaml if not specified. Does not correspond to package tag.

`--output`

Shorthand: -o
Path for package output.

`--controller`

Controller image used as base for package.

`--package-root`

Shorthand: -f
Default: .
Path to package directory.

`--examples-root`

Shorthand: -e
Default: ./examples
Path to package examples directory.

`--helm-root`

Shorthand: -h
Default: ./helm
Path to helm directory.

`--auth-ext`

Shorthand: -a
Default: auth.yaml
Path to an authentication extension file.

`--ignore`

Paths, specified relative to --package-root, to exclude from the package.

up xpkg push

Push a package.

Options

`--package`

Shorthand: -f
Path to packages. If not specified and only one package exists in current directory it will be used.

`--create`

Create repository on push if it does not exist.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up xpkg xp-extract

Extract package contents into a Crossplane cache compatible format. Fetches from a remote registry by default.

Options

`--from-daemon`

Indicates that the image should be fetched from the Docker daemon.

`--from-xpkg`

Indicates that the image should be fetched from a local xpkg. If package is not specified and only one exists in current directory it will be used.

`--output`

Shorthand: -o
Default: out.gz
Package output file path. Extension must be .gz or will be replaced.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up xpls

Start xpls language server.

up xpls serve

run a server for Crossplane definitions using the Language Server Protocol.

Options

`--cache`

Default: ~/.up/cache
Directory path for dependency schema cache.

`--verbose`

Run server with verbose logging.

up xrd

Manage XRDs from Composite Resources(XR) or Claims(XRC).

up xrd generate

Generate an XRD from a Composite Resource (XR) or Claim (XRC).

Options

`--cache-dir`

Default: ~/.up/cache/
Directory used for caching dependency images.

`--path`

Path to the output file where the Composite Resource Definition (XRD) will be saved.

`--plural`

Optional custom plural form for the Composite Resource Definition (XRD).

`--output`

Shorthand: -o
Default: file
Output format for the results: 'file' to save to a file, 'yaml' to print XRD in YAML format, 'json' to print XRD in JSON format.

`--project-file`

Shorthand: -f
Default: upbound.yaml
Path to project definition file.

`--domain`

Root Upbound domain. Overrides the current profile's domain.

`--profile`

Profile used to execute command.

`--account`

Shorthand: -a
Deprecated. Use organization instead.

`--organization`

Organization used to execute command. Overrides the current profile's organization.

`--insecure-skip-tls-verify`

[INSECURE] Skip verifying TLS certificates.

`--debug`

Shorthand: -d
[INSECURE] Run with debug logging. Repeat to increase verbosity. Output might contain confidential data like tokens.

`--override-api-endpoint`

Overrides the default API endpoint.

`--override-auth-endpoint`

Overrides the default auth endpoint.

`--override-proxy-endpoint`

Overrides the default proxy endpoint.

`--override-registry-endpoint`

Overrides the default registry endpoint.

`--override-accounts-endpoint`

Overrides the default accounts endpoint.

`--kubeconfig`

Override default kubeconfig path.

`--kubecontext`

Override default kubeconfig context.

up​

Options​

--help​

--format​

--quiet​

--pretty​

--dry-run​

up alpha​

up alpha ctx​

Options​

--domain​

--profile​

--account​

--organization​

--insecure-skip-tls-verify​

--debug​

--override-api-endpoint​

--override-auth-endpoint​

--override-proxy-endpoint​

--override-registry-endpoint​

--override-accounts-endpoint​

--kubeconfig​

--kubecontext​

--short​

--context​

--file​

up alpha migration​

Options​

--kubeconfig​

up alpha migration export​

Options​

--yes​

--output​

--include-extra-resources​

--exclude-resources​

--include-namespaces​

--exclude-namespaces​

--pause-before-export​

up alpha migration import​

Options​

--yes​

--input​

--unpause-after-import​

--mcp-connector-cluster-id​

--mcp-connector-claim-namespace​

--skip-target-check​

up alpha migration pause-toggle​

Options​

--pause​

--yes​

up alpha space​

up alpha space billing​

up alpha space billing export​

Options​

--out​

--provider​

--bucket​

--endpoint​

--account​

--azure-storage-account​

--billing-month​

--billing-custom​

--force-incomplete​

up alpha space connect (attach)​

Options​

--registry-repository​

--registry-endpoint​

--token-file​

--registry-username​

--registry-password​

--domain​

--profile​

--account​

--organization​

--insecure-skip-tls-verify​

--debug​

--override-api-endpoint​

--override-auth-endpoint​

--override-proxy-endpoint​

--override-registry-endpoint​

up

Options

`--help`

`--format`

`--quiet`

`--pretty`

`--dry-run`

up alpha

up alpha ctx

Options

`--domain`

`--profile`

`--account`

`--organization`

`--insecure-skip-tls-verify`

`--debug`

`--override-api-endpoint`

`--override-auth-endpoint`

`--override-proxy-endpoint`

`--override-registry-endpoint`

`--override-accounts-endpoint`

`--kubeconfig`

`--kubecontext`

`--short`

`--context`

`--file`

up alpha migration

Options

`--kubeconfig`

up alpha migration export

Options

`--yes`

`--output`

`--include-extra-resources`

`--exclude-resources`

`--include-namespaces`

`--exclude-namespaces`

`--pause-before-export`

up alpha migration import

Options

`--yes`

`--input`

`--unpause-after-import`

`--mcp-connector-cluster-id`

`--mcp-connector-claim-namespace`

`--skip-target-check`

up alpha migration pause-toggle

Options

`--pause`

`--yes`

up alpha space

up alpha space billing

up alpha space billing export

Options

`--out`

`--provider`

`--bucket`

`--endpoint`

`--account`

`--azure-storage-account`

`--billing-month`

`--billing-custom`

`--force-incomplete`

up alpha space connect (attach)

Options

`--registry-repository`

`--registry-endpoint`

`--token-file`

`--registry-username`

`--registry-password`

`--domain`

`--profile`

`--account`

`--organization`

`--insecure-skip-tls-verify`

`--debug`

`--override-api-endpoint`

`--override-auth-endpoint`

`--override-proxy-endpoint`

`--override-registry-endpoint`