Build & Deploy
CLI
Installation

Installing the Koyeb CLI

The Koyeb CLI is a command-line interface that lets you interact with Koyeb directly from the terminal. You can install it using the installers below, or download a release binary from the GitHub releases page (opens in a new tab).

Homebrew

If you have Homebrew (opens in a new tab) installed on your computer, you can install the CLI by running:

brew install koyeb/tap/koyeb

To upgrade an existing installation of the Koyeb CLI, run:

brew upgrade koyeb

Shell (Mac, Linux)

An alternative way to install the Koyeb CLI is to execute the install script. Using this installation method, the koyeb binary is installed in your home directory inside a ~/.koyeb folder.

curl -fsSL https://raw.githubusercontent.com/koyeb/koyeb-cli/master/install.sh | sh

To add the binary to your path, you will have to add the following to your shell profile (i.e. .bashrc or .zshrc).

.bashrc or .zshrc
export PATH=$HOME/.koyeb/bin:$PATH

Docker

We provide the Koyeb CLI as ready-to-use Docker container images. You can install the latest version of the CLI using the latest tag or a specific version passing the appropriate tag (opens in a new tab).

docker pull koyeb/koyeb-cli:latest

Auto-completion

The Koyeb CLI comes with auto-completion support for bash and zsh.

On Linux

To enable auto-completion for bash, run:

koyeb completion bash > /etc/bash_completion.d/koyeb

On Mac

To enable auto-completion for bash, run:

koyeb completion bash > /usr/local/etc/bash_completion.d/koyeb

GitHub

The CLI source code is available on GitHub (opens in a new tab) if you want to install it directly from the sources, open an issue or a pull request.