cpln) is available via npm, Homebrew, or direct binary download for all major operating systems.
Choose your installation method
- npm
- Homebrew
- Binary
Install via npm if you have Node.js version 16 or later installed.
Copy
Ask AI
npm install -g @controlplane/cli
Requires Node.js version 16+.
Install via Homebrew on macOS or Linux.
Copy
Ask AI
brew tap controlplane-com/cpln && brew install cpln
If you don’t have Homebrew installed, follow the installation instructions.
Download and install the binary package for your operating system.
Download the binary
- Browser
- Command line
- macOS (ARM64)
- macOS (x64)
- Linux
- Windows (PowerShell)
- Windows (WSL2)
Copy
Ask AI
curl -LO https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2267695279-891d592b/cpln-macos-arm64.dmg
Copy
Ask AI
curl -LO https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2267695279-891d592b/cpln-macos-x64.dmg
Copy
Ask AI
curl -LO https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2267695279-891d592b/cpln-linux.tgz
Copy
Ask AI
Invoke-WebRequest -Uri "https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2267695279-891d592b/cpln-win.zip" -OutFile "cpln-win.zip"
Copy
Ask AI
curl -LO https://storage.googleapis.com/artifacts.cpln-build.appspot.com/binaries/cpln/2267695279-891d592b/cpln-linux.tgz
When using WSL2, download the Linux binary, not the Windows binary.
Extract and add to PATH
- macOS (ARM64)
- macOS (x64)
- Linux
- Windows
- Windows (WSL2)
Copy
Ask AI
hdiutil attach cpln-macos-arm64.dmg && \
cp -R /Volumes/cpln-macos-arm64/cpln /Volumes/cpln-macos-arm64/docker-credential-cpln . && \
hdiutil detach /Volumes/cpln-macos-arm64 && \
sudo mv cpln docker-credential-cpln /usr/local/bin/
You’ll be prompted to enter your password. The
sudo command requires administrator privileges to move files to /usr/local/bin.Copy
Ask AI
hdiutil attach cpln-macos-x64.dmg && \
cp -R /Volumes/cpln-macos-x64/cpln /Volumes/cpln-macos-x64/docker-credential-cpln . && \
hdiutil detach /Volumes/cpln-macos-x64 && \
sudo mv cpln docker-credential-cpln /usr/local/bin/
You’ll be prompted to enter your password. The
sudo command requires administrator privileges to move files to /usr/local/bin.Copy
Ask AI
tar -xvf cpln-linux.tgz && \
sudo mv cpln docker-credential-cpln /usr/local/bin/
You’ll be prompted to enter your password. The
sudo command requires administrator privileges to move files to /usr/local/bin.- Right-click
cpln-win.zipand select Extract All - Choose a permanent location (e.g.,
C:\Program Files\cpln) - Add to PATH:
- Press
Win + R, typesysdm.cpl, and press Enter - Click the Advanced tab → Environment Variables
- Under “User variables”, select Path and click Edit
- Click New and add the directory containing
cpln.exe(e.g.,C:\Program Files\cpln) - Click OK to save all dialogs
- Press
- Open a new Command Prompt or PowerShell window to use
cpln
Copy
Ask AI
tar -xvf cpln-linux.tgz && \
sudo mv cpln docker-credential-cpln /usr/local/bin/
You’ll be prompted to enter your password. The
sudo command requires administrator privileges to move files to /usr/local/bin.Browser login in WSL2: When you run After installation, Chrome appears in your Windows Start menu under the distro name (e.g., Ubuntu → Google Chrome). Run
cpln login, the CLI starts a local server and opens a localhost URL. This URL won’t work in your Windows browser because it points to the WSL2 instance’s localhost, not Windows.Option 1: Install Google Chrome in WSL2 (requires WSLg for GUI support):Copy
Ask AI
cd /tmp
sudo wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
sudo dpkg -i google-chrome-stable_current_amd64.deb
sudo apt install --fix-broken -y
sudo dpkg -i google-chrome-stable_current_amd64.deb
cpln login, copy the localhost URL from the terminal, and paste it into your WSL2 Chrome.Option 2: Use browser-less login with a service account token. See Browser-less CLI Login.Verify checksums
Verify checksums
| OS | File | SHA256 |
|---|---|---|
| macOS-arm64 | cpln-macos-arm64.dmg | 026079ae8706392aaa11e928480836e2ce4675225a6896f38950f2776dbdfd3c |
| macOS-x64 | cpln-macos-x64.dmg | 12c7415803ba8eca38dcffd612ad4271423743b07bdceeaf546848361cb5adbb |
| Linux | cpln-linux.tgz | fadc084925779cbe017b781fa4acf2d02a80d0fc5a22b2ec6b3c7d7e304b8b1d |
| Windows 10/11 | cpln-win.zip | 62b587b18a494a236586e6f628f5a1237e01a3511c5d41d5dd231619d0baeeae |
The binary package includes two executables:
cpln- The Control Plane CLIdocker-credential-cpln- Enables Docker authentication to your org’s private image registry
Verify installation
After installing with any method, confirm the CLI is installed and accessible:Copy
Ask AI
cpln --version
command not found, ensure the installation directory is in your PATH.