Documentation Index
Fetch the complete documentation index at: https://chainstack-mintlify-flesh-empty-pages.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
cpctl is the command-line tool for installing and upgrading Chainstack Self-Hosted. This page covers getting it onto your local machine.
Installing
cpctl only puts it on your machine. It does not deploy the Control Panel itself — for that, see Installation.cpctl, run the script for your operating system:
- Linux / macOS
- Windows
cpctl installer script, which sets up the Chainstack Self-Hosted command-line tool on your system.
Supported platforms
The installer automatically detects your operating system and architecture.| Operating system | Architectures |
|---|---|
| Linux | amd64 (x86_64), arm64 (aarch64) |
| macOS | amd64 (x86_64), arm64 (aarch64) |
| Windows | amd64 (x86_64), arm64 |
32-bit systems (x86, ARM) are not supported.
Install a specific version
- Linux / macOS
- Windows
Pass the version as an argument:Or set the
CPCTL_VERSION environment variable:Custom install directory
- Linux / macOS
- Windows
By default,
cpctl installs to /usr/local/bin/. To override the install directory, set the CPCTL_INSTALL_DIR environment variable:Make sure your server meets the system requirements before running the installer.
Verify the cpctl binary
After the installer completes, confirm thatcpctl is available and check its version:
Shell completion
cpctl can generate shell completion scripts for bash, zsh, fish, and PowerShell.
- bash
- zsh
- fish
- PowerShell
Load completions for the current session:Load for every new session:
Next steps
Withcpctl on your machine, you’re ready to set up the cluster and deploy the Control Panel:
- Environment setup — Set up your Kubernetes cluster and required tools, if not already done
- Installation — Deploy the Control Panel using
cpctl install - Quick start — End-to-end walkthrough from a fresh server