CLI Reference

up

The Upbound CLI.

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

Usage

up [flags] [subcommand]

Flags

--help / -h

Show context-sensitive help.

--format

Default: default

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

--quiet / -q

Suppress all output.

--pretty

Pretty print output.

--dry-run

dry-run output.

Subcommands

• organization (org) - Interact with Upbound organizations.
• token - Interact with personal access tokens.
• team - Interact with teams.
• robot - Interact with robots.
• repository (repo) - Interact with repositories.
• space - Interact with Spaces.
• group - Interact with groups inside Spaces.
• controlplane (ctp) - Interact with control planes in the current context, both in the cloud and in a local Space.
• uxp - Interact with UXP.
• project - Manage Upbound development projects.
• example - Manage Claim(XRC) or Composite Resource(XR).
• dependency (dep) - Manage configuration dependencies.
• xrd - Manage XRDs from Composite Resources(XR) or Claims(XRC).
• composition - Manage Compositions.
• function - Manage Functions.
• test - Manage and run tests for projects.
• xpkg - Deprecated. Please migrate to up project or use the crossplane CLI.
• xpls - Start xpls language server.
• completion - Generate shell autocompletions
• ctx - Select an Upbound kubeconfig context.
• help - Show help.
• license - Show license information.
• profile - Manage configuration profiles.
• login - Login to Upbound. Will attempt to launch a web browser by default. Use --username and --password flags for automations.
• logout - Logout of Upbound.
• version - Show current version.
• alpha - Alpha features. Commands may be removed in future releases.

Examples

# Show help
up --help

# Show version
up version

up alpha

Alpha features. Commands may be removed in future releases.

Usage

up alpha [subcommand]

Subcommands

• migration - Migrate control planes to Upbound Managed Control Planes.
• space - Interact with Spaces.
• ctx - Select an Upbound kubeconfig context.

Examples

# Show help
up alpha --help

up alpha ctx

Select an Upbound kubeconfig context.

Usage

up alpha ctx [argument] [flags]

Arguments

<argument>

Optional

.. to move to the parent, '-' for the previous context, '.' for the current context, or any relative path.

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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 / -s

Short output.

--context

Default: upbound

Kubernetes context to operate on.

--file / -f

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

Examples

# Show help
up alpha ctx --help

# Basic usage
up alpha ctx <argument>

up alpha migration

Migrate control planes to Upbound Managed Control Planes.

Usage

up alpha migration [flags] [subcommand]

Flags

--kubeconfig

Override default kubeconfig path.

Subcommands

• 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.
• import - The 'import' command imports a control plane state from an archive file into an Upbound managed control plane.
• 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.

Examples

# Show help
up alpha migration --help

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.

Usage

up alpha migration export [flags]

Flags

--yes

Default: false

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

--output / -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.

Examples

# Show help
up alpha migration export --help

up alpha migration import

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

Usage

up alpha migration import [flags]

Flags

--yes

Default: false

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

--input / -i

Default: xp-state.tar.gz

Specifies the file path or directory 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.

Examples

# Show help
up alpha migration import --help

# Import with default settings
up import

# Import from specific file
up import --input my-state.tar.gz

# Import and automatically unpause resources
up import --input state.tar.gz --unpause-after-import

# Import with automatic confirmation
up import --yes --input state.tar.gz

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.

Usage

up alpha migration pause-toggle [flags]

Flags

--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.

Examples

# Show help
up alpha migration pause-toggle --help

up alpha space

Interact with Spaces.

Usage

up alpha space [subcommand]

Subcommands

• connect (attach) - Connect an Upbound Space to the Upbound web console.
• disconnect (detach) - Disconnect an Upbound Space from the Upbound web console.
• destroy - Remove the Upbound Spaces deployment.
• init - Initialize an Upbound Spaces deployment.
• list - List all accessible spaces in Upbound.
• mirror - Managing the mirroring of artifacts to local storage or private container registries.
• upgrade - Upgrade the Upbound Spaces deployment.
• billing

Examples

# Show help
up alpha space --help

up alpha space billing

Usage

up alpha space billing [subcommand]

Subcommands

• export - Export a billing report for submission to Upbound.

Examples

# Show help
up alpha space billing --help

up alpha space billing export

Export a billing report for submission to Upbound.

Usage

up alpha space billing export [flags]

Flags

--out / -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.

Examples

# Show help
up alpha space billing export --help

up alpha space connect (attach)

Connect an Upbound Space to the Upbound web console.

Usage

up alpha space connect (attach) [space] [flags]

Arguments

<space>

Optional

Name of the Upbound Space. If name is not a supplied, one is generated.

Flags

--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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up alpha space connect --help

# Basic usage
up alpha space connect <space>

up alpha space destroy

Remove the Upbound Spaces deployment.

Usage

up alpha space destroy [flags]

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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

Examples

# Show help
up alpha space destroy --help

up alpha space disconnect (detach)

Disconnect an Upbound Space from the Upbound web console.

Usage

up alpha space disconnect (detach) [space] [flags]

Arguments

<space>

Optional

Name of the Upbound Space. If name is not a supplied, it will be determined from the connection info in the space.

Flags

--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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up alpha space disconnect --help

# Basic usage
up alpha space disconnect <space>

up alpha space init

Initialize an Upbound Spaces deployment.

Usage

up alpha space init <version> [flags]

Arguments

<version>

Required

Upbound Spaces version to install.

Flags

--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 / -f

Parameters file.

