spec.json

{
	"commands": {
		"cluster": {
			"usage": "nerd cluster \u003csubcommand\u003e",
			"synopsis": "Group of commands used to manage clusters.",
			"description": "Group of commands used to manage clusters.",
			"options": {
				"Global Options": [
					{
						"long_name": "kubeconfig",
						"description": "file at which Nerd will look for Kubernetes credentials",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "timeout",
						"description": "duration for which Nerd will wait for Kubernetes",
						"default_value": [
							"10s"
						],
						"choices": null
					}
				],
				"Options": []
			}
		},
		"cluster list": {
			"usage": "nerd cluster list [OPTIONS]",
			"synopsis": "Returns an overview of your clusters.",
			"description": "Returns an overview of your clusters.",
			"options": {
				"Advanced Options": [
					{
						"long_name": "config-file",
						"description": "Location of config file",
						"default_value": [
							""
						],
						"choices": null
					},
					{
						"long_name": "session-file",
						"description": "Location of session file",
						"default_value": [
							""
						],
						"choices": null
					}
				],
				"Global Options": [
					{
						"long_name": "kubeconfig",
						"description": "file at which Nerd will look for Kubernetes credentials",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "timeout",
						"description": "duration for which Nerd will wait for Kubernetes",
						"default_value": [
							"10s"
						],
						"choices": null
					}
				],
				"Options": []
			}
		},
		"cluster use": {
			"usage": "nerd cluster set-default NAME [OPTIONS]",
			"synopsis": "Set a specific cluster as the current one to use.",
			"description": "Set a specific cluster as the current one to use.",
			"options": {
				"Advanced Options": [
					{
						"long_name": "config-file",
						"description": "Location of config file",
						"default_value": [
							""
						],
						"choices": null
					},
					{
						"long_name": "session-file",
						"description": "Location of session file",
						"default_value": [
							""
						],
						"choices": null
					}
				],
				"Global Options": [
					{
						"long_name": "kubeconfig",
						"description": "file at which Nerd will look for Kubernetes credentials",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "timeout",
						"description": "duration for which Nerd will wait for Kubernetes",
						"default_value": [
							"10s"
						],
						"choices": null
					}
				],
				"Options": [
					{
						"long_name": "namespace",
						"short_name": "n",
						"description": "set a specific namespace as the default one",
						"default_value": null,
						"choices": null
					}
				]
			}
		},
		"dataset": {
			"usage": "nerd dataset \u003csubcommand\u003e",
			"synopsis": "Group of commands used to manage datasets (collection of files).",
			"description": "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.",
			"options": {
				"Global Options": [
					{
						"long_name": "kubeconfig",
						"description": "file at which Nerd will look for Kubernetes credentials",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "timeout",
						"description": "duration for which Nerd will wait for Kubernetes",
						"default_value": [
							"10s"
						],
						"choices": null
					}
				],
				"Options": []
			}
		},
		"dataset delete": {
			"usage": "nerd dataset delete DATASET_NAME [DATASET_NAME...]",
			"synopsis": "Remove a dataset from the cluster.",
			"description": "Remove a dataset from the cluster.",
			"options": {
				"Global Options": [
					{
						"long_name": "kubeconfig",
						"description": "file at which Nerd will look for Kubernetes credentials",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "timeout",
						"description": "duration for which Nerd will wait for Kubernetes",
						"default_value": [
							"10s"
						],
						"choices": null
					}
				],
				"Options": [
					{
						"long_name": "all",
						"short_name": "a",
						"description": "delete all your datasets in one command",
						"default_value": null,
						"choices": null
					}
				]
			}
		},
		"dataset download": {
			"usage": "nerd dataset [OPTIONS] download DATASET_NAME DOWNLOAD_PATH",
			"synopsis": "Download results from a running job.",
			"description": "Download results from a running job.",
			"options": {
				"Global Options": [
					{
						"long_name": "kubeconfig",
						"description": "file at which Nerd will look for Kubernetes credentials",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "timeout",
						"description": "duration for which Nerd will wait for Kubernetes",
						"default_value": [
							"10s"
						],
						"choices": null
					}
				],
				"Options": [
					{
						"long_name": "input-of",
						"description": "specify a job name where the datasets were used as its input. Dataset name is no longer mandatory.",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "output-of",
						"description": "specify a job name where the datasets were used as its output. Dataset name is no longer mandatory.",
						"default_value": null,
						"choices": null
					}
				]
			}
		},
		"dataset list": {
			"usage": "nerd dataset list [OPTIONS]",
			"synopsis": "Return datasets that are managed by the cluster.",
			"description": "Return datasets that are managed by the cluster.",
			"options": {
				"Global Options": [
					{
						"long_name": "kubeconfig",
						"description": "file at which Nerd will look for Kubernetes credentials",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "timeout",
						"description": "duration for which Nerd will wait for Kubernetes",
						"default_value": [
							"10s"
						],
						"choices": null
					}
				],
				"Options": []
			}
		},
		"dataset upload": {
			"usage": "nerd dataset upload [OPTIONS] DIR_TO_UPLOAD",
			"synopsis": "Upload a dataset to your compute cluster.",
			"description": "Upload a dataset to your compute cluster.",
			"options": {
				"Advanced Options": [
					{
						"long_name": "s3-bucket",
						"description": "S3 Bucket name that will be used for dataset storage",
						"default_value": [
							"nlz-datasets-dev"
						],
						"choices": null
					},
					{
						"long_name": "aws-region",
						"description": "AWS region used for dataset storage",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "s3-access-key",
						"description": "access key used for auth with the storage backend",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "s3-secret-key",
						"description": "secret key for auth with the storage backend",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "s3-session-token",
						"description": "temporary auth token for the storage backend",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "s3-prefix",
						"description": "store this dataset under a specific prefix",
						"default_value": null,
						"choices": null
					}
				],
				"Global Options": [
					{
						"long_name": "kubeconfig",
						"description": "file at which Nerd will look for Kubernetes credentials",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "timeout",
						"description": "duration for which Nerd will wait for Kubernetes",
						"default_value": [
							"10s"
						],
						"choices": null
					}
				],
				"Options": [
					{
						"long_name": "name",
						"short_name": "n",
						"description": "assign a name to the dataset",
						"default_value": null,
						"choices": null
					}
				]
			}
		},
		"job": {
			"usage": "nerd job \u003csubcommand\u003e",
			"synopsis": "Group of commands used to manage the lifecycle of jobs.",
			"description": "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.",
			"options": {
				"Global Options": [
					{
						"long_name": "kubeconfig",
						"description": "file at which Nerd will look for Kubernetes credentials",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "timeout",
						"description": "duration for which Nerd will wait for Kubernetes",
						"default_value": [
							"10s"
						],
						"choices": null
					}
				],
				"Options": []
			}
		},
		"job delete": {
			"usage": "nerd job delete JOB [JOB...]",
			"synopsis": "Remove one or more job(s) from the cluster.",
			"description": "Remove one or more job(s) from the cluster.",
			"options": {
				"Global Options": [
					{
						"long_name": "kubeconfig",
						"description": "file at which Nerd will look for Kubernetes credentials",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "timeout",
						"description": "duration for which Nerd will wait for Kubernetes",
						"default_value": [
							"10s"
						],
						"choices": null
					}
				],
				"Options": [
					{
						"long_name": "all",
						"short_name": "a",
						"description": "delete all your jobs in one command",
						"default_value": null,
						"choices": null
					}
				]
			}
		},
		"job list": {
			"usage": "nerd job list [OPTIONS]",
			"synopsis": "Return jobs that are managed by the cluster.",
			"description": "Return jobs that are managed by the cluster.",
			"options": {
				"Global Options": [
					{
						"long_name": "kubeconfig",
						"description": "file at which Nerd will look for Kubernetes credentials",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "timeout",
						"description": "duration for which Nerd will wait for Kubernetes",
						"default_value": [
							"10s"
						],
						"choices": null
					}
				],
				"Options": []
			}
		},
		"job logs": {
			"usage": "nerd job logs [OPTIONS] JOB",
			"synopsis": "Return logs for a running job.",
			"description": "Return logs for a running job.",
			"options": {
				"Global Options": [
					{
						"long_name": "kubeconfig",
						"description": "file at which Nerd will look for Kubernetes credentials",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "timeout",
						"description": "duration for which Nerd will wait for Kubernetes",
						"default_value": [
							"10s"
						],
						"choices": null
					}
				],
				"Options": [
					{
						"long_name": "tail",
						"short_name": "t",
						"description": "only return the oldest N lines of the process logs",
						"default_value": null,
						"choices": null
					}
				]
			}
		},
		"job run": {
			"usage": "nerd job run [OPTIONS] IMAGE [ARG...]",
			"synopsis": "Run a job on your compute cluster.",
			"description": "Run a job on your compute cluster.",
			"options": {
				"Advanced Options": [
					{
						"long_name": "s3-bucket",
						"description": "S3 Bucket name that will be used for dataset storage",
						"default_value": [
							"nlz-datasets-dev"
						],
						"choices": null
					},
					{
						"long_name": "aws-region",
						"description": "AWS region used for dataset storage",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "s3-access-key",
						"description": "access key used for auth with the storage backend",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "s3-secret-key",
						"description": "secret key for auth with the storage backend",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "s3-session-token",
						"description": "temporary auth token for the storage backend",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "s3-prefix",
						"description": "store this dataset under a specific prefix",
						"default_value": null,
						"choices": null
					}
				],
				"Global Options": [
					{
						"long_name": "kubeconfig",
						"description": "file at which Nerd will look for Kubernetes credentials",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "timeout",
						"description": "duration for which Nerd will wait for Kubernetes",
						"default_value": [
							"10s"
						],
						"choices": null
					}
				],
				"Options": [
					{
						"long_name": "name",
						"short_name": "n",
						"description": "assign a name to the job",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "env",
						"short_name": "e",
						"description": "environment variables to use",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "memory",
						"short_name": "m",
						"description": "memory to use for this job, expressed in gigabytes",
						"default_value": [
							"1"
						],
						"choices": null
					},
					{
						"long_name": "vcpu",
						"description": "number of vcpus to use for this job",
						"default_value": [
							"1"
						],
						"choices": null
					},
					{
						"long_name": "input",
						"description": "specify one or more inputs that will be used for the job using the following format: \u003cDIR|DATASET_NAME\u003e:\u003cJOB_DIR\u003e",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "output",
						"description": "specify one or more output folders that will be stored as datasets after the job is finished using the following format: \u003cDATASET_NAME\u003e:\u003cJOB_DIR\u003e",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "private",
						"description": "use this flag with a private image, a prompt will ask for your username and password of the repository that stores the image. If NERD_IMAGE_USERNAME and/or NERD_IMAGE_PASSWORD environment variables are set, those values are used instead.",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "clean-creds",
						"description": "to be used with the '--private' flag, a prompt will ask again for your image repository username and password. If NERD_IMAGE_USERNAME and/or NERD_IMAGE_PASSWORD environment variables are provided, they will be used as values to update the secret.",
						"default_value": null,
						"choices": null
					}
				]
			}
		},
		"login": {
			"usage": "nerd login [OPTIONS]",
			"synopsis": "Start a new authorized session.",
			"description": "Start a new authorized session.",
			"options": {
				"Advanced Options": [
					{
						"long_name": "config-file",
						"description": "Location of config file",
						"default_value": [
							""
						],
						"choices": null
					},
					{
						"long_name": "session-file",
						"description": "Location of session file",
						"default_value": [
							""
						],
						"choices": null
					}
				],
				"Global Options": [
					{
						"long_name": "kubeconfig",
						"description": "file at which Nerd will look for Kubernetes credentials",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "timeout",
						"description": "duration for which Nerd will wait for Kubernetes",
						"default_value": [
							"10s"
						],
						"choices": null
					}
				],
				"Options": [
					{
						"long_name": "config-src",
						"description": "type of configuration to use (from env, endpoint, or oidc)",
						"default_value": [
							"oidc"
						],
						"choices": null
					}
				]
			}
		},
		"version": {
			"usage": "nerd version",
			"synopsis": "Check the current version of the CLI",
			"description": "Check the current version of the CLI",
			"options": {
				"Global Options": [
					{
						"long_name": "kubeconfig",
						"description": "file at which Nerd will look for Kubernetes credentials",
						"default_value": null,
						"choices": null
					},
					{
						"long_name": "timeout",
						"description": "duration for which Nerd will wait for Kubernetes",
						"default_value": [
							"10s"
						],
						"choices": null
					}
				],
				"Options": []
			}
		}
	}
}