List of akka
commands
The akka
command line tool enables you to interact with your Akka projects and services using the command line. See Install the Akka CLI for information on how to download akka
. Use akka version
to check the version.
The following sections list akka commands and their options.
Log in to Akka
By default, akka 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 Akka server.
You can, optionally, provide the --no-launch-browser
flag with the akka auth
command (e.g. akka 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 Akka CLI will wait until you complete the login before continuing.
The akka auth command offers these options:
Enable auto-completion for your shell
The akka completion command generates auto-completion configuration for common shells. See Enable command completion for more information.
Manage local context
The akka 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 akka config set project my-project
.
The following options are available for akka config:
Manage the Akka Container Registry
The akka container-registry commands allow you to manage the Container Registry for your Akka Project.
The akka container-registry command includes the following options:
Manage Docker
The akka 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 akka docker:
Display logs
The akka logs
commands allow you to display the last few lines (default: 100) of logs for a specific service. The detail are available in akka logs.
Organizations
The akka 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 akka organization command includes the following options:
Projects
The akka projects
commands manipulate the projects in your Akka account. A project contains a set of services.
See also the akka roles commands.
The akka projects command includes the following options:
Access quickstart project samples
The akka quickstart
commands enable one to access Akka quickstart project samples.
The akka quickstart command includes the following options:
Regions
The akka regions
commands allow you to manage regions on Akka.
See also the akka project regions commands.
The akka regions command includes the following options:
Roles
The akka roles
commands allow you to associate user roles (authorizations) with the current project.
The akka roles command provides the following options:
Routes
The akka routes
commands manipulate the routes that can be used to expose services in your Akka Project to the internet.
The akka routes command includes the following options:
Manage secrets
The akka secrets
commands manage secrets in your Akka project.
The akka secret command includes the following options:
Manage services
The akka services
commands manipulate the services in your Akka Project.
The akka services command includes the following options:
Run Akka services locally
The akka local
commands allow you to run and manage locally running Akka services.
The akka local command includes the following options:
Display version
The akka version
commands allow you to display the CLI version. The detail are available in akka version.