README

Stratum Command Line Interface - Developed by Aptus Engineering, Inc.

Install using APT

Y Add package repository to list of sources.

sudo bash -c 'echo "deb [trusted=yes] https://apt.fury.io/aptusai/ /" > /etc/apt/sources.list.d/fury.list'

Update and install

sudo apt update

sudo apt install stratum

Install using NPM

npm install @aptusai/stratum

Link the stratum binary to /usr/bin/stratum so you can use stratum to access the functionality.

sudo npm link

Usage/CLI Commands

Authentication

Login to stratum. If email or password are not provided, and not stored locally, the CLI will prompt you for them. If the api endpoint is not provided it will be set to the default

stratum login [-e|--email $EMAIL] [-p|--pass $PASSWORD] [-a|--api $API_ENDPOINT]

Once logged in, a secure token will be stored for all future transactions.

Application Commands

Initialize a stratum project in the current directory.

stratum init $TASK [-w|--web]

Queue a stratum project for build (and deployment).

stratum build [-d|--deploy]

Reconfigure a stratum project's stratum.json file. This can update:

• build commands,
• dependencies,
• run command,
• timeout,
• authentication rules, and
• scaling rules.

stratum reconfigure

Set environment variables in deployed workers using a given file.

stratum setenv [-f|--file $FILE]

Set individual environment variable in a deployed worker.

stratum setenv [-v|--var $NAME=$VALUE]

Set the API endpoint that you are using. You must have previously logged in and must login again after using.

stratum setendpoint [-a|--api $API_ENDPOINT]

Task Control Commands

List all tasks associated with user, within a project if project:$PROJECT is specififed and/or filtered by string if filter:$FILTER is specified.

stratum ls [project:$PROJECT] [filter:$FILTER]

Deploy a dormant task to cloud workers using preset or automated scaling rules.

stratum deploy $TASK

Kill an active task, but keep them on workers for quick re-deployment.

stratum kill $TASK [--purge]

If the --purge flag is set, the cloud workers will be released.

Retrieve task statistics including deployments, strategies, savings, workload, usage, etc.

stratum stats $TASK

[DEV] Packaging for deployment

Stratum is build to use node-deb to generate a debian installer.

Install dependencies:

sudo apt install dpkg fakeroot jq

Change package name from @aptusai/stratum to stratum.

Run build script to generate a *.deb file. This file can be packaged and installed using dpkg.

npm run build

Change package name back to @aptusai/stratum.