CLI command reference

Log in only to deploy to or manage a remote Akka Platform environment, whether it runs at akka.io or is installed in your enterprise. See Login to a remote env.

The akka auth command offers these options:

The akka completion command generates auto-completion configuration for common shells. See Enable command completion for more information.

The 'akka specify' commands set up Akka projects for AI-assisted development. Use 'akka specify init' to create a new project with all the resources needed for AI coding agents, including slash commands, templates, and MCP configuration.

To start a source code project for a new Akka Service, the akka code init command offers an interactive experience to get you started. Using it, you can select from the samples catalog or create an empty source code project including instructions for your favorite AI assistant.

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 .akka/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:

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:

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:

The akka docs command opens the Akka online documentation page.

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.

The akka models commands deploy and serve models in Akka’s inference regions. See akka models and Model commands.

The akka optimize commands cover cost, models, training, and routing. See akka optimize and the CLI command map for where each group is described.

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:

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:

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:

The akka roles commands allow you to associate user roles (authorizations) with the current project.

The akka roles command provides the following options:

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:

The akka secrets commands manage secrets in your Akka project.

The akka secret command includes the following options:

The akka services commands manipulate the services in your Akka Project.

The akka services command includes the following options:

The akka services components commands let you inspect the state of components.

The akka services components command includes the following options:

The akka service-configs commands allow configuring services.

The akka service-configs command includes the following options:

The akka local commands allow you to run and manage locally running Akka services.

The akka local command includes the following options:

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