The Adviser Labs CLI is your portal into the Adviser platform via commandline interface. If you usually run your simulations, jobs, etc via the commandline, then this provides a simple and natural extension to how you work.

adviser

Adviser CLI

usage: adviser [-h] command [args ...]
Commands include:
    cluster  - create, list, or remove clusters
    job      - list or remove jobs
    run      - create a job
    invite   - invite users into your Organization
    login    - login to the Adviser platform
    signup   - create an account on the Adviser platform
To get help on any of those, run:
    adviser <command> --help

command

Commands: job, invite, login, run, signup, cluster

args

-h, --help

show this help message and exit

cluster

commands related to clusters

usage: adviser cluster [-h] command [args ...]
Commands include:
    create - create a cluster by ID
    delete - delete a cluster by ID
    list   - list clusters, optionally including deleted/used ones
To get help on any of those, run:
    adviser cluster <command> --help

command

Commands: create, delete, list

args

typically –id <CLUSTER_ID>

-h, --help

show this help message and exit

invite

Invite a user to the organization.

usage: invite [-h] [--name NAME] [--email EMAIL]

-h, --help

show this help message and exit

--name <name>

Name of the user to invite.

--email <email>

Email of the user to invite.

job

Commands related to jobs

usage: adviser job [-h] command [args ...]

command

Commands for jobs: ls, download

args

-h, --help

show this help message and exit

login

Login to the Adviser platform.

usage: login [-h]

-h, --help

show this help message and exit

run

Run a job

usage: adviser run [-h] run_command [--setup SETUP] [--workdir WORKDIR] [--mount MOUNT]

run_command

Command to run on the cluster.

-h, --help

show this help message and exit

--setup <setup>

Setup command to run on the cluster before the run_command.

--workdir <workdir>

Working directory for the task.

--mount <mount>

Directory to mount for output of your job.

--cloud <cloud>

Cloud provider (AWS, GCP, Azure).

--cluster <cluster>

Cluster ID of already-runnning cluster.

-c, --clean

Clean up (shut down) whichever cluster we use when job finishes.

-f, --force-create

If existing clusters are all already in-use, create a new cluster.

signup

Signup to the Adviser platform.

usage: signup [-h]

-h, --help

show this help message and exit

cluster create

Create a cluster on specified cloud

usage: adviser cluster create [args...]

-h, --help

show this help message and exit

--cloud <cloud>

Cloud provider to create cluster on

--setup <setup>

Setup command to run after the cluster is created

--workdir <workdir>

Working directory to run setup command

cluster list

List clusters

usage: adviser cluster list [--include-all]

-h, --help

show this help message and exit

--include-all

Include deleted or unavailable clusters

cluster delete

Delete a cluster by ID

usage: adviser cluster delete --id <CLUSTER_ID>

-h, --help

show this help message and exit

--id <id>

ID of the cluster to delete