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.
After installing it, sign in with your Deckrun account.
Install CLI
Homebrew
Installing the CLI with Homebrew is the fastest and easiest way. If you are not using it, you can run the installation script.
Using Homebrew (macOS and Linux)
brew install deckrun/deck-cli/deck
Installation Script (macOS and Linux)
curl -L https://deckrun.com/install-cli.sh | sh
To install a specific version, including a pre-release, pass its tag:
curl -L https://deckrun.com/install-cli.sh | sh -s v2.0.0-beta.0
Pre-releases are never installed by default, offered as updates, or published to Homebrew.
Windows
On Windows, you can Download the binary directly and add it to your $PATH
Verify Installation
After installation, confirm that the CLI is correctly installed by running:
deck version
Sign in
Run:
deck auth login
deck opens the Deckrun Dashboard in your browser. Approve the access there, and deck stores the token and selects your team. No token is pasted anywhere. If deck can't open a browser, for example over SSH, add --no-browser and open the URL it prints.
Sign in with an API token
You can also create a token yourself and paste it into deck:
- In the Deckrun Dashboard, go to Account Settings > API Tokens.
- Enter a token name for your reference, e.g. "CLI Access".
- Click Create and copy the token.
- Run
deck auth initand paste the token when prompted.
CI jobs and AI agents
Where nobody can sign in through a browser, such as a CI job or an AI agent without a browser, set the token in the DECKRUN_TOKEN environment variable instead:
export DECKRUN_TOKEN=<your API token>
deck apps list
DECKRUN_TOKENtakes precedence over a stored token, and deck never writes it to disk.deck auth logoutdoesn't revoke it: unset the variable instead.- If you belong to more than one team, also set
DECKRUN_TEAM_IDto the team to use. With a single team, deck uses it automatically.
Store the token as a secret of your CI provider, and avoid passing it on the command line, where it ends up in shell history and agent transcripts.
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!