Comment on page
Command Line commands
This section describes all the commands provided by the Akamas Command Line Interface (CLI):
The Akamas CLI provides a command-line interaction with the Akamas platform, thus enabling an infrastructure-as-code user experience to manage the end-to-end optimization lifecycle.
Notice: the Akamas CLI allows performing all the operations that you can do on the UI and more. In particular, the CLI has to be used for all modification operations on the platform, such as the creation and deletion of Akamas resources.
The following table describes all the Akamas' resources and their parent resources.
Akamas resources | Parent Resource |
|---|---|
Component | System |
Component Type | |
Metric | |
Parameter | |
Optimization Pack | |
Study | |
Step | |
Experiment | Study |
Trial | |
Telemetry Provider | |
Telemetry Instance | System |
KPI | System |
License | |
Workflow | |
User | |
Workspace | |
Akamas CLI provides built-in help, which is one of the few commands that do not require any authentication.
By issuing the following command:
akamas
you get something like the following:
Usage: akamas [OPTIONS] COMMAND [ARGS]...
A command line interface for Akamas.
Options:
--version Show the version and exit.
--help Show this message and exit.
Commands:
build Build a resource.
create Create a resource
delete Delete a resource
describe Show details of a specific resource
export Export a resource
finish Terminate the execution of a resource
import Restore a resource
init Initializes resources and other entities
install Install a resource
list List resource instances
log Show Akamas logs
login Login into Akamas
logout Logout from Akamas
set Set a resource.
start Start an execution of a resource
status Show the status of Akamas services
uninstall Uninstall a resource
update Update a resource
whoami Show logged user, current workspace and configured api address
Last modified 4mo ago