--bundle

Local bundle path.

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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

Examples

# Show help
up alpha space init --help

# Basic usage
up alpha space init <version>

up alpha space list

List all accessible spaces in Upbound.

Usage

up alpha space list [flags]

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up alpha space list --help

up alpha space mirror

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

Usage

up alpha space mirror [flags]

Flags

--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 / -t

The local directory path where exported artifacts will be saved as .tgz files.

--destination-registry / -d

The target container registry where the artifacts will be mirrored.

--version / -v

The specific Spaces version for which the artifacts will be mirrored.

Examples

# Show help
up alpha space mirror --help

up alpha space upgrade

Upgrade the Upbound Spaces deployment.

Usage

up alpha space upgrade <version> [flags]

Arguments

<version>

Required

Upbound Spaces version to upgrade to.

Flags

--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 / -f

Parameters file.

--bundle

Local bundle path.

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up alpha space upgrade --help

# Basic usage
up alpha space upgrade <version>

up completion

Generate shell autocompletions

Usage

up completion [flags]

Flags

--uninstall

Examples

# Show help
up completion --help

up composition

Manage Compositions.

Usage

up composition [subcommand]

Subcommands

• generate - Generate an Composition.
• render - Run a composition locally to render an XR into composed resources.

Examples

# Show help
up composition --help

up composition generate

Generate an Composition.

Usage

up composition generate <resource> [flags]

Arguments

<resource>

Required

File path to Composite Resource Claim (XRC) or Composite Resource (XR) or CompositeResourceDefinition (XRD).

Flags

--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 / -f

Default: upbound.yaml

Path to project definition file.

--output / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up composition generate --help

# Basic usage
up composition generate <resource>

up composition render

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

Usage

up composition render <composition> <composite-resource> [flags]

Arguments

<composition>

Required

A YAML file specifying the Composition to use to render the Composite Resource (XR).

<composite-resource>

Required

A YAML file specifying the Composite Resource (XR) to render.

Flags

--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 / -r

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

--include-full-xr / -x

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

--observed-resources / -o

A YAML file or directory of YAML files specifying the observed state of composed resources.

--extra-resources / -e

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

--include-context / -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 / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up composition render --help

# Basic usage
up composition render <composition> <composite-resource>

up controlplane (ctp)

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

Usage

up controlplane (ctp) [flags] [subcommand]

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Subcommands

• create - Create a control plane.
• delete - Delete a control plane.
• list - List control planes for the organization.
• get - Get a single control plane.
• connector - Connect an App Cluster to a control plane.
• simulation (sim) - Manage control plane simulations.
• simulate - Alias for 'up controlplane simulation create'.
• configuration - Manage Configurations.
• provider - Manage Providers.
• function - Manage Functions.
• pull-secret - Manage package pull secrets.
• connect - Deprecated: Connect kubectl to control plane.
• disconnect - Deprecated: Disconnect kubectl from control plane.

Examples

# Show help
up controlplane --help

up controlplane (ctp) configuration

Manage Configurations.

Usage

up controlplane (ctp) configuration [subcommand]

Subcommands

• install - Install a Configuration.

Examples

# Show help
up controlplane configuration --help

up controlplane (ctp) configuration install

Install a Configuration.

Usage

up controlplane (ctp) configuration install <package> [flags]

Arguments

<package>

Required

Reference to the Configuration.

Flags

--name

Name of Configuration.

--package-pull-secrets

List of secrets used to pull Configuration.

--wait / -w

Wait duration for successful Configuration installation.

Examples

# Show help
up controlplane configuration install --help

# Basic usage
up controlplane configuration install <package>

up controlplane (ctp) connect

Deprecated: Connect kubectl to control plane.

Usage

up controlplane (ctp) connect <name> [flags]

Arguments

<name>

Required

Name of control plane.

Flags

--token

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

--group / -g

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

Examples

# Show help
up controlplane connect --help

# Basic usage
up controlplane connect my-project

up controlplane (ctp) connector

Connect an App Cluster to a control plane.

Usage

up controlplane (ctp) connector [subcommand]

Subcommands

• install - Install mcp-connector into an App Cluster.
• uninstall - Uninstall mcp-connector from an App Cluster.

Examples

# Show help
up controlplane connector --help

up controlplane (ctp) connector install

Install mcp-connector into an App Cluster.

Usage

up controlplane (ctp) connector install <name> <namespace> [flags]

Arguments

<name>

Required

Name of control plane.

<namespace>

Required

Namespace in the control plane where the claims of the cluster will be stored.

Flags

--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 / -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 / -f

Parameters file.

--bundle

Local bundle path.

Examples

# Show help
up controlplane connector install --help

# Basic usage
up controlplane connector install my-project <namespace>

up controlplane (ctp) connector uninstall

Uninstall mcp-connector from an App Cluster.

Usage

up controlplane (ctp) connector uninstall <namespace> [flags]

Arguments

<namespace>

Required

Namespace in the control plane where the claims of the cluster will be stored.

Flags

--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 / -n

Default: kube-system

Kubernetes namespace for MCP Connector. Default is kube-system.

Examples

# Show help
up controlplane connector uninstall --help

# Basic usage
up controlplane connector uninstall <namespace>

up controlplane (ctp) create

Create a control plane.

Usage

up controlplane (ctp) create <name> [flags]

Arguments

<name>

Required

Name of control plane.

Flags

--group / -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.

Examples

# Show help
up controlplane create --help

# Basic usage
up controlplane create my-project

