Getting Started
Installation
Install the ColdPlane CLI and configure your environment.
Install via Shell (macOS / Linux)
curl -fsSL https://get.coldplane.com | shThis detects your OS and architecture, downloads the latest binary, and places
it in /usr/local/bin.
Install on Windows
Download the latest Windows binary and add it to your PATH:
- Download coldplane-windows-amd64.exe
- Rename it to
coldplane.exe - Move it to a directory in your PATH (e.g.,
C:\Users\<you>\AppData\Local\Microsoft\WindowsApps\)
Or via PowerShell:
Invoke-WebRequest -Uri "https://releases.coldplane.com/cli/latest/coldplane-windows-amd64.exe" -OutFile "$env:LOCALAPPDATA\Microsoft\WindowsApps\coldplane.exe"Manual Download
If you prefer not to pipe to shell, download the binary directly:
| Platform | Architecture | Download |
|---|---|---|
| macOS | Apple Silicon (arm64) | coldplane-darwin-arm64 |
| macOS | Intel (x86_64) | coldplane-darwin-amd64 |
| Linux | x86_64 | coldplane-linux-amd64 |
| Linux | arm64 | coldplane-linux-arm64 |
| Windows | x86_64 | coldplane-windows-amd64.exe |
For macOS/Linux, make it executable and move it to your PATH:
chmod +x coldplane-*
sudo mv coldplane-* /usr/local/bin/coldplaneVerify Installation
coldplane versionAuthenticate
Set your API key to authenticate with ColdPlane:
coldplane auth set-key --key <your-api-key>You can generate an API key from the ColdPlane Dashboard.
This saves your credentials to ~/.coldplane/config.json.
Verify Setup
coldplane auth whoami