List of kalix commands

The kalix command line tool enables you to interact with your Kalix projects and services using the command line. See Install kalix for information on how to download kalix. Use kalix version to check the version.

The following sections list kalix commands and their options.

Log in to Kalix

By default, kalix auth login will launch your web browser and take you to the proper URL to enter your credentials. The command-line client will print "Waiting for UI login…​" and pause while this happens, and then resume with a message once it receives the authorization token from the Kalix server.

You can, optionally, provide the --no-launch-browser flag with the kalix auth command (e.g. kalix auth login --no-launch-browser auth), in which case the command-line client will simply display the URL you can use for the authorization. This option is helpful if, for some reason, the command-line client is unable to launch your browser for you. The Kalix CLI will wait until you complete the login before continuing.

The kalix auth command offers these options:

Enable auto-completion for your shell

The kalix completion command generates auto-completion configuration for common shells. See How can I enable auto completion for my shell? for more information.

Manage local context

The config command is used to display and set configuration contexts and values that apply to subsequent commands. Configuration settings are stored in a file on your local system, by default at .kalix/config.yaml in your home directory.

A common use of config set command is to establish a specific project as the "current project" by using kalix config set project my-project.

The following options are available for kalix config:

Manage Docker

The kalix docker commands allow you to manage Docker credentials so that services can pull images from registries that require authentication. The following options are available for kalix docker:

Display logs

The kalix logs commands allow you to display the last few lines (default: 100) of logs for a specific service. The detail are available in kalix logs.

Manage organizations

The organizations commands allow you to manage the members within an organization. Projects can be created under an organization, and members of the organization can manage those projects. The kalix organization command includes the following options:

Access quickstart project samples

The quickstart commands enable to access Kalix quickstart project samples. The kalix quickstart command includes the following options:

Manage roles

The roles commands allow you to associate user roles (authorizations) with the current project. The kalix roles command provides the following options:

Manage routes

The routes commands manipulate the routes that can be used to expose services in your Kalix Project to the internet.

The kalix routes command includes the following options:

Display version

The kalix version commands allow you to display the kalix version. The detail are available in kalix version.