up controlplane (ctp) delete

Delete a control plane.

Usage

up controlplane (ctp) delete <name> [flags]

Arguments

<name>

Required

Name of control plane.

Flags

--group / -g

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

Examples

# Show help
up controlplane delete --help

# Basic usage
up controlplane delete my-project

up controlplane (ctp) disconnect

Deprecated: Disconnect kubectl from control plane.

Usage

up controlplane (ctp) disconnect

Examples

# Show help
up controlplane disconnect --help

up controlplane (ctp) function

Manage Functions.

Usage

up controlplane (ctp) function [subcommand]

Subcommands

• install - Install a Function.

Examples

# Show help
up controlplane function --help

up controlplane (ctp) function install

Install a Function.

Usage

up controlplane (ctp) function install <package> [flags]

Arguments

<package>

Required

Reference to the Function.

Flags

--name

Name of Function.

--package-pull-secrets

List of secrets used to pull Function.

--wait / -w

Wait duration for successful Function installation.

Examples

# Show help
up controlplane function install --help

# Basic usage
up controlplane function install <package>

up controlplane (ctp) get

Get a single control plane.

Usage

up controlplane (ctp) get <name> [flags]

Arguments

<name>

Required

Name of control plane.

Flags

--group / -g

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

Examples

# Show help
up controlplane get --help

# Basic usage
up controlplane get my-project

up controlplane (ctp) list

List control planes for the organization.

Usage

up controlplane (ctp) list [flags]

Flags

--all-groups / -A

Default: false

List control planes across all groups.

--group / -g

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

Examples

# Show help
up controlplane list --help

up controlplane (ctp) provider

Manage Providers.

Usage

up controlplane (ctp) provider [subcommand]

Subcommands

• install - Install a Provider.

Examples

# Show help
up controlplane provider --help

up controlplane (ctp) provider install

Install a Provider.

Usage

up controlplane (ctp) provider install <package> [flags]

Arguments

<package>

Required

Reference to the Provider.

Flags

--name

Name of Provider.

--package-pull-secrets

List of secrets used to pull Provider.

--wait / -w

Wait duration for successful Provider installation.

Examples

# Show help
up controlplane provider install --help

# Basic usage
up controlplane provider install <package>

up controlplane (ctp) pull-secret

Manage package pull secrets.

Usage

up controlplane (ctp) pull-secret [subcommand]

Subcommands

• create - Create a package pull secret.

Examples

# Show help
up controlplane pull-secret --help

up controlplane (ctp) pull-secret create

Create a package pull secret.

Usage

up controlplane (ctp) pull-secret create <name> [flags]

Arguments

<name>

Required

Name of the pull secret.

Flags

--file / -f

Path to credentials file. Credentials from profile are used if not specified.

--namespace / -n

Default: crossplane-system

Kubernetes namespace for pull secret.

Examples

# Show help
up controlplane pull-secret create --help

# Basic usage
up controlplane pull-secret create my-project

up controlplane (ctp) simulate

Alias for 'up controlplane simulation create'.

Usage

up controlplane (ctp) simulate <source-name> [flags]

Arguments

<source-name>

Required

Name of source control plane.

Flags

--group / -g

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

--simulation-name / -n

The name of the simulation resource

--changeset / -f

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

--recursive / -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 / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up controlplane simulate --help

# Basic usage
up controlplane simulate <source-name>

up controlplane (ctp) simulation (sim)

Manage control plane simulations.

Usage

up controlplane (ctp) simulation (sim) [flags] [subcommand]

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Subcommands

• create - Start a new control plane simulation and wait for the results.
• delete - Delete a control plane simulation.
• list - List control plane simulations for the account.

Examples

# Show help
up controlplane simulation --help

up controlplane (ctp) simulation (sim) create

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

Usage

up controlplane (ctp) simulation (sim) create <source-name> [flags]

Arguments

<source-name>

Required

Name of source control plane.

Flags

--group / -g

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

--simulation-name / -n

The name of the simulation resource

--changeset / -f

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

--recursive / -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 / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up controlplane simulation create --help

# Basic usage
up controlplane simulation create <source-name>

up controlplane (ctp) simulation (sim) delete

Delete a control plane simulation.

Usage

up controlplane (ctp) simulation (sim) delete <name> [flags]

Arguments

<name>

Required

Name of the simulation.

Flags

--group / -g

The group that the simulation is contained in. This defaults to the group specified in the current context

Examples

# Show help
up controlplane simulation delete --help

# Basic usage
up controlplane simulation delete my-project

up controlplane (ctp) simulation (sim) list

List control plane simulations for the account.

Usage

up controlplane (ctp) simulation (sim) list [flags]

Flags

--all-groups / -A

Default: false

List simulations across all groups.

--group / -g

The group that the simulation is contained in. This defaults to the group specified in the current context

Examples

# Show help
up controlplane simulation list --help

up ctx

Select an Upbound kubeconfig context.

Usage

up ctx [argument] [flags]

Arguments

<argument>

Optional

.. to move to the parent, '-' for the previous context, '.' for the current context, or any relative path.

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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 / -s

Short output.

--context

Default: upbound

Kubernetes context to operate on.

--file / -f

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

Examples

# Show help
up ctx --help

# Basic usage
up ctx <argument>

up dependency (dep)

Manage configuration dependencies.

Usage

up dependency (dep) [flags] [subcommand]

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Subcommands

• add - Add a dependency to the current project.
• update-cache - Update the dependency cache for the current project.
• clean-cache - Clean the dependency cache.

Examples

# Show help
up dependency --help

up dependency (dep) add

Add a dependency to the current project.

Usage

up dependency (dep) add <package> [flags]

Arguments

<package>

Required

Package to be added.

Flags

--project-file / -f

Default: upbound.yaml

Path to project definition file.

--cache-dir

Default: ~/.up/cache/

Directory used for caching package images.

Examples

# Show help
up dependency add --help

# Basic usage
up dependency add <package>

up dependency (dep) clean-cache

Clean the dependency cache.

Usage

up dependency (dep) clean-cache [flags]

Flags

--cache-dir

Default: ~/.up/cache/

Directory used for caching package images.

Examples

# Show help
up dependency clean-cache --help

up dependency (dep) update-cache

Update the dependency cache for the current project.

Usage

up dependency (dep) update-cache [flags]

Flags

--project-file / -f

Default: upbound.yaml

Path to project definition file.

--cache-dir

Default: ~/.up/cache/

Directory used for caching package images.

Examples

# Show help
up dependency update-cache --help

up example

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

Usage

up example [subcommand]

Subcommands

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

Examples

# Show help
up example --help

up example generate

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

Usage

up example generate [xrd-file-path] [flags]

Arguments

<xrd-file-path>

Optional

Specifies the path to the Composite Resource Definition (XRD) file used to generate an example resource.

Flags

--path

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

--output / -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 / -f

Default: upbound.yaml

Path to project definition file.

Examples

# Show help
up example generate --help

# Basic usage
up example generate <xrd-file-path>

up function

Manage Functions.

Usage

up function [subcommand]

Subcommands

• generate - Generate an Function for a Composition.

Examples

# Show help
up function --help

up function generate

Generate an Function for a Composition.

Usage

up function generate <name> [composition-path] [flags]

Arguments

<name>

Required

Name for the new Function.

<composition-path>

Optional

Path to Crossplane Composition file.

Flags

--project-file / -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 / -l

Default: kcl

Language for function.

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up function generate --help

# Basic usage
up function generate my-project <composition-path>

up group

Interact with groups inside Spaces.

Usage

up group [flags] [subcommand]

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Subcommands

• create - Create a group.
• delete - Delete a group.
• list - List groups in the space.
• get - Get a group.

Examples

# Show help
up group --help

up group create

Create a group.

Usage

up group create <name>

Arguments

<name>

Required

Name of group.

Examples

# Show help
up group create --help

# Basic usage
up group create my-project

up group delete

Delete a group.

Usage

up group delete <name> [flags]

Arguments

<name>

Required

Name of group.

Flags

--force

Default: false

Force the deletion of the group.

Examples

# Show help
up group delete --help

# Basic usage
up group delete my-project

up group get

Get a group.

Usage

up group get <name>

Arguments

<name>

Required

Name of group.

Examples

# Show help
up group get --help

# Basic usage
up group get my-project

up group list

List groups in the space.

Usage

up group list

Examples

# Show help
up group list --help

up help

Show help.

Usage

up help

Examples

# Show help
up help --help

up license

Show license information.

Usage

up license

Examples

# Show help
up license --help

up login

Login to Upbound. Will attempt to launch a web browser by default. Use --username and --password flags for automations.

Usage

up login [flags]

Flags

--username / -u

Username used to execute command.

--password / -p

Password for specified user. '-' to read from stdin.

--token / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

--use-device-code

Use authentication flow based on device code. We will also use this if it can't launch a browser in your behalf, e.g. in remote SSH

Examples

# Show help
up login --help

up logout

Logout of Upbound.

Usage

up logout [flags]

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up logout --help

up organization (org)

Interact with Upbound organizations.

Usage

up organization (org) [flags] [subcommand]

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Subcommands

• create - Create an organization.
• delete - Delete an organization.
• list - List organizations.
• get - Get an organization.
• user - Manage organization users.
• token - Generates an organization-scoped token to authenticate with a Cloud space.

Examples

# Show help
up organization --help

up organization (org) create

Create an organization.

Usage

up organization (org) create <name>

Arguments

<name>

Required

Name of organization.

Examples

# Show help
up organization create --help

# Basic usage
up organization create my-project

up organization (org) delete

Delete an organization.

Usage

up organization (org) delete <name> [flags]

Arguments

<name>

Required

Name of organization.

Flags

--force

Default: false

Force deletion of the organization.

Examples

# Show help
up organization delete --help

# Basic usage
up organization delete my-project

up organization (org) get

Get an organization.

Usage

up organization (org) get <name>

Arguments

<name>

Required

Name of organization.

Examples

# Show help
up organization get --help

# Basic usage
up organization get my-project

up organization (org) list

List organizations.

Usage

up organization (org) list

Examples

# Show help
up organization list --help

up organization (org) token

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

Usage

up organization (org) token <name> [flags]

Arguments

<name>

Required

Name of organization.

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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 / -t

Token used to execute command. Overrides the token present in the profile.

Examples

# Show help
up organization token --help

# Basic usage
up organization token my-project

up organization (org) user

Manage organization users.

Usage

up organization (org) user [subcommand]

Subcommands

• list - List users of an organization.
• invite - Invite a user to the organization.
• remove - Remove a member from the organization.

Examples

# Show help
up organization user --help

up organization (org) user invite

Invite a user to the organization.

Usage

up organization (org) user invite <org-name> <email> [flags]

