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

Finding specific information

List all top-level commands

Discover subcommands

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

View command-specific flags

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

  • cpln stack - 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