Installing the Koyeb CLI

The Koyeb CLI is a command-line interface allowing you to 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.

Homebrew

If you have Homebrew 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)

Another alternative to installing the Koyeb CLI is to execute the install script. Using this installation method, the koyeb binary is installed in your home directory inside the .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).

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.

docker pull koyeb/koyeb-cli:latest

Auto-completion

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

On Linux

For bash: To enable auto-completion for bash, run:

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

For zsh: To enable auto-completion for zsh, run:

koyeb completion zsh > "${fpath[1]}/_koyeb"

Note that if shell completion is not already enabled in your environment you will need to enable it by executing:

echo "autoload -U compinit; compinit" >> ~/.zshrc

On Mac