Arguments

<org-name>

Required

Name of the organization.

<email>

Required

Email address of the user to invite.

Flags

--permission / -p

Default: member

Role of the user to invite (owner or member).

Examples

# Show help
up organization user invite --help

# Basic usage
up organization user invite <org-name> <email>

up organization (org) user list

List users of an organization.

Usage

up organization (org) user list <org-name>

Arguments

<org-name>

Required

Name of the organization.

Examples

# Show help
up organization user list --help

# Basic usage
up organization user list <org-name>

up organization (org) user remove

Remove a member from the organization.

Usage

up organization (org) user remove <org-name> <user> [flags]

Arguments

<org-name>

Required

Name of the organization.

<user>

Required

Username or email of the user to remove.

Flags

--force

Default: false

Force removal of the member.

Examples

# Show help
up organization user remove --help

# Basic usage
up organization user remove <org-name> <user>

up profile

Manage configuration profiles.

Usage

up profile [flags] [subcommand]

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Subcommands

• current - Get current Upbound Profile.
• list - List Upbound Profiles.
• use - Select an Upbound Profile as the default.
• view - View the Upbound Profile settings across profiles.
• set - Set Upbound Profile parameters.
• create - Create a new Upbound Profile without logging in.
• delete - Delete an Upbound Profile.
• rename - Rename an Upbound Profile.

Examples

# Show help
up profile --help

up profile create

Create a new Upbound Profile without logging in.

Usage

up profile create <name> [flags]

Arguments

<name>

Required

Name of the profile to create.

Flags

--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.

Examples

# Show help
up profile create --help

# Basic usage
up profile create my-project

up profile current

Get current Upbound Profile.

Usage

up profile current

Examples

# Show help
up profile current --help

up profile delete

Delete an Upbound Profile.

Usage

up profile delete <name>

Arguments

<name>

Required

Name of the profile to delete.

Examples

# Show help
up profile delete --help

# Basic usage
up profile delete my-project

up profile list

List Upbound Profiles.

Usage

up profile list

Examples

# Show help
up profile list --help

up profile rename

Rename an Upbound Profile.

Usage

up profile rename <from> <to>

Arguments

<from>

Required

Name of the profile to rename.

<to>

Required

New name for the profile.

Examples

# Show help
up profile rename --help

# Basic usage
up profile rename <from> <to>

up profile set

Set Upbound Profile parameters.

Usage

up profile set <key> <value>

Arguments

<key>

Required

The configuration key to set.

<value>

Required

The configuration value to set.

Examples

# Show help
up profile set --help

# Basic usage
up profile set <key> <value>

up profile use

Select an Upbound Profile as the default.

Usage

up profile use <name>

Arguments

<name>

Required

Name of the Profile to use.

Examples

# Show help
up profile use --help

# Basic usage
up profile use my-project

up profile view

View the Upbound Profile settings across profiles.

Usage

up profile view

Examples

# Show help
up profile view --help

up project

Manage Upbound development projects.

Usage

up project [subcommand]

Subcommands

• init - Initialize a new project.
• build - Build a project into a Crossplane package.
• push - Push a project's packages to the Upbound Marketplace.
• run - Run a project on a development control plane for testing.
• move - Update the repository for a project
• simulate - Run a project as a simulation against an existing control plane.
• simulation - Manage project simulations.

Examples

# Show help
up project --help

up project build

Build a project into a Crossplane package.

Usage

up project build [flags]

Flags

--project-file / -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 / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up project build --help

up project init

Initialize a new project.

Usage

up project init <name> [flags]

Arguments

<name>

Required

The name of the new project to initialize.

Flags

--directory

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

--scratch

Default: false

Create a new project from scratch.

--example / -e

The example to use to initialize the new project.

--values

Values to use for templating the project.

--state-file

Default: .up_wizard_state.json

Path to wizard state file.

--language / -l

The language to use to initialize the new project.

--test-language

The language to use for tests in the new project.

--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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up project init --help

# Basic usage
up project init my-project

up project move

Update the repository for a project

Usage

up project move <new-repository> [flags]

Arguments

<new-repository>

Required

The new repository for the project.

Flags

--project-file / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up project move --help

# Basic usage
up project move <new-repository>

up project push

Push a project's packages to the Upbound Marketplace.

Usage

up project push [flags]

Flags

--project-file / -f

Default: upbound.yaml

Path to project definition file.

--repository

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

--tag / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up project push --help

up project run

Run a project on a development control plane for testing.

Usage

up project run [flags]

Flags

--project-file / -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 non-development control plane.

--local

Use a local dev control plane, even if Spaces is available.

--no-update-kubeconfig

Do not update kubeconfig to use the dev control plane as its current context.

--use-current-context

Run the project with the current kubeconfig context rather than creating a new dev control plane.

--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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up project run --help

up project simulate

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

Usage

up project simulate <source-control-plane-name> [flags]

Arguments

<source-control-plane-name>

Required

Name of the source control plane

Flags

--project-file / -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 / -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 / -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 / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up project simulate --help

# Basic usage
up project simulate <source-control-plane-name>

up project simulation

Manage project simulations.

Usage

up project simulation [subcommand]

Subcommands

• create - Start a new project simulation and wait for the results.
• complete - Force complete an in-progress project simulation
• delete - Delete a control plane simulation.

Examples

# Show help
up project simulation --help

up project simulation complete

Force complete an in-progress project simulation

Usage

up project simulation complete <name> [flags]

Arguments

<name>

Required

The name of the simulation resource

Flags

--project-file / -f

Default: upbound.yaml

Path to project definition file.

--output / -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 / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up project simulation complete --help

# Basic usage
up project simulation complete my-project

up project simulation create

Start a new project simulation and wait for the results.

Usage

up project simulation create <source-control-plane-name> [flags]

Arguments

<source-control-plane-name>

Required

Name of the source control plane

Flags

--project-file / -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 / -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 / -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 / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up project simulation create --help

# Basic usage
up project simulation create <source-control-plane-name>

up project simulation delete

Delete a control plane simulation.

Usage

up project simulation delete <name> [flags]

Arguments

<name>

Required

The name of the simulation resource

Flags

--project-file / -f

Default: upbound.yaml

Path to project definition file.

--control-plane-group / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up project simulation delete --help

# Basic usage
up project simulation delete my-project

up repository (repo)

Interact with repositories.

Usage

up repository (repo) [flags] [subcommand]

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Subcommands

• create - Create a repository.
• update - Update a repository.
• delete - Delete a repository.
• list - List repositories for the account.
• get - Get a repository for the account.
• permission - Manage permissions of a repository for a team in the account.

Examples

# Show help
up repository --help

up repository (repo) create

Create a repository.

Usage

up repository (repo) create <name> [flags]

Arguments

<name>

Required

Name of repository.

Flags

--private

Make the new repository private.

--publish

Enable Upbound Marketplace listing page for the new repository.

Examples

# Show help
up repository create --help

# Basic usage
up repository create my-project

up repository (repo) delete

Delete a repository.

Usage

up repository (repo) delete <name> [flags]

Arguments

<name>

Required

Name of repository.

Flags

--force

Default: false

Force deletion of repository.

Examples

# Show help
up repository delete --help

# Basic usage
up repository delete my-project

up repository (repo) get

Get a repository for the account.

Usage

up repository (repo) get <name>

Arguments

<name>

Required

Name of repo.

Examples

# Show help
up repository get --help

# Basic usage
up repository get my-project

up repository (repo) list

List repositories for the account.

Usage

up repository (repo) list

Examples

# Show help
up repository list --help

up repository (repo) permission

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

Usage

up repository (repo) permission [subcommand]

Subcommands

• grant - Grant repository permission for a team.
• revoke - Revoke repository permission from a team.
• list - List all repository permissions for teams.

Examples

# Show help
up repository permission --help

up repository (repo) permission grant

Grant repository permission for a team.

Usage

up repository (repo) permission grant <team-name> <repository-name> <permission>

Arguments

<team-name>

Required

Name of team.

<repository-name>

Required

Name of repository.

<permission>

Required

Permission type (admin, read, write, view).

Examples

# Show help
up repository permission grant --help

# Basic usage
up repository permission grant <team-name> <repository-name> <permission>

up repository (repo) permission list

List all repository permissions for teams.

Usage

up repository (repo) permission list <team-name>

Arguments

<team-name>

Required

Name of the team.

Examples

# Show help
up repository permission list --help

# Basic usage
up repository permission list <team-name>

up repository (repo) permission revoke

Revoke repository permission from a team.

Usage

up repository (repo) permission revoke <team-name> <repository-name> [flags]

Arguments

<team-name>

Required

Name of team.

<repository-name>

Required

Name of repository.

Flags

--force

Default: false

Force the revoke of the repository permission even if conflicts exist.

Examples

# Show help
up repository permission revoke --help

# Basic usage
up repository permission revoke <team-name> <repository-name>

up repository (repo) update

Update a repository.

Usage

up repository (repo) update <name> [flags]

Arguments

<name>

Required

Name of repository. Required.

Flags

--private

The desired repository visibility. Required.

--publish

The desired repository publishing policy. Required.

--force

Default: false

Force the repository update.

Examples

# Show help
up repository update --help

# Basic usage
up repository update my-project

up robot

Interact with robots.

Usage

up robot [flags] [subcommand]

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Subcommands

• create - Create a robot.
• delete - Delete a robot.
• list - List robots for the account.
• get - Get a robot for the account.
• token - Interact with robot tokens.
• team - Interact with robot teams.

Examples

# Show help
up robot --help

up robot create

Create a robot.

Usage

up robot create <name> [flags]

Arguments

<name>

Required

Name of robot.

Flags

--description

Default:

Description of robot.

Examples

# Show help
up robot create --help

# Basic usage
up robot create my-project

up robot delete

Delete a robot.

Usage

up robot delete <name> [flags]

Arguments

<name>

Required

Name of robot.

Flags

--force

Default: false

Force delete robot even if conflicts exist.

Examples

# Show help
up robot delete --help

# Basic usage
up robot delete my-project

up robot get

Get a robot for the account.

Usage

up robot get <name>

Arguments

<name>

Required

Name of robot.

Examples

# Show help
up robot get --help

# Basic usage
up robot get my-project

up robot list

List robots for the account.

Usage

up robot list

Examples

# Show help
up robot list --help

up robot team

Interact with robot teams.

Usage

up robot team [subcommand]

Subcommands

• join - Add the robot to a team.
• leave - Remove the robot from a team.
• list - List all teams the robot is a member of.

Examples

# Show help
up robot team --help

up robot team join

Add the robot to a team.

Usage

up robot team join <team-name> <robot-name>

Arguments

<team-name>

Required

Name of team.

<robot-name>

Required

Name of robot.

Examples

