Getting started
Install Deck CLI
Deck CLI is the command-line interface for managing your deployments on Deckrun. It allows you to create clusters, deploy applications, and manage services easily.
You must create a new API token and provide this token to the CLI.
Install CLI
Homebrew
Installing the CLI with Homebrew is the fastest and easiest way. If you are not using it, you can manually download the binary.
Using Homebrew (Recommended)
brew install deckrun/deck-cli/deck
Downloading Binary
If you prefer you can manually download the CLI and add it to your $PATH
| Operating System | Download Link |
|---|---|
| Linux (x86-64) | Download |
| Linux (arm64) | Download |
| macOS (arm64 - Apple Silicon) | Download |
| macOS (x86-64 - Intel) | Download |
| Windows (x86-64) | Download |
Verify Installation
After installation, confirm that the CLI is correctly installed by running:
deck version
Set-up CLI
Step 1: Create an API Token
To authenticate the CLI, you need an API token.
- Access the Deckrun Dashboard and navigate to Account Settings > API Tokens.
- Provide a token name (for your reference only, e.g. "CLI Access").
- Click on Create and copy the generated token.
Step 2: Authenticate the CLI
Run the following command and enter the API token when prompted:
deck auth init
This will store your credentials and allow you to use Deck CLI.
Next Steps
Once authenticated, you can start using Deck CLI to deploy applications and manage your infrastructure.
Check out the Quickstart to deploy your first application!