CLI Reference

neuro-extras

Auxiliary scripts and recipes for automating routine tasks.
Usage:
1
neuro-extras [OPTIONS] COMMAND [ARGS]...
Copied!
Options:
Name
Description
--version
Show the version and exit.
--help
Show this message and exit.
Command Groups:
Usage
Description
Configuration operations.
Data transfer operations.
Job container image operations.
Cluster Kubernetes operations.
Seldon deployment operations.
Commands:
Usage
Description
Download neuro project files from storage.
Create neuro CLI aliases for neuro-extras functionality.
Upload neuro project files to storage.

neuro-extras config

Configuration operations.
Usage:
1
neuro-extras config [OPTIONS] COMMAND [ARGS]...
Copied!
Options:
Name
Description
--help
Show this message and exit.
Commands:
Usage
Description
Generate docker auth for accessing remote registry.
Save docker auth file for accessing platform registry.

neuro-extras config build-registy-auth

Generate docker auth for accessing remote registry.
Usage:
1
neuro-extras config build-registy-auth [OPTIONS] REGISTRY_URI USERNAME
2
PASSWORD
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-extras config save-registry-auth

Save docker auth file for accessing platform registry.
Usage:
1
neuro-extras config save-registry-auth [OPTIONS] PATH
Copied!
Options:
Name
Description
--cluster TEXT
Cluster name for which the auth information should be saved. Current cluster by default
--help
Show this message and exit.

neuro-extras data

Data transfer operations.
Usage:
1
neuro-extras data [OPTIONS] COMMAND [ARGS]...
Copied!
Options:
Name
Description
--help
Show this message and exit.
Commands:
Usage
Description
Copy data between external object storage and cluster.
Copy data between storages on different clusters.

neuro-extras data cp

Copy data between external object storage and cluster. Supported external object storage systems: ['AWS', 'GCS', 'AZURE', 'HTTP', 'HTTPS']. Note: originally, Azure's blob storage scheme is 'http(s)', but we prepend 'azure+' to differenciate https vs azure
Usage:
1
neuro-extras data cp [OPTIONS] SOURCE DESTINATION
Copied!
Options:
Name
Description
-x, --extract
Perform extraction of SOURCE into the DESTINATION directory. The archive type is derived from the file name. Supported types: .tar.gz, .tgz, .tar.bz2, .tbz2, .tbz, .tar, .gz, .zip.
-c, --compress
Perform compression of SOURCE into the DESTINATION file. The archive type is derived from the file name. Supported types: .tar.gz, .tgz, .tar.bz2, .tbz2, .tbz, .tar, .gz, .zip.
-v, --volume MOUNT
Mounts directory from vault into container. Use multiple options to mount more than one volume.
-e, --env VAR=VAL
Set environment variable in container. Use multiple options to define more than one variable.
-t, --use-temp-dir
Download and extract / compress data (if needed) inside the temporal directory. Afterwards move resulted file(s) into the DESTINATION. NOTE: use it if 'storage:' is involved and extraction or compression is performed to speedup the process.
-s, --preset PRESET_NAME
Preset name used for copy.
-l, --life_span SECONDS
Copy job life span in seconds.
--help
Show this message and exit.

neuro-extras data transfer

Copy data between storages on different clusters.
Consider archiving dataset first for the sake of performance, if the dataset contains a lot (100k+) of small (< 100Kb each) files.
Usage:
1
neuro-extras data transfer [OPTIONS] SOURCE DESTINATION
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-extras image

Job container image operations.
Usage:
1
neuro-extras image [OPTIONS] COMMAND [ARGS]...
Copied!
Options:
Name
Description
--help
Show this message and exit.
Commands:
Usage
Description
Build Job container image remotely on cluster using Kaniko.
Copy images between clusters.

neuro-extras image build

Build Job container image remotely on cluster using Kaniko.
Usage:
1
neuro-extras image build [OPTIONS] CONTEXT_PATH IMAGE_URI
Copied!
Options:
Name
Description
-f, --file TEXT
Relative (w.r.t. context) path to the dockerfile. The dockerfile should be within the context directory. [default: Dockerfile]
--build-arg VAR=VAL
Buid-time variables passed in ARG values, similarly to Docker. Could be used multiple times for multiple arguments.
-v, --volume MOUNT
Mounts directory from vault into container. Use multiple options to mount more than one volume. Use --volume=ALL to mount all accessible storage directories.
-e, --env VAR=VAL
Set environment variable in container Use multiple options to define more than one variable
-s, --preset PRESET
Predefined resource configuration (to see available values, run neuro config show)
-F, --force-overwrite
Overwrite if the destination image already exists. [default: False]
--cache / --no-cache
Use Kaniko cache while building image. [default: cache]
--verbose BOOLEAN
If specified, run Kaniko with 'debug' verbosity, otherwise 'info' (default).
--build-tag VAR=VAL
Set tag(s) for image builder job. We will add tag 'kaniko-builds:{image-name}' authomatically.
--help
Show this message and exit.

neuro-extras image transfer

Copy images between clusters.
Usage:
1
neuro-extras image transfer [OPTIONS] SOURCE DESTINATION
Copied!
Options:
Name
Description
-F, --force-overwrite
Transfer even if the destination image already exists.
--help
Show this message and exit.

neuro-extras k8s

Cluster Kubernetes operations.
Usage:
1
neuro-extras k8s [OPTIONS] COMMAND [ARGS]...
Copied!
Options:
Name
Description
--help
Show this message and exit.
Commands:

neuro-extras k8s generate-registry-secret

Usage:
1
neuro-extras k8s generate-registry-secret [OPTIONS]
Copied!
Options:
Name
Description
--name TEXT
--help
Show this message and exit.

neuro-extras k8s generate-secret

Usage:
1
neuro-extras k8s generate-secret [OPTIONS]
Copied!
Options:
Name
Description
--name TEXT
--help
Show this message and exit.

neuro-extras seldon

Seldon deployment operations.
Usage:
1
neuro-extras seldon [OPTIONS] COMMAND [ARGS]...
Copied!
Options:
Name
Description
--help
Show this message and exit.
Commands:

neuro-extras seldon generate-deployment

Usage:
1
neuro-extras seldon generate-deployment [OPTIONS] MODEL_IMAGE_URI
2
MODEL_STORAGE_URI
Copied!
Options:
Name
Description
--name TEXT
--neuro-secret TEXT
--registry-secret TEXT
--help
Show this message and exit.

neuro-extras seldon init-package

Usage:
1
neuro-extras seldon init-package [OPTIONS] [PATH]
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-extras download

Download neuro project files from storage.
Downloads file (or files under) from storage://remote-project-dir/PATH to project-root/PATH. You can use "." for PATH to download whole project. The "remote-project-dir" is set using .neuro.toml config, as in example:
[extra] remote-project-dir = "project-dir-name"
Usage:
1
neuro-extras download [OPTIONS] PATH
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-extras init-aliases

Create neuro CLI aliases for neuro-extras functionality.
Usage:
1
neuro-extras init-aliases [OPTIONS]
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-extras upload

Upload neuro project files to storage.
Uploads file (or files under) project-root/PATH to storage://remote-project- dir/PATH. You can use "." for PATH to upload whole project. The "remote- project-dir" is set using .neuro.toml config, as in example:
[extra] remote-project-dir = "project-dir-name"
Usage:
1
neuro-extras upload [OPTIONS] PATH
Copied!
Options:
Name
Description
--help
Show this message and exit.
Last modified 26d ago