List of akkasls commands

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

The following sections list akkasls commands and their options.

Log in to Akka Serverless

By default, 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 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 Serverless CLI will wait until you complete the login before continuing.

The akkasls auth command offers these options:

Enable auto-completion for your shell

The akkasls 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 .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:

Manage Docker

The akkasls 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 akkasls docker:

Display logs

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

Manage projects

The 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:

Access quickstart project samples

The quickstart commands enable to access Akka Serverless quickstart project samples. The akkasls quickstart command includes the following options:

Manage roles

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

Manage services

The 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 akkasls config set project my-project.

The akkasls services command includes the following options:

Display version

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