# Show help
up robot team join --help

# Basic usage
up robot team join <team-name> <robot-name>

up robot team leave

Remove the robot from a team.

Usage

up robot team leave <team-name> <robot-name> [flags]

Arguments

<team-name>

Required

Name of team.

<robot-name>

Required

Name of robot.

Flags

--force

Default: false

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

Examples

# Show help
up robot team leave --help

# Basic usage
up robot team leave <team-name> <robot-name>

up robot team list

List all teams the robot is a member of.

Usage

up robot team list <robot-name>

Arguments

<robot-name>

Required

Name of robot.

Examples

# Show help
up robot team list --help

# Basic usage
up robot team list <robot-name>

up robot token

Interact with robot tokens.

Usage

up robot token [subcommand]

Subcommands

• create - Create a token for the robot.
• delete - Delete a token for the robot.
• list - List the tokens for the robot.
• get - Get a token for the robot.

Examples

# Show help
up robot token --help

up robot token create

Create a token for the robot.

Usage

up robot token create <robot-name> <token-name> [flags]

Arguments

<robot-name>

Required

Name of robot.

<token-name>

Required

Name of token.

Flags

--file / -f

file to write Token JSON, Use '-' to write to standard output.

Examples

# Show help
up robot token create --help

# Basic usage
up robot token create <robot-name> <token-name>

up robot token delete

Delete a token for the robot.

Usage

up robot token delete <robot-name> <token-name> [flags]

Arguments

<robot-name>

Required

Name of robot.

<token-name>

Required

Name of token.

Flags

--force

Default: false

Force delete token even if conflicts exist.

Examples

# Show help
up robot token delete --help

# Basic usage
up robot token delete <robot-name> <token-name>

up robot token get

Get a token for the robot.

Usage

up robot token get <robot-name> <token-name>

Arguments

<robot-name>

Required

Name of robot.

<token-name>

Required

Name of token.

Examples

# Show help
up robot token get --help

# Basic usage
up robot token get <robot-name> <token-name>

up robot token list

List the tokens for the robot.

Usage

up robot token list <robot-name>

Arguments

<robot-name>

Required

Name of robot.

Examples

# Show help
up robot token list --help

# Basic usage
up robot token list <robot-name>

up space

Interact with Spaces.

Usage

up space [subcommand]

Subcommands

• connect (attach) - Connect an Upbound Space to the Upbound web console.
• disconnect (detach) - Disconnect an Upbound Space from the Upbound web console.
• destroy - Remove the Upbound Spaces deployment.
• init - Initialize an Upbound Spaces deployment.
• list - List all accessible spaces in Upbound.
• mirror - Managing the mirroring of artifacts to local storage or private container registries.
• upgrade - Upgrade the Upbound Spaces deployment.
• billing

Examples

# Show help
up space --help

up space billing

Usage

up space billing [subcommand]

Subcommands

• export - Export a billing report for submission to Upbound.

Examples

# Show help
up space billing --help

up space billing export

Export a billing report for submission to Upbound.

Usage

up space billing export [flags]

Flags

--out / -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.

Examples

# Show help
up space billing export --help

up space connect (attach)

Connect an Upbound Space to the Upbound web console.

Usage

up space connect (attach) [space] [flags]

Arguments

<space>

Optional

Name of the Upbound Space. If name is not a supplied, one is generated.

Flags

--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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up space connect --help

# Basic usage
up space connect <space>

up space destroy

Remove the Upbound Spaces deployment.

Usage

up space destroy [flags]

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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

Examples

# Show help
up space destroy --help

up space disconnect (detach)

Disconnect an Upbound Space from the Upbound web console.

Usage

up space disconnect (detach) [space] [flags]

Arguments

<space>

Optional

Name of the Upbound Space. If name is not a supplied, it will be determined from the connection info in the space.

Flags

--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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up space disconnect --help

# Basic usage
up space disconnect <space>

up space init

Initialize an Upbound Spaces deployment.

Usage

up space init <version> [flags]

Arguments

<version>

Required

Upbound Spaces version to install.

Flags

--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 / -f

Parameters file.

--bundle

Local bundle path.

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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

Examples

# Show help
up space init --help

# Basic usage
up space init <version>

up space list

List all accessible spaces in Upbound.

Usage

up space list [flags]

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up space list --help

up space mirror

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

Usage

up space mirror [flags]

Flags

--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 / -t

The local directory path where exported artifacts will be saved as .tgz files.

--destination-registry / -d

The target container registry where the artifacts will be mirrored.

--version / -v

The specific Spaces version for which the artifacts will be mirrored.

Examples

# Show help
up space mirror --help

up space upgrade

Upgrade the Upbound Spaces deployment.

Usage

up space upgrade <version> [flags]

Arguments

<version>

Required

Upbound Spaces version to upgrade to.

Flags

--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 / -f

Parameters file.

--bundle

Local bundle path.

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up space upgrade --help

# Basic usage
up space upgrade <version>

up team

Interact with teams.

Usage

up team [flags] [subcommand]

Flags

--domain

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

--profile

Profile used to execute command.

--account / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Subcommands

• create - Create a team.
• delete - Delete a team.
• list - List teams.
• get - Get a team.

Examples

# Show help
up team --help

up team create

Create a team.

Usage

up team create <name>

Arguments

<name>

Required

Name of Team.

Examples

# Show help
up team create --help

# Basic usage
up team create my-project

up team delete

Delete a team.

Usage

up team delete <name> [flags]

