Skip to main content
The Control Plane CLI includes comprehensive built-in help for every command and subcommand.

​
Using the help system

Display help at any level of the CLI: 
cpln --help
Use --help frequently to discover available subcommands, required parameters, and optional flags.

​
Help output structure

CLI help displays:
  • Description: What the command does
  • Usage: Command syntax and required parameters
  • Commands (if applicable): Available subcommands
  • Options: Flags and their defaults
  • Examples (where available): Common usage patterns

​
Available commands

cpln <command>

Commands:
  cpln account                              Manage accounts
  cpln agent                                Manage agents
  cpln apply                                Create or update a resource using an input file
  cpln auditctx                             Manage audit contexts
  cpln cloudaccount                         Manage cloud accounts
  cpln convert                              Convert k8s files to cpln files
  cpln cp <file-spec-src> <file-spec-dest>  Allows you to copy files and directories to and from workloads  [aliases: copy]
  cpln delete                               Delete resources from files
  cpln domain                               Manage custom domains
  cpln group                                Manage groups
  cpln gvc                                  Manage global virtual clouds
  cpln helm                                 Manage helm releases on cpln
  cpln identity                             Manage identities within a global virtual cloud  [aliases: id]
  cpln image                                Manage images and configure Docker login
  cpln ipset                                Manage IP Sets
  cpln location                             Manage locations  [aliases: loc]
  cpln login [ref]                          Create a profile named "default" and launch a browser to begin the interactive login process
  cpln logs <query>                         Show logs
  cpln misc                                 Miscellaneous helper commands
  cpln mk8s                                 Manage an mk8s cluster
  cpln operator                             A Kubernetes operator for Control Plane
  cpln org                                  Manage organizations
  cpln policy                               Manage access policies
  cpln port-forward <ref> <ports...>        Forward one or more local ports to a workload
  cpln profile                              Manage local profiles
  cpln quota                                Show quotas
  cpln rest                                 Submit REST requests against the API
  cpln secret                               Manage secrets
  cpln serviceaccount                       Manage service accounts  [aliases: sa]
  cpln stack                                manage docker-compose files  [aliases: compose]
  cpln task                                 Manage pending tasks
  cpln user                                 Manage users
  cpln volumeset                            Manage a persistent volumeset within a global virtual cloud
  cpln workload                             Manage workloads within a global virtual cloud  [aliases: w]

Options:
  --help     Show help  [boolean]
  --version  Show version number  [boolean]

© 2025 Control Plane Corporation

​
Finding specific information

​
List all top-level commands

cpln --help

​
Discover subcommands

Every command has subcommands. Use --help to see them: 
cpln gvc --help
Shows subcommands like get, create, delete, patch, etc.

​
View command-specific flags

cpln workload get --help
Displays all available flags for that specific command.

Common Options

Shared flags across all commands

Output Formats

Control command output formatting

Troubleshooting

Common issues and solutions

Commands

Browse all CLI commands

​
Common workflows and guides

​
Getting started

​
Deploying applications

  • Compose Deploy - Deploy applications using Docker Compose
  • cpln apply - Apply configuration files to create or update resources
  • cpln delete - Delete resources using configuration files

​
Working with workloads

​
Kubernetes integration

  • cpln operator - Manage the Kubernetes secret used by the Control Plane operator
  • cpln helm - Manage Control Plane resources using Helm charts
  • cpln port-forward - Forward local ports to workloads running in a GVC

​
Advanced operations

  • cpln convert - Convert Kubernetes manifests to Control Plane format
  • cpln cp - Copy files to and from workloads

​
Reference documentation

All commands have detailed reference pages in the Commands section. Each page includes:
  • Complete flag reference
  • Usage examples
  • Related commands

​
Next steps

Common Options

Learn about shared CLI flags

Quickstart

Get started with the CLI