CLI Reference

Our Command Line Interface, nerd, allows you to interact with the Nerdalize Cloud and run your compute jobs. This reference provides detailed documentation of all the available command and subcommands, and their various options.

Global options

The following options are supported by all commands:

dataset

nerd dataset <subcommand>

upload and download datasets for tasks to use

dataset download

nerd dataset download <dataset-id> <output-dir>

download data from the cloud to a local directory

dataset list

nerd dataset list

show a list of all datasets

dataset upload

nerd upload <path>

upload data to the cloud and create a new dataset

login

nerd login

start a new authorized session

project

nerd project <subcommand>

set and list projects

project expel

nerd project expel

move the current project away from its current cluster

project list

nerd project list

list all your projects

project place

nerd project place <host>

place the current project on a compute cluster

Options

project set

nerd project set

set current working project

task

nerd task <subcommand>

manage the lifecycle of compute tasks

task describe

nerd task describe <workload-id> <task-id>

return more information about a specific task

task failure

nerd task failure <workload-id> <task-id> <run-token> <error-code> <err-message>

mark a task run as being failed

task heartbeat

nerd task heartbeat <workload-id> <task-id> <run-token>

indicate that a task run is still in progress

task list

nerd task list <workload-id>

show a list of all task currently in a queue

task receive

nerd task receive <workload-id>

wait for a new task run to be available on a queue

task start

nerd task start <workload-id> -- [cmd [args...]]

start a new task for a workload

Options

task stop

nerd task stop <workload-id> <task-id>

abort any run(s) of the specified task on a queue

task success

nerd task success <workload-id> <task-id> <run-token> <result>

mark a task run as having succeeded

workload

nerd workload <subcommand>

control compute capacity for working on tasks

workload describe

nerd workload describe <workload-id>

return more information about a specific workload

workload download

nerd workload download <workload-id> <output-dir>

download output data of a workload

workload list

nerd workload list

show a list of all workloads in the current project

workload start

nerd workload start <image>

provision a new workload to provide compute

Options

workload stop

nerd workload stop <workload-id>

stop a workload from providing compute capacity

workload work

nerd workload work <workload-id>

start working tasks of a queue locally

Options