Arguments

<name>

Required

Name of team.

Flags

--force

Default: false

Force delete team even if conflicts exist.

Examples

# Show help
up team delete --help

# Basic usage
up team delete my-project

up team get

Get a team.

Usage

up team get <name>

Arguments

<name>

Required

Name of team.

Examples

# Show help
up team get --help

# Basic usage
up team get my-project

up team list

List teams.

Usage

up team list

Examples

# Show help
up team list --help

up test

Manage and run tests for projects.

Usage

up test [subcommand]

Subcommands

• run - Run project tests.
• generate - Generate a Test for a project.

Examples

# Show help
up test --help

up test generate

Generate a Test for a project.

Usage

up test generate <name> [flags]

Arguments

<name>

Required

Name for the new Function.

Flags

--project-file / -f

Default: upbound.yaml

Path to project definition file.

--cache-dir

Default: ~/.up/cache/

Directory used for caching dependency images.

--language / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up test generate --help

# Basic usage
up test generate my-project

up test run

Run project tests.

Usage

up test run <patterns> [flags]

Arguments

<patterns>

Required

The path to the test manifests

Flags

--project-file / -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 non-development control plane.

--local

Use a local dev control plane, even if Spaces is available.

--use-current-context

Run the project with the current kubeconfig context rather than creating a new dev control plane.

--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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up test run --help

# Basic usage
up test run <patterns>

up uxp

Interact with UXP.

Usage

up uxp [flags] [subcommand]

Flags

--namespace / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Subcommands

• install - Install UXP.
• uninstall - Uninstall UXP.
• upgrade - Upgrade UXP.

Examples

# Show help
up uxp --help

up uxp install

Install UXP.

Usage

up uxp install [version] [flags]

Arguments

<version>

Optional

UXP version to install.

Flags

--unstable

Allow installing unstable versions.

--set

Set parameters.

--file / -f

Parameters file.

--bundle

Local bundle path.

Examples

# Show help
up uxp install --help

# Basic usage
up uxp install <version>

up uxp uninstall

Uninstall UXP.

Usage

up uxp uninstall

Examples

# Show help
up uxp uninstall --help

up uxp upgrade

Upgrade UXP.

Usage

up uxp upgrade [version] [flags]

Arguments

<version>

Optional

UXP version to upgrade to.

Flags

--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 / -f

Parameters file.

--bundle

Local bundle path.

Examples

# Show help
up uxp upgrade --help

# Basic usage
up uxp upgrade <version>

up version

Show current version.

Usage

up version [flags]

Flags

--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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up version --help

up xpkg

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

Usage

up xpkg [subcommand]

Subcommands

• build - Build a package, by default from the current directory.
• xp-extract - Extract package contents into a Crossplane cache compatible format. Fetches from a remote registry by default.
• push - Push a package.
• batch - Batch build and push a family of service-scoped provider packages.
• append - Append additional files to an xpkg.

Examples

# Show help
up xpkg --help

up xpkg append

Append additional files to an xpkg.

Usage

up xpkg append <remote-ref> [flags]

Arguments

<remote-ref>

Required

The fully qualified remote image reference

Flags

--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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up xpkg append --help

# Basic usage
up xpkg append <remote-ref>

up xpkg batch

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

Usage

up xpkg batch [flags]

Flags

--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 / -p

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

--output-dir / -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 / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up xpkg batch --help

up xpkg build

Build a package, by default from the current directory.

Usage

up xpkg build [flags]

Flags

--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 / -o

Path for package output.

--controller

Controller image used as base for package.

--package-root / -f

Default: .

Path to package directory.

--examples-root / -e

Default: ./examples

Path to package examples directory.

--helm-root / -h

Default: ./helm

Path to helm directory.

--auth-ext / -a

Default: auth.yaml

Path to an authentication extension file.

--ignore

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

Examples

# Show help
up xpkg build --help

up xpkg push

Push a package.

Usage

up xpkg push <tag> [flags]

Arguments

<tag>

Required

Tag of the package to be pushed. Must be a valid OCI image tag.

Flags

--package / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up xpkg push --help

# Basic usage
up xpkg push <tag>

up xpkg xp-extract

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

Usage

up xpkg xp-extract [package] [flags]

Arguments

<package>

Optional

Name of the package to extract. Must be a valid OCI image tag or a path if using --from-xpkg.

Flags

--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 / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up xpkg xp-extract --help

# Basic usage
up xpkg xp-extract <package>

up xpls

Start xpls language server.

Usage

up xpls [subcommand]

Subcommands

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

Examples

# Show help
up xpls --help

up xpls serve

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

Usage

up xpls serve [flags]

Flags

--cache

Default: ~/.up/cache

Directory path for dependency schema cache.

--verbose

Run server with verbose logging.

Examples

# Show help
up xpls serve --help

up xrd

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

Usage

up xrd [subcommand]

Subcommands

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

Examples

# Show help
up xrd --help

up xrd generate

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

Usage

up xrd generate <file> [flags]

Arguments

<file>

Required

Path to the file containing the Composite Resource (XR) or Composite Resource Claim (XRC).

Flags

--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 / -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 / -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 / -a

Deprecated. Use organization instead.

--organization

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

--ca-bundle

Path to CA bundle file to prepend to existing CAs

--insecure-skip-tls-verify

[INSECURE] Skip verifying TLS certificates.

--debug / -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.

Examples

# Show help
up xrd generate --help

# Basic usage
up xrd generate <file>