CLI Reference

The ctrlc CLI is the primary tool for interacting with Ctrlplane from your terminal, CI/CD pipelines, and automation scripts. It supports syncing resources, managing deployments, and applying configuration.

Installation

brew tap ctrlplanedev/tap
brew install ctrlplanedev/tap/ctrlc

npm install -g @ctrlplane/cli

curl -fsSL https://get.ctrlplane.dev | sh

Authentication

Set your API key and workspace as environment variables or pass them as flags:

# Environment variables (recommended)
export CTRLPLANE_API_KEY="your-api-key"
export CTRLPLANE_WORKSPACE="your-workspace-id"
export CTRLPLANE_URL="https://your-ctrlplane-instance.com"

# Or pass as flags
ctrlc --api-key "your-api-key" --workspace "your-workspace-id" <command>

Commands

`ctrlc sync`

Sync infrastructure resources into Ctrlplane’s inventory. Each subcommand targets a specific provider or input method.

Subcommand	Description
`sync pipe`	Read resources from stdin (JSON)
`sync kubernetes`	Sync Kubernetes cluster resources
`sync aws`	Sync AWS resources
`sync google-cloud`	Sync Google Cloud resources
`sync azure`	Sync Azure resources
`sync terraform`	Sync Terraform state resources
`sync helm`	Sync Helm releases
`sync github`	Sync GitHub repositories
`sync vcluster`	Sync virtual clusters

`ctrlc api`

Interact directly with the Ctrlplane API.

Subcommand	Description
`api upsert version`	Create or update a deployment version

See CI/CD Integration for detailed usage.

`ctrlc apply`

Apply resource definitions from YAML files.

ctrlc apply -f resource.yaml

Global Flags

Flag	Environment Variable	Description
`--api-key`	`CTRLPLANE_API_KEY`	API key for authentication
`--workspace`	`CTRLPLANE_WORKSPACE`	Workspace name or ID
`--url`	`CTRLPLANE_URL`	Ctrlplane API URL

Next Steps

Sync Pipe

Sync resources from stdin

CI/CD Integration

Use the CLI in CI/CD pipelines

Resource Providers

Built-in resource providers

Custom Provider

Build your own provider

CLI

Concepts

RFCs

CLI Reference

Installation

Authentication

Commands

`ctrlc sync`

`ctrlc api`

`ctrlc apply`

Global Flags

Next Steps

Sync Pipe

CI/CD Integration

Resource Providers

Custom Provider

​Installation

​Authentication

​Commands

​ctrlc sync

​ctrlc api

​ctrlc apply

​Global Flags

​Next Steps

Sync Pipe

CI/CD Integration

Resource Providers

Custom Provider

Installation

Authentication

Commands

`ctrlc sync`

`ctrlc api`

`ctrlc apply`

Global Flags

Next Steps