Setting Up

1. Install the Kalix CLI

Windows

  1. Download the latest version of kalix from https://downloads.kalix.io/latest/kalix_windows_amd64.zip

  2. Optionally, you can verify the integrity of the downloaded files using the SHA256 checksums.

  3. Extract the zip file and move kalix.exe to a location on your %PATH%.

macOS

Recommended approach

The recommended approach to install kalix on macOS, is using brew

brew install lightbend/brew/kalix

If the kalix CLI is already installed, and you want to upgrade kalix to the latest version, you can run

brew update
brew upgrade kalix

Alternative approach

curl -sL https://docs.kalix.io/install-cli.sh | bash

You can pass options to the installer script with -s -- e.g.:

curl -sL https://docs.kalix.io/install-cli.sh | bash -s -- --prefix=$HOME --version=2.0.22 --verbose
curl -sL https://docs.kalix.io/install-cli.sh | bash -s -- -P $HOME -v 2.0.22 -V
Linux

Download and install the latest version of kalix:

curl -sL https://docs.kalix.io/install-cli.sh | bash

If that fails due to permission issues, use:

curl -sL https://docs.kalix.io/install-cli.sh | sudo bash

You can pass options to the installer script with -s -- e.g.:

curl -sL https://docs.kalix.io/install-cli.sh | bash -s -- --prefix=$HOME --version=2.0.22 --verbose
curl -sL https://docs.kalix.io/install-cli.sh | bash -s -- -P $HOME -v 2.0.22 -V

Verify that the Kalix CLI has been installed successfully by running the following to list all available commands:

kalix help

2. Register for a Kalix account

kalix auth signup

3. Do a Quickstart

Do a Quickstart in the programming language of your choice: