When you access the settings of AlphaScale, you'll come across a box named "API Key." This API Key is essential in connecting AlphaScale to the AlphaScale CLI (Command Line Interface) or AS-CLI using your personal API key.
Here’s what you need to know about the API Key and its usage with AlphaScale CLI:
Connecting AlphaScale to AS-CLI:
The API Key is a unique alphanumeric code that is an authentication token. You can see the API key
generated by enabling the key. Use this key to connect to AS-CLI. This connection allows you to interact
with AlphaScale’s features and functionalities using the command line.
CLI SETUP:
The CLI requires the AlphaScale API-KEY to authenticate with the AlphaScale services. It can be retrieved
from the AlphaScale settings webpage here. https://console.auxin.cloud/settings
After getting the API-KEY, the user has to export it as an environment variable on the system where CLI
is being used.
Here is an of command to export the API-KEY:
$ export AS_CLI_TOKEN=asp_KVHkNvsdNzktNTUkOC00MmVhLWI0MjMtMjc2NGYzYzlhKOlW
COMMANDS:
./ascli:
Arguments: None
Running the cli executable without giving any arguments displays help about CLI.
Its equivalent to ./ascli -h.
./ascli workload
Arguments: -h
The -h argument works with the sub-commands also.
./ascli workload :
Arguments: –name/-n, –description/-d [OPTIONAL]
This command creates workload given a name and description and returns the workload-id which is used for created component in this workload.
./ascli component :
Arguments: -h
This command displays details of the arguments when creating a component.
