CLI Reference

Global Options

These options are available on all commands:

Cluster Commands

• podplane cluster create – Generate cluster configuration and deploy infrastructure.
• podplane cluster delete – Remove deployed cluster infrastructure.

OIDC Commands

• podplane oidc create – Generate OIDC configuration and deploy infrastructure.
• podplane oidc delete – Remove deployed OIDC infrastructure.

Authentication Commands

• podplane login – Authenticate to a cluster via kubectl.
• podplane logout – Remove cluster authentication from kubeconfig.

Hooks Commands

• podplane hooks kubectl-auth – kubectl exec auth plugin.

App Commands

• podplane deploy – Deploy an app using a template.
• podplane remove – Remove a previously deployed app.
• podplane logs – Tail logs for a deployed app.

Component Commands

• podplane install – Install an addon component into the cluster.
• podplane uninstall – Remove an addon component from the cluster.

Local Commands

• podplane local start – Start a local cluster VM.
• podplane local status – Report the status of a local cluster VM.
• podplane local stop – Stop a local cluster VM.
• podplane local delete – Delete a local cluster VM and its state files.
• podplane local shell – Open a shell into a local cluster VM via SSH.
• podplane local console – Attach to a local cluster VM serial console.
• podplane local sync – Sync files into a local cluster VM.
• podplane local server – Run a local background server for VMs.

Deps Commands

• podplane deps status – Report package cache status.
• podplane deps download – Download latest package versions.

Informational Commands

• podplane version – Report the current CLI version.