Documentation

​
​

Development

User Acquisition

Monetization

Industry

Self-Hosted Deployment

Amazon Web Services

Microsoft Azure

On premises

vpctl

Self-Hosted Deployment

​
​
Self-Hosted Deployment
  • Overview
  • Amazon Web Services
  • Microsoft Azure
  • On premises
  • Administration
  • Security
  • vpctl
    • vpctl Architecture
    • Installation
    • Manifest reference
    • vpctl commands
      • Artifact
      • Cluster
      • Configure
      • Manifest
      • Release
      • Secret
    • Troubleshooting
    • Changelog
  1. Self-Hosted Deployment (previously called Unity Virtual Private Cloud)
  2. vpctl command-line tool

vpctl command reference

Reference documentation for vpctl commands, flags, workflows, and deployment operations
Read time 2 minutes
Last updated 13 days ago

Use this page to find command references for vpctl. To get started with vpctl and learn about recommended deployment workflows, refer to vpctl and Architecture and security.
Release
pull, generate, deploy, uninstall.
Artifact
sync preflight, sync images, sync oras, sync charts.
Secret
generate, deploy.
Manifest
init, validate, schema.
Cluster
check.
Configure
Set, view, and delete registry credentials.

Global flags

You can use these flags with any command:
  • --manifest <path>
    : Path to manifest.yaml file (default: auto-discover)
  • --log-level <level>
    : Set logging level (
    trace
    ,
    debug
    ,
    info
    ,
    warn
    ,
    error
    ,
    fatal
    ,
    panic
    ; default:
    info
    )
  • --json
    : Output logs in JSON format
Example:
vpctl release pull --version 1.2.3 --log-level debug

Command summary

Command

Description

vpctl version
Print the version number
vpctl configure
Set registry credentials (interactive)
vpctl configure get
View configuration
vpctl configure set [registry]
Set registry credentials (non-interactive)
vpctl configure delete [registry]
Delete registry credentials
vpctl manifest init
Initialize a new manifest file interactively
vpctl manifest validate
Validate a manifest file against the CUE schema
vpctl manifest schema
Display the CUE schema (or export it for standalone validation)
vpctl cluster check
Validate that the cluster meets the deployment prerequisites (read-only;
--probe-storage
adds an opt-in volume probe,
--dry-run
prints the command plan)
vpctl release pull
Pull a release from the registry
vpctl release generate
Generate release configuration (Helm/ArgoCD charts)
vpctl release deploy
Deploy a release (Helm or ArgoCD)
vpctl release uninstall
Uninstall a release
vpctl artifact sync preflight
Verify registry authentication by syncing one image, one ORAS artifact, and (in remote chart mode) one Helm chart
vpctl artifact sync images
Sync Docker images from the source registry to the target registry
vpctl artifact sync oras
Sync ORAS artifacts from the source registry to the target registry
vpctl artifact sync charts
Sync OCI Helm charts from the source registry to the target registry (requires
deployment.helmChartMode: "remote"
)
vpctl secret generate
Generate Kubernetes secret YAML from schema definitions
vpctl secret deploy
Deploy secrets to your Kubernetes cluster

Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

  • On this page
    • Global flags

    • Command summary


Report a problem with this page