akkasls command line enables you to interact with your Akka Serverless projects and services using a command line. See Setting up a local development environment for information on how to download
akkasls. Use akkasls version to check the version.
The following sections list akkasls commands and their options.
akkasls 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 Serverless server.
You can, optionally, provide the
--no-launch-browser flag with the
akkasls auth command (e.g.
akkasls --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.
If successfully authenticated, and if you already have a project, the current project will be set to the active one.
The akkasls auth command offers these options:
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
.akkaserverless/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
akkasls config set project my-project.
The following options are available for akkasls config:
project commands manipulate the projects in your Akka Serverless account. A project contains a set of services. The akkasls projects command includes the following options:
roles commands allow you to associate user roles (authorizations) with the current project. The akkasls roles command provides the following options:
services commands manipulate the services in your Akka Serverless Project.
You need to set the current project before running the service command. You can set the current project using
The akkasls services command includes the following options: