cpln) provides a powerful command-line interface for managing organizations, GVCs, workloads, and all supporting resources.
Nearly everything you can do through the Console UI, API, or Terraform can also be done through the CLI. The CLI also provides powerful operations not available elsewhere, such as port forwarding, executing commands in containers, and converting Kubernetes manifests.
Get started
Installation
Install via npm, Homebrew, or binary download
Quickstart
Get up and running in minutes
Authentication
Log in with interactive or token-based flows
Profiles
Manage multiple environments and contexts
Quick reference
1
Install the CLI
- npm
- Homebrew
- Binary
2
Verify installation
3
Authenticate
4
Explore commands
Using the CLI
Getting Help
Use built-in help to discover commands and flags
Common Options
Shared flags across all CLI commands
Output Formats
Control command output with JSON, YAML, and more
Troubleshooting
Common issues and solutions
Common Workflows
Deploy apps, manage secrets, debug workloads, and more
CI/CD & automation
CI/CD Usage
Automate deployments with service accounts
Container Images
Run the CLI inside Docker containers
CLI-only features
These operations are unique to the CLI and provide capabilities not available in the Console or API:cpln apply / delete
GitOps-style resource management from YAML/JSON files
cpln convert
Convert Kubernetes manifests to Control Plane format
cpln helm
Deploy Helm charts directly to Control Plane
cpln stack
Deploy Docker Compose applications to Control Plane
cpln operator
Manage the Kubernetes operator for Control Plane
cpln port-forward
Forward local ports to workloads for debugging
cpln cp
Copy files to and from workload containers
cpln workload exec
Execute commands inside running containers
cpln workload connect
Open an interactive shell in a workload container
Common workflows
Learn by example with these common CLI workflows:These examples assume you have a profile configured with a default org set.
Deploy an application
Deploy an application
- Local application
- Public image
Build and push your local application to Control Plane’s image registry:
bash
GitOps with cpln apply
GitOps with cpln apply
bash
Manage secrets and identities
Manage secrets and identities
Create a secret, grant a workload identity access to it via a policy, and inject it as an environment variable.See Policy for access control.
bash
Build and push images
Build and push images
bash
Debug a workload
Debug a workload
Command categories
The CLI organizes commands by resource type. Explore the Commands section for detailed reference on each command.Infrastructure
Workloads & compute
Images & containers
Security & access
Users & accounts
Networking & domains
Infrastructure as code
Operations & utilities
logs
View logs
port-forward
Forward ports to workloads
cp
Copy files to/from workloads
helm
Manage Helm releases
Cloud & integrations
System & admin
profile
CLI profiles
login
Authentication
quota
Resource quotas
task
Pending tasks
misc
Miscellaneous utilities
rest
Direct REST API access
Additional resources
CLI Guides
Step-by-step guides for CLI operations
API Reference
REST API documentation
Concepts
Core platform concepts
Terraform Provider
Infrastructure as code with Terraform