Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.controlplane.com/llms.txt

Use this file to discover all available pages before exploring further.

The Control Plane CLI (cpln) is available via npm, Homebrew, or direct binary download for all major operating systems.

Choose your installation method

Install via npm if you have Node.js version 16 or later installed.
npm install -g @controlplane/cli
Requires Node.js version 16+.

Verify installation

After installing with any method, confirm the CLI is installed and accessible:
cpln --version
You should see the version number printed to the console. If you see command not found, ensure the installation directory is in your PATH.

Enable shell completion (optional)

Enable tab completion for cpln commands, subcommands, and flags in your terminal:
cpln misc install-completion
Restart your terminal after installation. For non-interactive setup and supported shells, see Shell Completion.

Next steps

Quickstart

Get started with the CLI in minutes

Authentication

Learn how to authenticate