apolo

Usage:

apolo [OPTIONS] COMMAND [ARGS]...

Options:

Name	Description
--help	Show this message and exit.
--color [yes \| no \| auto]	Color mode.
--disable-pypi-version-check	Don't periodically check PyPI to determine whether a new version of Apolo Platform CLI is available for download. [env var: NEURO_CLI_DISABLE_PYPI_VERSION_CHECK]
--hide-token / --no-hide-token	Prevent user's token sent in HTTP headers from being printed out to stderr during HTTP tracing. Can be used only together with option '--trace'. On by default.
--iso-datetime-format / --no-iso-datetime-format	Use ISO 8601 format for printing date and time
--network-timeout FLOAT	Network read timeout, seconds.
--neuromation-config PATH	Path to config directory.
-q, --quiet	Give less output. Option is additive, and can be used up to 2 times.
--show-traceback	Show python traceback on error, useful for debugging the tool.
--skip-stats / --no-skip-stats	Skip sending usage statistics to apolo servers. Note: the statistics has no sensitive data, e.g. file, job, image, or user names, executed command lines, environment variables, etc.
--trace	Trace sent HTTP requests and received replies to stderr.
-v, --verbose	Give more output. Option is additive, and can be used up to 2 times.
--version	Show the version and exit.

Command Groups:

Usage	Description
apolo acl	Access Control List management
apolo admin	Cluster administration commands
apolo blob	Blob storage operations
apolo completion	Output shell completion code
apolo config	Client configuration
apolo disk	Operations with disks
apolo image	Container image operations
apolo job	Job operations
apolo secret	Operations with secrets
apolo service-account	Operations with service accounts
apolo storage	Storage operations

Commands:

Usage	Description
apolo attach	Attach terminal to a job
apolo cp	Copy files and directories
apolo exec	Execute command in a running job
apolo help	Get help on a command
apolo images	List images
apolo kill	Kill job(s)
apolo login	Log into Apolo Platform
apolo logout	Log out
apolo logs	Print the logs for a job
apolo ls	List directory contents
apolo mkdir	Make directories
apolo mv	Move or rename files and directories
apolo port-forward	Forward port(s) of a job
apolo ps	List all jobs
apolo pull	Pull an image from platform registry
apolo push	Push an image to platform registry
apolo rm	Remove files or directories
apolo run	Run a job
apolo save	Save job's state to an image
apolo share	Shares resource with another user
apolo status	Display status of a job
apolo top	Display GPU/CPU/Memory usage

apolo acl

Access Control List management.

Usage:

apolo acl [OPTIONS] COMMAND [ARGS]...

Options:

Name	Description
--help	Show this message and exit.

Commands:

Usage	Description
apolo acl add-role	Add new role
apolo acl grant	Shares resource with another user
apolo acl list-roles	List roles
apolo acl ls	List shared resources
apolo acl remove-role	Remove existing role
apolo acl revoke	Revoke user access from another user

apolo acl add-role

Add new role.

Usage:

apolo acl add-role [OPTIONS] ROLE_NAME

Examples:

apolo acl add-role mycompany/subdivision

Options:

Name	Description
--help	Show this message and exit.

apolo acl grant

Shares resource with another user.

URI shared resource.

USER username to share resource with.

PERMISSION sharing access right: read, write, or manage.

Usage:

apolo acl grant [OPTIONS] URI USER {read|write|manage}

Examples:

apolo acl grant storage:///sample_data/ alice manage
apolo acl grant image:resnet50 bob read
apolo acl grant job:///my_job_id alice write

Options:

Name	Description
--help	Show this message and exit.

apolo acl list-roles

List roles.

Usage:

apolo acl list-roles [OPTIONS]

Examples:

apolo acl list-roles
apolo acl list-roles username/projects

Options:

Name	Description
--help	Show this message and exit.
-u TEXT	Fetch roles of specified user or role.

apolo acl ls

List shared resources.

The command displays a list of resources shared BY current user (default).

To display a list of resources shared WITH current user apply --shared option.

Usage:

apolo acl ls [OPTIONS] [URI]

Examples:

apolo acl list
apolo acl list storage://
apolo acl list --shared
apolo acl list --shared image://

Options:

Name	Description
--help	Show this message and exit.
--full-uri	Output full URI.
--shared	Output the resources shared by the user.
-u TEXT	Use specified user or role.

apolo acl remove-role

Remove existing role.

Usage:

apolo acl remove-role [OPTIONS] ROLE_NAME

Examples:

apolo acl remove-role mycompany/subdivision

Options:

Name	Description
--help	Show this message and exit.

apolo acl revoke

Revoke user access from another user.

URI previously shared resource to revoke.

USER to revoke URI resource from.

Usage:

apolo acl revoke [OPTIONS] URI USER

Examples:

apolo acl revoke storage:///sample_data/ alice
apolo acl revoke image:resnet50 bob
apolo acl revoke job:///my_job_id alice

Options:

Name	Description
--help	Show this message and exit.

apolo admin

Cluster administration commands.

Usage:

apolo admin [OPTIONS] COMMAND [ARGS]...

Options:

Name	Description
--help	Show this message and exit.

Commands:

Usage	Description
apolo admin add-cluster	Create a new cluster
apolo admin add-cluster-user	Add user access to specified cluster
apolo admin add-org	Create a new org
apolo admin add-org-cluster	Add org access to specified cluster
apolo admin add-org-cluster-credits	Add given values to org cluster balance
apolo admin add-org-user	Add user access to specified org
apolo admin add-project	Add new project to specified cluster
apolo admin add-project-user	Add user access to specified project
apolo admin add-resource-preset	Add new resource preset
apolo admin add-user-credits	Add given values to user quota
apolo admin generate-cluster-config	Create a cluster configuration file
apolo admin get-cluster-orgs	Print the list of all orgs in the cluster
apolo admin get-cluster-users	List users in specified cluster
apolo admin get-clusters	Print the list of available clusters
apolo admin get-org-cluster-quota	Get info about org quota in given cluster
apolo admin get-org-users	List users in specified org
apolo admin get-orgs	Print the list of available orgs
apolo admin get-project-users	List users in specified project
apolo admin get-projects	Print the list of all projects in the cluster
apolo admin get-user-quota	Get info about user quota in given cluster
apolo admin remove-cluster	Drop a cluster
apolo admin remove-cluster-user	Remove user access from the cluster
apolo admin remove-org	Drop an org
apolo admin remove-org-cluster	Drop an org cluster
apolo admin remove-org-user	Remove user access from the org
apolo admin remove-project	Drop a project
apolo admin remove-project-user	Remove user access from the project
apolo admin remove-resource-preset	Remove resource preset
apolo admin set-org-cluster-credits	Set org cluster credits to given value
apolo admin set-org-cluster-defaults	Set org cluster defaults to given value
apolo admin set-org-cluster-quota	Set org cluster quota to given values
apolo admin set-user-credits	Set user credits to given value
apolo admin set-user-quota	Set user quota to given values
apolo admin show-cluster-options	Show available cluster options
apolo admin update-cluster	Update a cluster
apolo admin update-cluster-user
apolo admin update-node-pool	Update cluster node pool
apolo admin update-org-cluster	Update org cluster quotas
apolo admin update-project	Update project settings
apolo admin update-project-user	Update user access to specified project
apolo admin update-resource-preset	Update existing resource preset

apolo admin add-cluster

Create a new cluster.

Creates cluster entry on admin side and then start its provisioning using
provided config.

Usage:

apolo admin add-cluster [OPTIONS] CLUSTER_NAME CONFIG

Options:

Name	Description
--help	Show this message and exit.
--default-credits AMOUNT	Default credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-jobs AMOUNT	Default maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--default-role [ROLE]	Default role for new users added to cluster [default: user]

apolo admin add-cluster-user

Add user access to specified cluster.

The command supports one of 3 user roles: admin, manager or user.

Usage:

apolo admin add-cluster-user [OPTIONS] CLUSTER_NAME USER_NAME [ROLE]

Options:

Name	Description
--help	Show this message and exit.
-c, --credits AMOUNT	Credits amount to set (`unlimited' stands for no limit)
-j, --jobs AMOUNT	Maximum running jobs quota (`unlimited' stands for no limit)
--org ORG	org name for org-cluster users

apolo admin add-org

Create a new org.

Usage:

apolo admin add-org [OPTIONS] ORG_NAME

Options:

Name	Description
--help	Show this message and exit.

apolo admin add-org-cluster

Add org access to specified cluster.

Usage:

apolo admin add-org-cluster [OPTIONS] CLUSTER_NAME ORG_NAME

Options:

Name	Description
--help	Show this message and exit.
-c, --credits AMOUNT	Credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-credits AMOUNT	Default credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-jobs AMOUNT	Default maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--default-role [ROLE]	Default role for new users added to org cluster [default: user]
-j, --jobs AMOUNT	Maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--storage-size AMOUNT	Storage size, ignored for storage types with elastic storage size

apolo admin add-org-cluster-credits

Add given values to org cluster balance

Usage:

apolo admin add-org-cluster-credits [OPTIONS] CLUSTER_NAME ORG_NAME

Options:

Name	Description
--help	Show this message and exit.
-c, --credits AMOUNT	Credits amount to add

apolo admin add-org-user

Add user access to specified org.

The command supports one of 3 user roles: admin, manager or user.

Usage:

apolo admin add-org-user [OPTIONS] ORG_NAME USER_NAME [ROLE]

Options:

Name	Description
--help	Show this message and exit.

apolo admin add-project

Add new project to specified cluster.

Usage:

apolo admin add-project [OPTIONS] CLUSTER_NAME NAME

Options:

Name	Description
--help	Show this message and exit.
--default	Is this project is default, e.g. new cluster users will be automatically added to it
--default-role [ROLE]	Default role for new users added to project [default: writer]
--org ORG	org name for org-cluster projects

apolo admin add-project-user

Add user access to specified project.

The command supports one of 4 user roles: reader, writer, manager or admin.

Usage:

apolo admin add-project-user [OPTIONS] CLUSTER_NAME PROJECT_NAME
                                    USER_NAME [ROLE]

Options:

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster projects

apolo admin add-resource-preset

Add new resource preset

Usage:

apolo admin add-resource-preset [OPTIONS] PRESET_NAME

Options:

Name	Description
--help	Show this message and exit.
--amd-gpu NUMBER	Number of AMD GPUs
-c, --cpu NUMBER	Number of CPUs [default: 0.1]
--credits-per-hour AMOUNT	Price of running job of this preset for an hour in credits [default: 0]
--intel-gpu NUMBER	Number of Intel GPUs
-m, --memory AMOUNT	Memory amount [default: 1GB]
-g, --nvidia-gpu NUMBER	Number of Nvidia GPUs
--preemptible-node / --non-preemptible-node	Use a lower-cost preemptible instance [default: non-preemptible-node]
-r, --resource-pool TEXT	Name of the resource pool where job will be scheduled (multiple values are supported)
-p, --scheduler / -P, --no-scheduler	Use round robin scheduler for jobs [default: no-scheduler]
--tpu-sw-version VERSION	TPU software version
--tpu-type TYPE	TPU type

apolo admin add-user-credits

Add given values to user quota

Usage:

apolo admin add-user-credits [OPTIONS] CLUSTER_NAME USER_NAME

Options:

Name	Description
--help	Show this message and exit.
-c, --credits AMOUNT	Credits amount to add [required]
--org ORG	org name for org-cluster users

apolo admin generate-cluster-config

Create a cluster configuration file.

Usage:

apolo admin generate-cluster-config [OPTIONS] [CONFIG]

Options:

Name	Description
--help	Show this message and exit.
--type [aws \| gcp \| azure \| vcd]

apolo admin get-cluster-orgs

Print the list of all orgs in the cluster

Usage:

apolo admin get-cluster-orgs [OPTIONS] CLUSTER_NAME

Options:

Name	Description
--help	Show this message and exit.

apolo admin get-cluster-users

List users in specified cluster

Usage:

apolo admin get-cluster-users [OPTIONS] [CLUSTER_NAME]

Options:

Name	Description
--help	Show this message and exit.
--details / --no-details	Include detailed user info
--org ORG	org name for org-cluster users

apolo admin get-clusters

Print the list of available clusters.

Usage:

apolo admin get-clusters [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.

apolo admin get-org-cluster-quota

Get info about org quota in given cluster

Usage:

apolo admin get-org-cluster-quota [OPTIONS] CLUSTER_NAME ORG_NAME

Options:

Name	Description
--help	Show this message and exit.

apolo admin get-org-users

List users in specified org

Usage:

apolo admin get-org-users [OPTIONS] ORG_NAME

Options:

Name	Description
--help	Show this message and exit.

apolo admin get-orgs

Print the list of available orgs.

Usage:

apolo admin get-orgs [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.

apolo admin get-project-users

List users in specified project

Usage:

apolo admin get-project-users [OPTIONS] CLUSTER_NAME PROJECT_NAME

Options:

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster projects

apolo admin get-projects

Print the list of all projects in the cluster

Usage:

apolo admin get-projects [OPTIONS] CLUSTER_NAME

Options:

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster projects

apolo admin get-user-quota

Get info about user quota in given cluster

Usage:

apolo admin get-user-quota [OPTIONS] CLUSTER_NAME USER_NAME

Options:

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster users

apolo admin remove-cluster

Drop a cluster

Completely removes cluster from the system.

Usage:

apolo admin remove-cluster [OPTIONS] CLUSTER_NAME

Options:

Name	Description
--help	Show this message and exit.
--force	Skip prompt

apolo admin remove-cluster-user

Remove user access from the cluster.

Usage:

apolo admin remove-cluster-user [OPTIONS] CLUSTER_NAME USER_NAME

Options:

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster users

apolo admin remove-org

Drop an org

Completely removes org from the system.

Usage:

apolo admin remove-org [OPTIONS] ORG_NAME

Options:

Name	Description
--help	Show this message and exit.
--force	Skip prompt

apolo admin remove-org-cluster

Drop an org cluster

Completely removes org from the cluster.

Usage:

apolo admin remove-org-cluster [OPTIONS] CLUSTER_NAME ORG_NAME

Options:

Name	Description
--help	Show this message and exit.
--force	Skip prompt

apolo admin remove-org-user

Remove user access from the org.

Usage:

apolo admin remove-org-user [OPTIONS] ORG_NAME USER_NAME

Options:

Name	Description
--help	Show this message and exit.

apolo admin remove-project

Drop a project

Completely removes project from the cluster.

Usage:

apolo admin remove-project [OPTIONS] CLUSTER_NAME NAME

Options:

Name	Description
--help	Show this message and exit.
--force	Skip prompt
--org ORG	org name for org-cluster projects

apolo admin remove-project-user

Remove user access from the project.

Usage:

apolo admin remove-project-user [OPTIONS] CLUSTER_NAME PROJECT_NAME
                                       USER_NAME

Options:

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster projects

apolo admin remove-resource-preset

Remove resource preset

Usage:

apolo admin remove-resource-preset [OPTIONS] PRESET_NAME

Options:

Name	Description
--help	Show this message and exit.

apolo admin set-org-cluster-credits

Set org cluster credits to given value

Usage:

apolo admin set-org-cluster-credits [OPTIONS] CLUSTER_NAME ORG_NAME

Options:

Name	Description
--help	Show this message and exit.
-c, --credits AMOUNT	Credits amount to set (`unlimited' stands for no limit) [required]

apolo admin set-org-cluster-defaults

Set org cluster defaults to given value

Usage:

apolo admin set-org-cluster-defaults [OPTIONS] CLUSTER_NAME ORG_NAME

Options:

Name	Description
--help	Show this message and exit.
--default-credits AMOUNT	Default credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-jobs AMOUNT	Default maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--default-role [ROLE]	Default role for new users added to org cluster [default: user]

apolo admin set-org-cluster-quota

Set org cluster quota to given values

Usage:

apolo admin set-org-cluster-quota [OPTIONS] CLUSTER_NAME ORG_NAME

Options:

Name	Description
--help	Show this message and exit.
-j, --jobs AMOUNT	Maximum running jobs quota (`unlimited' stands for no limit) [required]

apolo admin set-user-credits

Set user credits to given value

Usage:

apolo admin set-user-credits [OPTIONS] CLUSTER_NAME USER_NAME

Options:

Name	Description
--help	Show this message and exit.
-c, --credits AMOUNT	Credits amount to set (`unlimited' stands for no limit) [required]
--org ORG	org name for org-cluster users

apolo admin set-user-quota

Set user quota to given values

Usage:

apolo admin set-user-quota [OPTIONS] CLUSTER_NAME USER_NAME

Options:

Name	Description
--help	Show this message and exit.
-j, --jobs AMOUNT	Maximum running jobs quota (`unlimited' stands for no limit) [required]
--org ORG	org name for org-cluster users

apolo admin show-cluster-options

Show available cluster options.

Usage:

apolo admin show-cluster-options [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.
--type [aws \| gcp \| azure]

apolo admin update-cluster

Update a cluster.

Usage:

apolo admin update-cluster [OPTIONS] CLUSTER_NAME

Options:

Name	Description
--help	Show this message and exit.
--default-credits AMOUNT	Default credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-jobs AMOUNT	Default maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--default-role [ROLE]	Default role for new users added to cluster [default: user]

apolo admin update-cluster-user

Usage:

apolo admin update-cluster-user [OPTIONS] CLUSTER_NAME USER_NAME [ROLE]

Options:

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster users

apolo admin update-node-pool

Update cluster node pool.

Usage:

apolo admin update-node-pool [OPTIONS] CLUSTER_NAME NODE_POOL_NAME

Options:

Name	Description
--help	Show this message and exit.
--idle-size NUMBER	Number of idle nodes in the node pool.

apolo admin update-org-cluster

Update org cluster quotas.

Usage:

apolo admin update-org-cluster [OPTIONS] CLUSTER_NAME ORG_NAME

Options:

Name	Description
--help	Show this message and exit.
-c, --credits AMOUNT	Credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-credits AMOUNT	Default credits amount to set (`unlimited' stands for no limit) [default: unlimited]
--default-jobs AMOUNT	Default maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]
--default-role [ROLE]	Default role for new users added to org cluster [default: user]
-j, --jobs AMOUNT	Maximum running jobs quota (`unlimited' stands for no limit) [default: unlimited]

apolo admin update-project

Update project settings.

Usage:

apolo admin update-project [OPTIONS] CLUSTER_NAME NAME

Options:

Name	Description
--help	Show this message and exit.
--default	Is this project is default, e.g. new cluster users will be automatically added to it
--default-role [ROLE]	Default role for new users added to project [default: writer]
--org ORG	org name for org-cluster projects

apolo admin update-project-user

Update user access to specified project.

The command supports one of 4 user roles: reader, writer, manager or admin.

Usage:

apolo admin update-project-user [OPTIONS] CLUSTER_NAME PROJECT_NAME
                                       USER_NAME [ROLE]

Options:

Name	Description
--help	Show this message and exit.
--org ORG	org name for org-cluster projects

apolo admin update-resource-preset

Update existing resource preset

Usage:

apolo admin update-resource-preset [OPTIONS] PRESET_NAME

Options:

Name	Description
--help	Show this message and exit.
--amd-gpu NUMBER	Number of AMD GPUs
-c, --cpu NUMBER	Number of CPUs
--credits-per-hour AMOUNT	Price of running job of this preset for an hour in credits
--intel-gpu NUMBER	Number of Intel GPUs
-m, --memory AMOUNT	Memory amount
-g, --nvidia-gpu NUMBER	Number of Nvidia GPUs
--preemptible-node / --non-preemptible-node	Use a lower-cost preemptible instance
-r, --resource-pool TEXT	Name of the resource pool where job will be scheduled (multiple values are supported)
-p, --scheduler / -P, --no-scheduler	Use round robin scheduler for jobs
--tpu-sw-version VERSION	TPU software version
--tpu-type TYPE	TPU type

apolo blob

Blob storage operations.

Usage:

apolo blob [OPTIONS] COMMAND [ARGS]...

Options:

Name	Description
--help	Show this message and exit.

Commands:

Usage	Description
apolo blob cp	Copy blobs into and from Blob Storage
apolo blob du	Get storage usage for BUCKET
apolo blob glob	List resources that match PATTERNS
apolo blob importbucket	Import an existing bucket
apolo blob ls	List buckets or bucket contents
apolo blob lsbucket	List buckets
apolo blob lscredentials	List bucket credentials
apolo blob mkbucket	Create a new bucket
apolo blob mkcredentials	Create a new bucket credential
apolo blob rm	Remove blobs from bucket
apolo blob rmbucket	Remove bucket BUCKET
apolo blob rmcredentials	Remove bucket credential BUCKET_CREDENTIAL
apolo blob set-bucket-publicity	Change public access settings for BUCKET
apolo blob sign-url	Make signed url for blob in bucket
apolo blob statbucket	Get bucket BUCKET
apolo blob statcredentials	Get bucket credential BUCKET_CREDENTIAL

apolo blob cp

Copy blobs into and from Blob Storage.

Either SOURCES or DESTINATION should have blob:// scheme. If scheme is
omitted, file:// scheme is assumed. It is currently not possible to copy files
between Blob Storage (blob://) destination, nor with storage:// scheme
paths.

Use /dev/stdin and /dev/stdout file names to upload a file from standard
input or output to stdout.

Any number of --exclude and --include options can be passed. The filters that
appear later in the command take precedence over filters that appear earlier
in the command. If neither --exclude nor --include options are specified the
default can be changed using the storage.cp-exclude configuration variable
documented in "apolo help user-config".

File permissions, modification times and other attributes will not be passed
to Blob Storage metadata during upload.

Usage:

apolo blob cp [OPTIONS] [SOURCES]... [DESTINATION]

Options:

Name	Description
--help	Show this message and exit.
--continue	Continue copying partially-copied files. Only for copying from Blob Storage.
--exclude-from-files FILES	A list of file names that contain patterns for exclusion files and directories. Used only for uploading. The default can be changed using the storage.cp-exclude-from-files configuration variable documented in "apolo help user-config"
--exclude TEXT	Exclude files and directories that match the specified pattern.
--include TEXT	Don't exclude files and directories that match the specified pattern.
--glob / --no-glob	Expand glob patterns in SOURCES with explicit scheme. [default: glob]
-T, --no-target-directory	Treat DESTINATION as a normal file.
-p, --progress / -P, --no-progress	Show progress, on by default.
-r, --recursive	Recursive copy, off by default
-t, --target-directory DIRECTORY	Copy all SOURCES into DIRECTORY.
-u, --update	Copy only when the SOURCE file is newer than the destination file or when the destination file is missing.

apolo blob du

Get storage usage for BUCKET.

Usage:

apolo blob du [OPTIONS] BUCKET

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Look on a specified cluster (the current cluster by default).
--org ORG	Look on a specified org (the current org by default).
--project PROJECT	Look on a specified project (the current project by default).

apolo blob glob

List resources that match PATTERNS.

Usage:

apolo blob glob [OPTIONS] [PATTERNS]...

Options:

Name	Description
--help	Show this message and exit.
--full-uri	Output full bucket URI.

apolo blob importbucket

Import an existing bucket.

Usage:

apolo blob importbucket [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.
--aws-access-key-id AWS_ACCESS_KEY_ID	AWS access_key_id to use to access the bucket. Required when PROVIDER is 'aws'
--aws-endpoint-url AWS_ENDPOINT	AWS endpoint to use to access the bucket. Usually you need to set this if you use non-AWS S3 compatible provider
--aws-region-name AWS_REGION	AWS region to use to access the bucket.
--aws-secret-access-key AWS_SECRET_ACCESS_KEY	AWS secret_access_key to use to access the bucket. Required when PROVIDER is 'aws'
--azure-storage-account-url AZURE_STORAGE_ACCOUNT_URL	Azure account url. Usually it has following format: https://<account_id>.blob.core.windows.net Required when PROVIDER is 'azure'
--azure-storage-credential AZURE_STORAGE_CREDENTIAL	Azure storage credential that grants access to imported bucket. Either this or AZURE_SAS is required when PROVIDER is 'azure'
--azure-storage-sas-token AZURE_SAS	Azure shared access signature token that grants access to imported bucket. Either this or AZURE_STORAGE_CREDENTIAL is required when PROVIDER is 'azure'
--cluster CLUSTER	Perform in a specified cluster (the current cluster by default).
--gcp-sa-credential GCP_SA_CREDNETIAL	GCP service account credential in form of base64 encoded json string that grants access to imported bucket. Required when PROVIDER is 'gcp'
--name NAME	Optional bucket name
--org ORG	Perform in a specified org (the current org by default).
--project PROJECT	Perform in a specified project (the current project by default).
--provider PROVIDER	Bucket provider that hosts bucket [required]
--provider-bucket-name EXTERNAL_NAME	Name of bucket (or container in case of Azure) inside the provider [required]

apolo blob ls

List buckets or bucket contents.

Usage:

apolo blob ls [OPTIONS] [PATHS]...

Options:

Name	Description
--help	Show this message and exit.
-l	use a long listing format.
--full-uri	Output full bucket URI.
-h, --human-readable	with -l print human readable sizes (e.g., 2K, 540M).
-r, --recursive	List all keys under the URL path provided, not just 1 level depths.

apolo blob lsbucket

List buckets.

Usage:

apolo blob lsbucket [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.
--all-orgs	Show buckets in all orgs.
--all-projects	Show buckets in all projects.
--cluster CLUSTER	Look on a specified cluster (the current cluster by default).
--full-uri	Output full bucket URI.
--long-format	Output all info about bucket.
--org ORG	Look on a specified org (the current org by default).
--project PROJECT	Look on a specified project (the current project by default).

apolo blob lscredentials

List bucket credentials.

Usage:

apolo blob lscredentials [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Look on a specified cluster (the current cluster by default).

apolo blob mkbucket

Create a new bucket.

Usage:

apolo blob mkbucket [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Perform in a specified cluster (the current cluster by default).
--name NAME	Optional bucket name
--org ORG	Perform in a specified org (the current org by default).
--project PROJECT	Perform in a specified project (the current project by default).

apolo blob mkcredentials

Create a new bucket credential.

Usage:

apolo blob mkcredentials [OPTIONS] BUCKETS...

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Perform in a specified cluster (the current cluster by default).
--name NAME	Optional bucket credential name
--org ORG	Perform in a specified org (the current org by default).
--project PROJECT	Perform in a specified project (the current project by default).
--read-only	Make read-only credential

apolo blob rm

Remove blobs from bucket.

Usage:

apolo blob rm [OPTIONS] PATHS...

Options:

Name	Description
--help	Show this message and exit.
--glob / --no-glob	Expand glob patterns in PATHS [default: glob]
-p, --progress / -P, --no-progress	Show progress, on by default in TTY mode, off otherwise.
-r, --recursive	remove directories and their contents recursively

apolo blob rmbucket

Remove bucket BUCKET.

Usage:

apolo blob rmbucket [OPTIONS] BUCKETS...

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Perform on a specified cluster (the current cluster by default).
-f, --force	Force removal of all blobs inside bucket
--org ORG	Perform on a specified org (the current org by default).
--project PROJECT	Perform on a specified project (the current project by default).

apolo blob rmcredentials

Remove bucket credential BUCKET_CREDENTIAL.

Usage:

apolo blob rmcredentials [OPTIONS] CREDENTIALS...

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Perform on a specified cluster (the current cluster by default).

apolo blob set-bucket-publicity

Change public access settings for BUCKET

Usage:

apolo blob set-bucket-publicity [OPTIONS] BUCKET {public|private}

Examples:

apolo blob set-bucket-publicity my-bucket public
apolo blob set-bucket-publicity my-bucket private

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Perform on a specified cluster (the current cluster by default).
--org ORG	Perform on a specified org (the current org by default).
--project PROJECT	Perform on a specified project (the current project by default).

apolo blob sign-url

Make signed url for blob in bucket.

Usage:

apolo blob sign-url [OPTIONS] PATH

Options:

Name	Description
--help	Show this message and exit.
--expires TIMEDELTA	Duration this signature will be valid in the format '1h2m3s' [default: 1h]

apolo blob statbucket

Get bucket BUCKET.

Usage:

apolo blob statbucket [OPTIONS] BUCKET

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Look on a specified cluster (the current cluster by default).
--full-uri	Output full bucket URI.
--org ORG	Look on a specified org (the current org by default).
--project PROJECT	Look on a specified project (the current project by default).

apolo blob statcredentials

Get bucket credential BUCKET_CREDENTIAL.

Usage:

apolo blob statcredentials [OPTIONS] BUCKET_CREDENTIAL

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Look on a specified cluster (the current cluster by default).

apolo completion

Output shell completion code.

Usage:

apolo completion [OPTIONS] COMMAND [ARGS]...

Options:

Name	Description
--help	Show this message and exit.

Commands:

Usage	Description
apolo completion generate	Show instructions for shell completion
apolo completion patch	Patch shell profile to enable completion

apolo completion generate

Show instructions for shell completion.

Usage:

apolo completion generate [OPTIONS] {bash|zsh}

Options:

Name	Description
--help	Show this message and exit.

apolo completion patch

Patch shell profile to enable completion

Patches shell configuration while depending of current shell. Files patched:

bash: ~/.bashrc zsh: ~/.zshrc

Usage:

apolo completion patch [OPTIONS] {bash|zsh}

Options:

Name	Description
--help	Show this message and exit.

apolo config

Client configuration.

Usage:

apolo config [OPTIONS] COMMAND [ARGS]...

Options:

Name	Description
--help	Show this message and exit.

Commands:

Usage	Description
apolo config aliases	List available command aliases
apolo config docker	Configure local docker client
apolo config get-clusters	List available clusters/org pairs
apolo config login	Log into Apolo Platform
apolo config login-headless	Log into Apolo Platform in non-GUI environ
apolo config login-with-token	Log into Apolo Platform with token
apolo config logout	Log out
apolo config show	Print current settings
apolo config show-token	Print current authorization token
apolo config switch-cluster	Switch the active cluster
apolo config switch-org	Switch the active organization
apolo config switch-project	Switch the active project

apolo config aliases

List available command aliases.

Usage:

apolo config aliases [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.

apolo config docker

Configure local docker client

This command configures local docker client to use Apolo Platform's docker
registry.

Usage:

apolo config docker [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.
--docker-config PATH	Specifies the location of the Docker client configuration files

apolo config get-clusters

List available clusters/org pairs.

This command re-fetches cluster list and then displays each cluster with
available orgs.

Usage:

apolo config get-clusters [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.

apolo config login

Log into Apolo Platform.

URL is a platform entrypoint URL.

Usage:

apolo config login [OPTIONS] [URL]

Options:

Name	Description
--help	Show this message and exit.

apolo config login-headless

Log into Apolo Platform in non-GUI environ

URL is a platform entrypoint URL.

The command works similar to "apolo login" but instead of opening a browser
for performing OAuth registration prints an URL that should be open on guest
host.

Then user inputs a code displayed in a browser after successful login back in
apolo command to finish the login process.

Usage:

apolo config login-headless [OPTIONS] [URL]

Options:

Name	Description
--help	Show this message and exit.

apolo config login-with-token

Log into Apolo Platform with token.

TOKEN is authentication token provided by administration team. URL is a
platform entrypoint URL.

Usage:

apolo config login-with-token [OPTIONS] TOKEN [URL]

Options:

Name	Description
--help	Show this message and exit.

apolo config logout

Log out.

Usage:

apolo config logout [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.

apolo config show

Print current settings.

Usage:

apolo config show [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.
--energy	Including cluster energy consumption and CO2 emissions information

apolo config show-token

Print current authorization token.

Usage:

apolo config show-token [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.

apolo config switch-cluster

Switch the active cluster.

CLUSTER_NAME is the cluster name to select. The interactive prompt is used if
the name is omitted (default).

Usage:

apolo config switch-cluster [OPTIONS] [CLUSTER_NAME]

Options:

Name	Description
--help	Show this message and exit.

apolo config switch-org

Switch the active organization.

ORG_NAME is the organization name to select.

Usage:

apolo config switch-org [OPTIONS] ORG_NAME

Options:

Name	Description
--help	Show this message and exit.

apolo config switch-project

Switch the active project.

PROJECT_NAME is the project name to select. The interactive prompt is used if
the name is omitted (default).

Usage:

apolo config switch-project [OPTIONS] [PROJECT_NAME]

Options:

Name	Description
--help	Show this message and exit.

apolo disk

Operations with disks.

Usage:

apolo disk [OPTIONS] COMMAND [ARGS]...

Options:

Name	Description
--help	Show this message and exit.

Commands:

Usage	Description
apolo disk create	Create a disk
apolo disk get	Get disk DISK_ID
apolo disk ls	List disks
apolo disk rm	Remove disk DISK_ID

apolo disk create

Create a disk

Create a disk with at least storage amount STORAGE.

To specify the amount, you can use the following suffixes: "kKMGTPEZY" To use
decimal quantities, append "b" or "B". For example: - 1K or 1k is 1024 bytes -
1Kb or 1KB is 1000 bytes - 20G is 20 * 2 ^ 30 bytes - 20Gb or 20GB is
20.000.000.000 bytes

Note that server can have big granularity (for example, 1G) so it will
possibly round-up the amount you requested.

Usage:

apolo disk create [OPTIONS] STORAGE

Examples:

apolo disk create 10G
apolo disk create 500M

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Perform in a specified cluster (the current cluster by default).
--name NAME	Optional disk name
--org ORG	Perform in a specified org (the current org by default).
--project PROJECT	Create disk in a specified project (the current project by default).
--timeout-unused TIMEDELTA	Optional disk lifetime limit after last usage in the format '1d2h3m4s' (some parts may be missing). Set '0' to disable. Default value '1d' can be changed in the user config.

apolo disk get

Get disk DISK_ID.

Usage:

apolo disk get [OPTIONS] DISK

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Look on a specified cluster (the current cluster by default).
--full-uri	Output full disk URI.
--org ORG	Look on a specified org (the current org by default).
--project PROJECT	Look on a specified project (the current project by default).

apolo disk ls

List disks.

Usage:

apolo disk ls [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.
--all-orgs	Show disks in all orgs.
--all-projects	Show disks in all projects.
--cluster CLUSTER	Look on a specified cluster (the current cluster by default).
--full-uri	Output full disk URI.
--long-format	Output all info about disk.
--org ORG	Look on a specified org (the current org by default).
--project PROJECT	Look on a specified project (the current project by default).

apolo disk rm

Remove disk DISK_ID.

Usage:

apolo disk rm [OPTIONS] DISKS...

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Perform on a specified cluster (the current cluster by default).
--org ORG	Perform on a specified org (the current org by default).
--project PROJECT	Perform on a specified project (the current project by default).

apolo image

Container image operations.

Usage:

apolo image [OPTIONS] COMMAND [ARGS]...

Options:

Name	Description
--help	Show this message and exit.

Commands:

Usage	Description
apolo image digest	Get digest of an image from remote registry
apolo image ls	List images
apolo image pull	Pull an image from platform registry
apolo image push	Push an image to platform registry
apolo image rm	Remove image from platform registry
apolo image size	Get image size
apolo image tags	List tags for image in platform registry

apolo image digest

Get digest of an image from remote registry

Image name must be URL with image:// scheme. Image name must contain tag.

Usage:

apolo image digest [OPTIONS] IMAGE

Examples:

apolo image digest image:/other-project/alpine:shared
apolo image digest image:myimage:latest

Options:

Name	Description
--help	Show this message and exit.

apolo image ls

List images.

Usage:

apolo image ls [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.
--all-orgs	Show images in all orgs.
--all-projects	Show images in all projects.
--cluster CLUSTER	Show images on a specified cluster (the current cluster by default).
-l	List in long format.
--full-uri	Output full image URI.
-n, --name PATTERN	Filter out images by name regex.
--org ORG	Filter out images by org (multiple option, the current org by default).
--project PROJECT	Filter out images by project (multiple option, the current project by default).

apolo image pull

Pull an image from platform registry.

Remote image name must be URL with image:// scheme. Image names can contain
tag.

Usage:

apolo image pull [OPTIONS] REMOTE_IMAGE [LOCAL_IMAGE]

Examples:

apolo pull image:myimage
apolo pull image:/other-project/alpine:shared
apolo pull image:/project/my-alpine:production alpine:from-registry

Options:

Name	Description
--help	Show this message and exit.

apolo image push

Push an image to platform registry.

Remote image must be URL with image:// scheme. Image names can contain tag. If
tags not specified 'latest' will be used as value.

Usage:

apolo image push [OPTIONS] LOCAL_IMAGE [REMOTE_IMAGE]

Examples:

apolo push myimage
apolo push alpine:latest image:my-alpine:production
apolo push alpine image:/other-project/alpine:shared

Options:

Name	Description
--help	Show this message and exit.

apolo image rm

Remove image from platform registry.

Image name must be URL with image:// scheme. Image name must contain tag.

Usage:

apolo image rm [OPTIONS] IMAGES...

Examples:

apolo image rm image:/other-project/alpine:shared
apolo image rm image:myimage:latest

Options:

Name	Description
--help	Show this message and exit.
-f	Force deletion of all tags referencing the image.

apolo image size

Get image size

Image name must be URL with image:// scheme. Image name must contain tag.

Usage:

apolo image size [OPTIONS] IMAGE

Examples:

apolo image size image:/other-project/alpine:shared
apolo image size image:myimage:latest

Options:

Name	Description
--help	Show this message and exit.

apolo image tags

List tags for image in platform registry.

Image name must be URL with image:// scheme.

Usage:

apolo image tags [OPTIONS] IMAGE

Examples:

apolo image tags image:/other-project/alpine
apolo image tags -l image:myimage

Options:

Name	Description
--help	Show this message and exit.
-l	List in long format, with image sizes.

apolo job

Job operations.

Usage:

apolo job [OPTIONS] COMMAND [ARGS]...

Options:

Name	Description
--help	Show this message and exit.

Commands:

Usage	Description
apolo job attach	Attach terminal to a job
apolo job browse	Opens a job's URL in a web browser
apolo job bump-life-span	Increase job life span
apolo job exec	Execute command in a running job
apolo job generate-run-command	Generate command that will rerun given job
apolo job kill	Kill job(s)
apolo job logs	Print the logs for a job
apolo job ls	List all jobs
apolo job port-forward	Forward port(s) of a job
apolo job run	Run a job
apolo job save	Save job's state to an image
apolo job status	Display status of a job
apolo job top	Display GPU/CPU/Memory usage

apolo job attach

Attach terminal to a job

Attach local standard input, output, and error streams to a running job.

Usage:

apolo job attach [OPTIONS] JOB

Options:

Name	Description
--help	Show this message and exit.
--port-forward LOCAL_PORT:REMOTE_RORT	Forward port(s) of a running job to local port(s) (use multiple times for forwarding several ports)

apolo job browse

Opens a job's URL in a web browser.

Usage:

apolo job browse [OPTIONS] JOB

Options:

Name	Description
--help	Show this message and exit.

apolo job bump-life-span

Increase job life span

Usage:

apolo job bump-life-span [OPTIONS] JOB TIMEDELTA

Options:

Name	Description
--help	Show this message and exit.

apolo job exec

Execute command in a running job.

Usage:

apolo job exec [OPTIONS] JOB -- CMD...

Examples:

# Provides a shell to the container:
apolo exec my-job -- /bin/bash

# Executes a single command in the container and returns the control:
apolo exec --no-tty my-job -- ls -l

Options:

Name	Description
--help	Show this message and exit.
-t, --tty / -T, --no-tty	Allocate a TTY, can be useful for interactive jobs. By default is on if the command is executed from a terminal, non-tty mode is used if executed from a script.

apolo job generate-run-command

Generate command that will rerun given job.

Usage:

apolo job generate-run-command [OPTIONS] JOB

Examples:

# You can use the following to directly re-execute it:
eval $(apolo job generate-run-command <job-id>)

Options:

Name	Description
--help	Show this message and exit.

apolo job kill

Kill job(s).

Usage:

apolo job kill [OPTIONS] JOBS...

Options:

Name	Description
--help	Show this message and exit.

apolo job logs

Print the logs for a job.

Usage:

apolo job logs [OPTIONS] JOB

Options:

Name	Description
--help	Show this message and exit.
--since DATE_OR_TIMEDELTA	Only return logs after a specific date (including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.
--timestamps	Include timestamps on each line in the log output.

apolo job ls

List all jobs.

Usage:

apolo job ls [OPTIONS]

Examples:

apolo ps -a
apolo ps -a --owner=user-1 --owner=user-2
apolo ps --name my-experiments-v1 -s failed -s succeeded
apolo ps --description=my favourite job
apolo ps -s failed -s succeeded -q
apolo ps -t tag1 -t tag2

Options:

Name	Description
--help	Show this message and exit.
-a, --all	Show all jobs regardless the status.
--all-orgs	Show jobs in all orgs.
--all-projects	Show jobs in all projects.
--cluster CLUSTER	Show jobs on a specified cluster (the current cluster by default).
-d, --description DESCRIPTION	Filter out jobs by description (exact match).
--distinct	Show only first job if names are same.
--format COLUMNS	Output table format, see "apolo help ps-format" for more info about the format specification. The default can be changed using the job.ps-format configuration variable documented in "apolo help user-config"
--full-uri	Output full image URI.
-n, --name NAME	Filter out jobs by name.
--org ORG	Filter out jobs by org name (multiple option, the current org by default).
-o, --owner TEXT	Filter out jobs by owner (multiple option). Supports `ME` option to filter by the current user.
-p, --project PROJECT	Filter out jobs by project name (multiple option, the current project by default).
--recent-first / --recent-last	Show newer jobs first or last
--since DATE_OR_TIMEDELTA	Show jobs created after a specific date (including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.
-s, --status [pending \| suspended \| running \| succeeded \| failed \| cancelled]	Filter out jobs by status (multiple option).
-t, --tag TAG	Filter out jobs by tag (multiple option)
--until DATE_OR_TIMEDELTA	Show jobs created before a specific date (including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.
-w, --wide	Do not cut long lines for terminal width.

apolo job port-forward

Forward port(s) of a job.

Forwards port(s) of a running job to local port(s).

Usage:

apolo job port-forward [OPTIONS] JOB LOCAL_PORT:REMOTE_RORT...

Examples:

# Forward local port 2080 to port 80 of job's container.
# You can use http://localhost:2080 in browser to access job's served http
apolo job port-forward my-fastai-job 2080:80

# Forward local port 2222 to job's port 22
# Then copy all data from container's folder '/data' to current folder
# (please run second command in other terminal)
apolo job port-forward my-job-with-ssh-server 2222:22
rsync -avxzhe ssh -p 2222 root@localhost:/data .

# Forward few ports at once
apolo job port-forward my-job 2080:80 2222:22 2000:100

Options:

Name	Description
--help	Show this message and exit.

apolo job run

Run a job

IMAGE docker image name to run in a job.

CMD list will be passed as arguments to the executed job's image.

Usage:

apolo job run [OPTIONS] IMAGE [-- CMD...]

Examples:

# Starts a container pytorch/pytorch:latest on a machine with smaller GPU resources
# (see exact values in `apolo config show`) and with two volumes mounted:
#   storage:/<home-directory>   --> /var/storage/home (in read-write mode),
#   storage:/neuromation/public --> /var/storage/neuromation (in read-only mode).
apolo run --preset=gpu-small --volume=storage::/var/storage/home:rw \
--volume=storage:/neuromation/public:/var/storage/home:ro pytorch/pytorch:latest

# Starts a container using the custom image my-ubuntu:latest stored in apolo
# registry, run /script.sh and pass arg1 and arg2 as its arguments:
apolo run -s cpu-small --entrypoint=/script.sh image:my-ubuntu:latest -- arg1 arg2

Options:

Name	Description
--help	Show this message and exit.
--browse	Open a job's URL in a web browser
--cluster CLUSTER	Run job in a specified cluster
-d, --description DESC	Optional job description in free format
--detach	Don't attach to job logs and don't wait for exit code
--energy-schedule NAME	Run job only within a selected energy schedule. Selected preset should have scheduler enabled.
--entrypoint TEXT	Executable entrypoint in the container (note that it overwrites `ENTRYPOINT` and `CMD` instructions of the docker image)
-e, --env VAR=VAL	Set environment variable in container. Use multiple options to define more than one variable. See `apolo help secrets` for information about passing secrets as environment variables.
--env-file PATH	File with environment variables to pass
-x, --extshm / -X, --no-extshm	Request extended '/dev/shm' space [default: x]
--http-auth / --no-http-auth	Enable HTTP authentication for forwarded HTTP port [default: True]
--http-port PORT	Enable HTTP port forwarding to container [default: 80]
--life-span TIMEDELTA	Optional job run-time limit in the format '1d2h3m4s' (some parts may be missing). Set '0' to disable. Default value '1d' can be changed in the user config.
-n, --name NAME	Optional job name
--org ORG	Run job in a specified org
--pass-config / --no-pass-config	Upload apolo config to the job [default: no-pass-config]
--port-forward LOCAL_PORT:REMOTE_RORT	Forward port(s) of a running job to local port(s) (use multiple times for forwarding several ports)
-s, --preset PRESET	Predefined resource configuration (to see available values, run `apolo config show`)
--priority [low \| normal \| high]	Priority used to specify job's start order. Jobs with higher priority will start before ones with lower priority. Priority should be supported by cluster.
--privileged	Run job in privileged mode, if it is supported by cluster.
-p, --project PROJECT	Run job in a specified project.
--restart [never \| on-failure \| always]	Restart policy to apply when a job exits [default: never]
--schedule-timeout TIMEDELTA	Optional job schedule timeout in the format '3m4s' (some parts may be missing).
--share USER	Share job write permissions to user or role.
--tag TAG	Optional job tag, multiple values allowed
-t, --tty / -T, --no-tty	Allocate a TTY, can be useful for interactive jobs. By default is on if the command is executed from a terminal, non-tty mode is used if executed from a script.
-v, --volume MOUNT	Mounts directory from vault into container. Use multiple options to mount more than one volume. See `apolo help secrets` for information about passing secrets as mounted files.
--wait-for-seat / --no-wait-for-seat	Wait for total running jobs quota [default: no-wait-for-seat]
--wait-start / --no-wait-start	Wait for a job start or failure [default: wait-start]
-w, --workdir TEXT	Working directory inside the container

apolo job save

Save job's state to an image.

Usage:

apolo job save [OPTIONS] JOB IMAGE

Examples:

apolo job save job-id image:ubuntu-patched
apolo job save my-favourite-job image:ubuntu-patched:v1
apolo job save my-favourite-job image://bob/ubuntu-patched

Options:

Name	Description
--help	Show this message and exit.

apolo job status

Display status of a job.

Usage:

apolo job status [OPTIONS] JOB

Options:

Name	Description
--help	Show this message and exit.
--full-uri	Output full URI.

apolo job top

Display GPU/CPU/Memory usage.

Usage:

apolo job top [OPTIONS] [JOBS]...

Examples:

apolo top
apolo top job-1 job-2
apolo top --owner=user-1 --owner=user-2
apolo top --name my-experiments-v1
apolo top -t tag1 -t tag2

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Show jobs on a specified cluster (the current cluster by default).
-d, --description DESCRIPTION	Filter out jobs by description (exact match).
--format COLUMNS	Output table format, see "apolo help top-format" for more info about the format specification. The default can be changed using the job.top-format configuration variable documented in "apolo help user-config"
--full-uri	Output full image URI.
-n, --name NAME	Filter out jobs by name.
-o, --owner TEXT	Filter out jobs by owner (multiple option). Supports `ME` option to filter by the current user. Specify `ALL` to show jobs of all users.
-p, --project PROJECT	Filter out jobs by project name (multiple option).
--since DATE_OR_TIMEDELTA	Show jobs created after a specific date (including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.
--sort COLUMNS	Sort rows by specified column. Add "-" prefix to revert the sorting order. Multiple columns can be specified (comma separated). [default: cpu]
-t, --tag TAG	Filter out jobs by tag (multiple option)
--timeout FLOAT	Maximum allowed time for executing the command, 0 for no timeout [default: 0]
--until DATE_OR_TIMEDELTA	Show jobs created before a specific date (including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.

apolo secret

Operations with secrets.

Usage:

apolo secret [OPTIONS] COMMAND [ARGS]...

Options:

Name	Description
--help	Show this message and exit.

Commands:

Usage	Description
apolo secret add	Add secret KEY with data VALUE
apolo secret ls	List secrets
apolo secret rm	Remove secret KEY

apolo secret add

Add secret KEY with data VALUE.

If VALUE starts with @ it points to a file with secrets content.

Usage:

apolo secret add [OPTIONS] KEY VALUE

Examples:

apolo secret add KEY_NAME VALUE
apolo secret add KEY_NAME @path/to/file.txt

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Perform on a specified cluster (the current cluster by default).
--org ORG	Look on a specified org (the current org by default).
--project PROJECT	Look on a specified project (the current project by default).

apolo secret ls

List secrets.

Usage:

apolo secret ls [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.
--all-orgs	Show secrets in all orgs.
--all-projects	Show secrets in all projects.
--cluster CLUSTER	Look on a specified cluster (the current cluster by default).
--full-uri	Output full secret URI.
--org ORG	Look on a specified org (the current org by default).
--project PROJECT	Look on a specified project (the current project by default).

apolo secret rm

Remove secret KEY.

Usage:

apolo secret rm [OPTIONS] KEY

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Perform on a specified cluster (the current cluster by default).
--org ORG	Look on a specified org (the current org by default).
--project PROJECT	Look on a specified project (the current project by default).

apolo service-account

Operations with service accounts.

Usage:

apolo service-account [OPTIONS] COMMAND [ARGS]...

Options:

Name	Description
--help	Show this message and exit.

Commands:

Usage	Description
apolo service-account create	Create a service account
apolo service-account get	Get service account SERVICE_ACCOUNT
apolo service-account ls	List service accounts
apolo service-account rm	Remove service accounts SERVICE_ACCOUNT

apolo service-account create

Create a service account.

Usage:

apolo service-account create [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.
--default-cluster CLUSTER	Service account default cluster. Current cluster will be used if not specified
--default-org ORG	Service account default organization. Current org will be used if not specified
--default-project PROJECT	Service account default project. Current project will be used if not specified
--name NAME	Optional service account name

apolo service-account get

Get service account SERVICE_ACCOUNT.

Usage:

apolo service-account get [OPTIONS] SERVICE_ACCOUNT

Options:

Name	Description
--help	Show this message and exit.

apolo service-account ls

List service accounts.

Usage:

apolo service-account ls [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.

apolo service-account rm

Remove service accounts SERVICE_ACCOUNT.

Usage:

apolo service-account rm [OPTIONS] SERVICE_ACCOUNTS...

Options:

Name	Description
--help	Show this message and exit.

apolo storage

Storage operations.

Usage:

apolo storage [OPTIONS] COMMAND [ARGS]...

Options:

Name	Description
--help	Show this message and exit.

Commands:

Usage	Description
apolo storage cp	Copy files and directories
apolo storage df	Show current storage usage
apolo storage glob	List resources that match PATTERNS
apolo storage ls	List directory contents
apolo storage mkdir	Make directories
apolo storage mv	Move or rename files and directories
apolo storage rm	Remove files or directories
apolo storage tree	List storage in a tree-like format

apolo storage cp

Copy files and directories.

Either SOURCES or DESTINATION should have storage:// scheme. If scheme is
omitted, file:// scheme is assumed.

Use /dev/stdin and /dev/stdout file names to copy a file from terminal and
print the content of file on the storage to console.

Any number of --exclude and --include options can be passed. The filters that
appear later in the command take precedence over filters that appear earlier
in the command. If neither --exclude nor --include options are specified the
default can be changed using the storage.cp-exclude configuration variable
documented in "apolo help user-config".

Usage:

apolo storage cp [OPTIONS] [SOURCES]... [DESTINATION]

Examples:

# copy local files into remote storage root
apolo cp foo.txt bar/baz.dat storage:
apolo cp foo.txt bar/baz.dat -t storage:

# copy local directory `foo` into existing remote directory `bar`
apolo cp -r foo -t storage:bar

# copy the content of local directory `foo` into existing remote
# directory `bar`
apolo cp -r -T storage:foo storage:bar

# download remote file `foo.txt` into local file `/tmp/foo.txt` with
# explicit file:// scheme set
apolo cp storage:foo.txt file:///tmp/foo.txt
apolo cp -T storage:foo.txt file:///tmp/foo.txt
apolo cp storage:foo.txt file:///tmp
apolo cp storage:foo.txt -t file:///tmp

# download other project's remote file into the current directory
apolo cp storage:/{project}/foo.txt .

# download only files with extension `.out` into the current directory
apolo cp storage:results/*.out .

Options:

Name	Description
--help	Show this message and exit.
--continue	Continue copying partially-copied files.
--exclude-from-files FILES	A list of file names that contain patterns for exclusion files and directories. Used only for uploading. The default can be changed using the storage.cp-exclude-from-files configuration variable documented in "apolo help user-config"
--exclude TEXT	Exclude files and directories that match the specified pattern.
--include TEXT	Don't exclude files and directories that match the specified pattern.
--glob / --no-glob	Expand glob patterns in SOURCES with explicit scheme. [default: glob]
-T, --no-target-directory	Treat DESTINATION as a normal file.
-p, --progress / -P, --no-progress	Show progress, on by default in TTY mode, off otherwise.
-r, --recursive	Recursive copy, off by default
-t, --target-directory DIRECTORY	Copy all SOURCES into DIRECTORY.
-u, --update	Copy only when the SOURCE file is newer than the destination file or when the destination file is missing.

apolo storage df

Show current storage usage.

If PATH is specified, show storage usage of which path is a part.

Usage:

apolo storage df [OPTIONS] [PATH]

Options:

Name	Description
--help	Show this message and exit.

apolo storage glob

List resources that match PATTERNS.

Usage:

apolo storage glob [OPTIONS] [PATTERNS]...

Options:

Name	Description
--help	Show this message and exit.

apolo storage ls

List directory contents.

By default PATH is equal project's dir (storage:)

Usage:

apolo storage ls [OPTIONS] [PATHS]...

Options:

Name	Description
--help	Show this message and exit.
-d, --directory	list directories themselves, not their contents.
-l	use a long listing format.
-h, --human-readable	with -l print human readable sizes (e.g., 2K, 540M).
-a, --all	do not ignore entries starting with .
--sort [name \| size \| time]	sort by given field, default is name.

apolo storage mkdir

Make directories.

Usage:

apolo storage mkdir [OPTIONS] PATHS...

Options:

Name	Description
--help	Show this message and exit.
-p, --parents	No error if existing, make parent directories as needed

apolo storage mv

Move or rename files and directories.

SOURCE must contain path to the file or directory existing on the storage, and
DESTINATION must contain the full path to the target file or directory.

Usage:

apolo storage mv [OPTIONS] [SOURCES]... [DESTINATION]

Examples:

# move and rename remote file
apolo mv storage:foo.txt storage:bar/baz.dat
apolo mv -T storage:foo.txt storage:bar/baz.dat

# move remote files into existing remote directory
apolo mv storage:foo.txt storage:bar/baz.dat storage:dst
apolo mv storage:foo.txt storage:bar/baz.dat -t storage:dst

# move the content of remote directory into other existing
# remote directory
apolo mv -T storage:foo storage:bar

# move remote file into other project's directory
apolo mv storage:foo.txt storage:/{project}/bar.dat

# move remote file from other project's directory
apolo mv storage:/{project}/foo.txt storage:bar.dat

Options:

Name	Description
--help	Show this message and exit.
--glob / --no-glob	Expand glob patterns in SOURCES [default: glob]
-T, --no-target-directory	Treat DESTINATION as a normal file
-t, --target-directory DIRECTORY	Copy all SOURCES into DIRECTORY

apolo storage rm

Remove files or directories.

Usage:

apolo storage rm [OPTIONS] PATHS...

Examples:

apolo rm storage:foo/bar
apolo rm storage:/{project}/foo/bar
apolo rm storage://{cluster}/{project}/foo/bar
apolo rm --recursive storage:/{project}/foo/
apolo rm storage:foo/**/*.tmp

Options:

Name	Description
--help	Show this message and exit.
--glob / --no-glob	Expand glob patterns in PATHS [default: glob]
-p, --progress / -P, --no-progress	Show progress, on by default in TTY mode, off otherwise.
-r, --recursive	remove directories and their contents recursively

apolo storage tree

List storage in a tree-like format

Tree is a recursive directory listing program that produces a depth indented
listing of files, which is colorized ala dircolors if the LS_COLORS
environment variable is set and output is to tty. With no arguments, tree
lists the files in the storage: directory. When directory arguments are
given, tree lists all the files and/or directories found in the given
directories each in turn. Upon completion of listing all files/directories
found, tree returns the total number of files and/or directories listed.

By default PATH is equal project's dir (storage:)

Usage:

apolo storage tree [OPTIONS] [PATH]

Options:

Name	Description
--help	Show this message and exit.
-h, --human-readable	Print the size in a more human readable way.
-a, --all	do not ignore entries starting with .
-s, --size	Print the size in bytes of each file.
--sort [name \| size \| time]	sort by given field, default is name

apolo attach

Attach terminal to a job

Attach local standard input, output, and error streams to a running job.

Usage:

apolo attach [OPTIONS] JOB

Options:

Name	Description
--help	Show this message and exit.
--port-forward LOCAL_PORT:REMOTE_RORT	Forward port(s) of a running job to local port(s) (use multiple times for forwarding several ports)

apolo cp

Copy files and directories.

Either SOURCES or DESTINATION should have storage:// scheme. If scheme is
omitted, file:// scheme is assumed.

Use /dev/stdin and /dev/stdout file names to copy a file from terminal and
print the content of file on the storage to console.

Any number of --exclude and --include options can be passed. The filters that
appear later in the command take precedence over filters that appear earlier
in the command. If neither --exclude nor --include options are specified the
default can be changed using the storage.cp-exclude configuration variable
documented in "apolo help user-config".

Usage:

apolo cp [OPTIONS] [SOURCES]... [DESTINATION]

Examples:

# copy local files into remote storage root
apolo cp foo.txt bar/baz.dat storage:
apolo cp foo.txt bar/baz.dat -t storage:

# copy local directory `foo` into existing remote directory `bar`
apolo cp -r foo -t storage:bar

# copy the content of local directory `foo` into existing remote
# directory `bar`
apolo cp -r -T storage:foo storage:bar

# download remote file `foo.txt` into local file `/tmp/foo.txt` with
# explicit file:// scheme set
apolo cp storage:foo.txt file:///tmp/foo.txt
apolo cp -T storage:foo.txt file:///tmp/foo.txt
apolo cp storage:foo.txt file:///tmp
apolo cp storage:foo.txt -t file:///tmp

# download other project's remote file into the current directory
apolo cp storage:/{project}/foo.txt .

# download only files with extension `.out` into the current directory
apolo cp storage:results/*.out .

Options:

Name	Description
--help	Show this message and exit.
--continue	Continue copying partially-copied files.
--exclude-from-files FILES	A list of file names that contain patterns for exclusion files and directories. Used only for uploading. The default can be changed using the storage.cp-exclude-from-files configuration variable documented in "apolo help user-config"
--exclude TEXT	Exclude files and directories that match the specified pattern.
--include TEXT	Don't exclude files and directories that match the specified pattern.
--glob / --no-glob	Expand glob patterns in SOURCES with explicit scheme. [default: glob]
-T, --no-target-directory	Treat DESTINATION as a normal file.
-p, --progress / -P, --no-progress	Show progress, on by default in TTY mode, off otherwise.
-r, --recursive	Recursive copy, off by default
-t, --target-directory DIRECTORY	Copy all SOURCES into DIRECTORY.
-u, --update	Copy only when the SOURCE file is newer than the destination file or when the destination file is missing.

apolo exec

Execute command in a running job.

Usage:

apolo exec [OPTIONS] JOB -- CMD...

Examples:

# Provides a shell to the container:
apolo exec my-job -- /bin/bash

# Executes a single command in the container and returns the control:
apolo exec --no-tty my-job -- ls -l

Options:

Name	Description
--help	Show this message and exit.
-t, --tty / -T, --no-tty	Allocate a TTY, can be useful for interactive jobs. By default is on if the command is executed from a terminal, non-tty mode is used if executed from a script.

apolo help

Get help on a command.

Usage:

apolo help [OPTIONS] [COMMAND]...

Options:

Name	Description
--help	Show this message and exit.

apolo images

List images.

Usage:

apolo images [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.
--all-orgs	Show images in all orgs.
--all-projects	Show images in all projects.
--cluster CLUSTER	Show images on a specified cluster (the current cluster by default).
-l	List in long format.
--full-uri	Output full image URI.
-n, --name PATTERN	Filter out images by name regex.
--org ORG	Filter out images by org (multiple option, the current org by default).
--project PROJECT	Filter out images by project (multiple option, the current project by default).

apolo kill

Kill job(s).

Usage:

apolo kill [OPTIONS] JOBS...

Options:

Name	Description
--help	Show this message and exit.

apolo login

Log into Apolo Platform.

URL is a platform entrypoint URL.

Usage:

apolo login [OPTIONS] [URL]

Options:

Name	Description
--help	Show this message and exit.

apolo logout

Log out.

Usage:

apolo logout [OPTIONS]

Options:

Name	Description
--help	Show this message and exit.

apolo logs

Print the logs for a job.

Usage:

apolo logs [OPTIONS] JOB

Options:

Name	Description
--help	Show this message and exit.
--since DATE_OR_TIMEDELTA	Only return logs after a specific date (including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.
--timestamps	Include timestamps on each line in the log output.

apolo ls

List directory contents.

By default PATH is equal project's dir (storage:)

Usage:

apolo ls [OPTIONS] [PATHS]...

Options:

Name	Description
--help	Show this message and exit.
-d, --directory	list directories themselves, not their contents.
-l	use a long listing format.
-h, --human-readable	with -l print human readable sizes (e.g., 2K, 540M).
-a, --all	do not ignore entries starting with .
--sort [name \| size \| time]	sort by given field, default is name.

apolo mkdir

Make directories.

Usage:

apolo mkdir [OPTIONS] PATHS...

Options:

Name	Description
--help	Show this message and exit.
-p, --parents	No error if existing, make parent directories as needed

apolo mv

Move or rename files and directories.

SOURCE must contain path to the file or directory existing on the storage, and
DESTINATION must contain the full path to the target file or directory.

Usage:

apolo mv [OPTIONS] [SOURCES]... [DESTINATION]

Examples:

# move and rename remote file
apolo mv storage:foo.txt storage:bar/baz.dat
apolo mv -T storage:foo.txt storage:bar/baz.dat

# move remote files into existing remote directory
apolo mv storage:foo.txt storage:bar/baz.dat storage:dst
apolo mv storage:foo.txt storage:bar/baz.dat -t storage:dst

# move the content of remote directory into other existing
# remote directory
apolo mv -T storage:foo storage:bar

# move remote file into other project's directory
apolo mv storage:foo.txt storage:/{project}/bar.dat

# move remote file from other project's directory
apolo mv storage:/{project}/foo.txt storage:bar.dat

Options:

Name	Description
--help	Show this message and exit.
--glob / --no-glob	Expand glob patterns in SOURCES [default: glob]
-T, --no-target-directory	Treat DESTINATION as a normal file
-t, --target-directory DIRECTORY	Copy all SOURCES into DIRECTORY

apolo port-forward

Forward port(s) of a job.

Forwards port(s) of a running job to local port(s).

Usage:

apolo port-forward [OPTIONS] JOB LOCAL_PORT:REMOTE_RORT...

Examples:

# Forward local port 2080 to port 80 of job's container.
# You can use http://localhost:2080 in browser to access job's served http
apolo job port-forward my-fastai-job 2080:80

# Forward local port 2222 to job's port 22
# Then copy all data from container's folder '/data' to current folder
# (please run second command in other terminal)
apolo job port-forward my-job-with-ssh-server 2222:22
rsync -avxzhe ssh -p 2222 root@localhost:/data .

# Forward few ports at once
apolo job port-forward my-job 2080:80 2222:22 2000:100

Options:

Name	Description
--help	Show this message and exit.

apolo ps

List all jobs.

Usage:

apolo ps [OPTIONS]

Examples:

apolo ps -a
apolo ps -a --owner=user-1 --owner=user-2
apolo ps --name my-experiments-v1 -s failed -s succeeded
apolo ps --description=my favourite job
apolo ps -s failed -s succeeded -q
apolo ps -t tag1 -t tag2

Options:

Name	Description
--help	Show this message and exit.
-a, --all	Show all jobs regardless the status.
--all-orgs	Show jobs in all orgs.
--all-projects	Show jobs in all projects.
--cluster CLUSTER	Show jobs on a specified cluster (the current cluster by default).
-d, --description DESCRIPTION	Filter out jobs by description (exact match).
--distinct	Show only first job if names are same.
--format COLUMNS	Output table format, see "apolo help ps-format" for more info about the format specification. The default can be changed using the job.ps-format configuration variable documented in "apolo help user-config"
--full-uri	Output full image URI.
-n, --name NAME	Filter out jobs by name.
--org ORG	Filter out jobs by org name (multiple option, the current org by default).
-o, --owner TEXT	Filter out jobs by owner (multiple option). Supports `ME` option to filter by the current user.
-p, --project PROJECT	Filter out jobs by project name (multiple option, the current project by default).
--recent-first / --recent-last	Show newer jobs first or last
--since DATE_OR_TIMEDELTA	Show jobs created after a specific date (including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.
-s, --status [pending \| suspended \| running \| succeeded \| failed \| cancelled]	Filter out jobs by status (multiple option).
-t, --tag TAG	Filter out jobs by tag (multiple option)
--until DATE_OR_TIMEDELTA	Show jobs created before a specific date (including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.
-w, --wide	Do not cut long lines for terminal width.

apolo pull

Pull an image from platform registry.

Remote image name must be URL with image:// scheme. Image names can contain
tag.

Usage:

apolo pull [OPTIONS] REMOTE_IMAGE [LOCAL_IMAGE]

Examples:

apolo pull image:myimage
apolo pull image:/other-project/alpine:shared
apolo pull image:/project/my-alpine:production alpine:from-registry

Options:

Name	Description
--help	Show this message and exit.

apolo push

Push an image to platform registry.

Remote image must be URL with image:// scheme. Image names can contain tag. If
tags not specified 'latest' will be used as value.

Usage:

apolo push [OPTIONS] LOCAL_IMAGE [REMOTE_IMAGE]

Examples:

apolo push myimage
apolo push alpine:latest image:my-alpine:production
apolo push alpine image:/other-project/alpine:shared

Options:

Name	Description
--help	Show this message and exit.

apolo rm

Remove files or directories.

Usage:

apolo rm [OPTIONS] PATHS...

Examples:

apolo rm storage:foo/bar
apolo rm storage:/{project}/foo/bar
apolo rm storage://{cluster}/{project}/foo/bar
apolo rm --recursive storage:/{project}/foo/
apolo rm storage:foo/**/*.tmp

Options:

Name	Description
--help	Show this message and exit.
--glob / --no-glob	Expand glob patterns in PATHS [default: glob]
-p, --progress / -P, --no-progress	Show progress, on by default in TTY mode, off otherwise.
-r, --recursive	remove directories and their contents recursively

apolo run

Run a job

IMAGE docker image name to run in a job.

CMD list will be passed as arguments to the executed job's image.

Usage:

apolo run [OPTIONS] IMAGE [-- CMD...]

Examples:

# Starts a container pytorch/pytorch:latest on a machine with smaller GPU resources
# (see exact values in `apolo config show`) and with two volumes mounted:
#   storage:/<home-directory>   --> /var/storage/home (in read-write mode),
#   storage:/neuromation/public --> /var/storage/neuromation (in read-only mode).
apolo run --preset=gpu-small --volume=storage::/var/storage/home:rw \
--volume=storage:/neuromation/public:/var/storage/home:ro pytorch/pytorch:latest

# Starts a container using the custom image my-ubuntu:latest stored in apolo
# registry, run /script.sh and pass arg1 and arg2 as its arguments:
apolo run -s cpu-small --entrypoint=/script.sh image:my-ubuntu:latest -- arg1 arg2

Options:

Name	Description
--help	Show this message and exit.
--browse	Open a job's URL in a web browser
--cluster CLUSTER	Run job in a specified cluster
-d, --description DESC	Optional job description in free format
--detach	Don't attach to job logs and don't wait for exit code
--energy-schedule NAME	Run job only within a selected energy schedule. Selected preset should have scheduler enabled.
--entrypoint TEXT	Executable entrypoint in the container (note that it overwrites `ENTRYPOINT` and `CMD` instructions of the docker image)
-e, --env VAR=VAL	Set environment variable in container. Use multiple options to define more than one variable. See `apolo help secrets` for information about passing secrets as environment variables.
--env-file PATH	File with environment variables to pass
-x, --extshm / -X, --no-extshm	Request extended '/dev/shm' space [default: x]
--http-auth / --no-http-auth	Enable HTTP authentication for forwarded HTTP port [default: True]
--http-port PORT	Enable HTTP port forwarding to container [default: 80]
--life-span TIMEDELTA	Optional job run-time limit in the format '1d2h3m4s' (some parts may be missing). Set '0' to disable. Default value '1d' can be changed in the user config.
-n, --name NAME	Optional job name
--org ORG	Run job in a specified org
--pass-config / --no-pass-config	Upload apolo config to the job [default: no-pass-config]
--port-forward LOCAL_PORT:REMOTE_RORT	Forward port(s) of a running job to local port(s) (use multiple times for forwarding several ports)
-s, --preset PRESET	Predefined resource configuration (to see available values, run `apolo config show`)
--priority [low \| normal \| high]	Priority used to specify job's start order. Jobs with higher priority will start before ones with lower priority. Priority should be supported by cluster.
--privileged	Run job in privileged mode, if it is supported by cluster.
-p, --project PROJECT	Run job in a specified project.
--restart [never \| on-failure \| always]	Restart policy to apply when a job exits [default: never]
--schedule-timeout TIMEDELTA	Optional job schedule timeout in the format '3m4s' (some parts may be missing).
--share USER	Share job write permissions to user or role.
--tag TAG	Optional job tag, multiple values allowed
-t, --tty / -T, --no-tty	Allocate a TTY, can be useful for interactive jobs. By default is on if the command is executed from a terminal, non-tty mode is used if executed from a script.
-v, --volume MOUNT	Mounts directory from vault into container. Use multiple options to mount more than one volume. See `apolo help secrets` for information about passing secrets as mounted files.
--wait-for-seat / --no-wait-for-seat	Wait for total running jobs quota [default: no-wait-for-seat]
--wait-start / --no-wait-start	Wait for a job start or failure [default: wait-start]
-w, --workdir TEXT	Working directory inside the container

apolo save

Save job's state to an image.

Usage:

apolo save [OPTIONS] JOB IMAGE

Examples:

apolo job save job-id image:ubuntu-patched
apolo job save my-favourite-job image:ubuntu-patched:v1
apolo job save my-favourite-job image://bob/ubuntu-patched

Options:

Name	Description
--help	Show this message and exit.

apolo share

Shares resource with another user.

URI shared resource.

USER username to share resource with.

PERMISSION sharing access right: read, write, or manage.

Usage:

apolo share [OPTIONS] URI USER {read|write|manage}

Examples:

apolo acl grant storage:///sample_data/ alice manage
apolo acl grant image:resnet50 bob read
apolo acl grant job:///my_job_id alice write

Options:

Name	Description
--help	Show this message and exit.

apolo status

Display status of a job.

Usage:

apolo status [OPTIONS] JOB

Options:

Name	Description
--help	Show this message and exit.
--full-uri	Output full URI.

apolo top

Display GPU/CPU/Memory usage.

Usage:

apolo top [OPTIONS] [JOBS]...

Examples:

apolo top
apolo top job-1 job-2
apolo top --owner=user-1 --owner=user-2
apolo top --name my-experiments-v1
apolo top -t tag1 -t tag2

Options:

Name	Description
--help	Show this message and exit.
--cluster CLUSTER	Show jobs on a specified cluster (the current cluster by default).
-d, --description DESCRIPTION	Filter out jobs by description (exact match).
--format COLUMNS	Output table format, see "apolo help top-format" for more info about the format specification. The default can be changed using the job.top-format configuration variable documented in "apolo help user-config"
--full-uri	Output full image URI.
-n, --name NAME	Filter out jobs by name.
-o, --owner TEXT	Filter out jobs by owner (multiple option). Supports `ME` option to filter by the current user. Specify `ALL` to show jobs of all users.
-p, --project PROJECT	Filter out jobs by project name (multiple option).
--since DATE_OR_TIMEDELTA	Show jobs created after a specific date (including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.
--sort COLUMNS	Sort rows by specified column. Add "-" prefix to revert the sorting order. Multiple columns can be specified (comma separated). [default: cpu]
-t, --tag TAG	Filter out jobs by tag (multiple option)
--timeout FLOAT	Maximum allowed time for executing the command, 0 for no timeout [default: 0]
--until DATE_OR_TIMEDELTA	Show jobs created before a specific date (including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.

Files

CLI.md

Latest commit

History

CLI.md

File metadata and controls

Table of Contents

apolo

apolo acl

apolo acl add-role

apolo acl grant

apolo acl list-roles

apolo acl ls

apolo acl remove-role

apolo acl revoke

apolo admin

apolo admin add-cluster

apolo admin add-cluster-user

apolo admin add-org

apolo admin add-org-cluster

apolo admin add-org-cluster-credits

apolo admin add-org-user

apolo admin add-project

apolo admin add-project-user

apolo admin add-resource-preset

apolo admin add-user-credits

apolo admin generate-cluster-config

apolo admin get-cluster-orgs

apolo admin get-cluster-users

apolo admin get-clusters

apolo admin get-org-cluster-quota

apolo admin get-org-users

apolo admin get-orgs

apolo admin get-project-users

apolo admin get-projects

apolo admin get-user-quota

apolo admin remove-cluster

apolo admin remove-cluster-user

apolo admin remove-org

apolo admin remove-org-cluster

apolo admin remove-org-user

apolo admin remove-project

apolo admin remove-project-user

apolo admin remove-resource-preset

apolo admin set-org-cluster-credits

apolo admin set-org-cluster-defaults

apolo admin set-org-cluster-quota

apolo admin set-user-credits

apolo admin set-user-quota

apolo admin show-cluster-options

apolo admin update-cluster

apolo admin update-cluster-user

apolo admin update-node-pool

apolo admin update-org-cluster

apolo admin update-project

apolo admin update-project-user

apolo admin update-resource-preset

apolo blob

apolo blob cp

apolo blob du

apolo blob glob

apolo blob importbucket

apolo blob ls

apolo blob lsbucket

apolo blob lscredentials

apolo blob mkbucket

apolo blob mkcredentials

apolo blob rm

apolo blob rmbucket

apolo blob rmcredentials

apolo blob set-bucket-publicity

apolo blob sign-url

apolo blob statbucket

apolo blob statcredentials

apolo completion

apolo completion generate

apolo completion patch

apolo config

apolo config aliases

apolo config docker