Down-pointing chevron Down-pointing chevron edit Copy Return Up-pointing chevronRight-pointing chevronfacebooklinkedintwitter

Nerd command reference

This reference provides a detailed list of all of Nerd’s commands and subcommands, and their options.

Cluster

Group of commands used to manage clusters.

cluster list

Returns an overview of your clusters.

$ nerd cluster list [OPTIONS]
Advanced Options
Global Options

cluster use

Set a specific cluster as the current one to use.

$ nerd cluster set-default NAME [OPTIONS]
Options
Advanced Options
Global Options

Dataset

Group of commands used to manage datasets. A dataset is a collection of files, like a folder on a computer. They can be used as input for a job and, when an application creates output files, these can be automatically stored in a new dataset.

dataset delete

Remove a dataset from the cluster.

$ nerd dataset delete DATASET_NAME [DATASET_NAME...]
Options
Global Options

dataset download

Download results from a running job.

$ nerd dataset [OPTIONS] download DATASET_NAME DOWNLOAD_PATH
Options
Global Options

dataset list

Return datasets that are managed by the cluster.

$ nerd dataset list [OPTIONS]
Global Options

dataset upload

Upload a dataset to your compute cluster.

$ nerd dataset upload [OPTIONS] DIR_TO_UPLOAD
Options
Advanced Options
Global Options

Job

Group of commands used to manage the lifecycle of jobs. A job is a computation that takes some input data, runs an application to do operations on this data and stores the results.

job delete

Remove one or more job(s) from the cluster.

$ nerd job delete JOB [JOB...]
Options
Global Options

job list

Return jobs that are managed by the cluster.

$ nerd job list [OPTIONS]
Global Options

job logs

Return logs for a running job.

$ nerd job logs [OPTIONS] JOB
Options
Global Options

job run

Run a job on your compute cluster.

$ nerd job run [OPTIONS] IMAGE [ARG...]
Options
Advanced Options
Global Options

Login

Start a new authorized session.

$ nerd login [OPTIONS]

Version

Check the current version of the CLI

$ nerd version