CLI reference

neuro-flow

Usage:
1
neuro-flow [OPTIONS] COMMAND [ARGS]...
Copied!
Options:
Name
Description
--config PATH
Path to a directory with .neuro folder inside, automatic lookup is performed if not set (default)
-v, --verbose
Give more output. Option is additive, and can be used up to 2 times.
-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.
--version
Show the version and exit.
--help
Show this message and exit.
Command Groups:
Usage
Description
Output shell completion code.
Commands:
Usage
Description
Start a batch.
List existing bakes.
Build an image.
Cancel a bake.
Clean volume.
Clear cache.
Completely remove project with all related entities
Download volume.
Inspect a bake.
Kill a job.
Print logs.
Create all remote folders for volumes.
List all jobs
Start a batch.
Run a job.
Show output of baked task.
Show job status.
Upload volume.

neuro-flow completion

Output shell completion code.
Usage:
1
neuro-flow completion [OPTIONS] COMMAND [ARGS]...
Copied!
Options:
Name
Description
--help
Show this message and exit.
Commands:
Usage
Description
Provide instruction for shell completion generation.
Automatically patch shell configuration profile to enable completion

neuro-flow completion generate

Provide instruction for shell completion generation.
Usage:
1
neuro-flow completion generate [OPTIONS] {bash|zsh}
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-flow completion patch

Automatically patch shell configuration profile to enable completion
Usage:
1
neuro-flow completion patch [OPTIONS] {bash|zsh}
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-flow bake

Start a batch.
Run BATCH pipeline remotely on the cluster.
Usage:
1
neuro-flow bake [OPTIONS] BATCH
Copied!
Options:
Name
Description
--local-executor
Run primary job locally
-p, --param <TEXT TEXT>...
Set params of the batch config
-n, --name NAME
Optional bake name
--meta-from-file FILE
File with params for batch.
-t, --tag TAG
Optional bake tag, multiple values allowed
--help
Show this message and exit.

neuro-flow bakes

List existing bakes.
Usage:
1
neuro-flow bakes [OPTIONS]
Copied!
Options:
Name
Description
-t, --tag TAG
Filter out bakes by tag (multiple option)
--since DATE_OR_TIMEDELTA
Show bakes created after a specific date (including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.
--until DATE_OR_TIMEDELTA
Show bakes created before a specific date (including). Use value of format '1d2h3m4s' to specify moment in past relatively to current time.
--recent-first / --recent-last
Show newer bakes first or last
--help
Show this message and exit.

neuro-flow build

Build an image.
Assemble the IMAGE remotely and publish it.
Usage:
1
neuro-flow build [OPTIONS] IMAGE
Copied!
Options:
Name
Description
-F, --force-overwrite
Build even if the destination image already exists.
--help
Show this message and exit.

neuro-flow cancel

Cancel a bake.
Cancel a bake execution by stopping all started tasks.
Usage:
1
neuro-flow cancel [OPTIONS] BAKE
Copied!
Options:
Name
Description
-a, --attempt INTEGER
Attempt number, the last attempt by default
--help
Show this message and exit.

neuro-flow clean

Clean volume.
Clean remote files on VOLUME, use clean ALL for cleaning up all volumes.
Usage:
1
neuro-flow clean [OPTIONS] VOLUME
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-flow clear-cache

Clear cache.
Use neuro-flow clear-cache <BATCH> for cleaning up the cache for BATCH; Use neuro-flow clear-cache <BATCH> <TASK_ID> for cleaning up the cache for TASK_ID in BATCH;
neuro-flow clear-cache ALL clears all caches.
Usage:
1
neuro-flow clear-cache [OPTIONS] BATCH [TASK_ID]
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-flow delete-project

Completely remove project with all related entities
Usage:
1
neuro-flow delete-project [OPTIONS] PROJECT_IDS...
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-flow download

Download volume.
Download remote files to local for VOLUME, use download ALL for downloading all volumes.
Usage:
1
neuro-flow download [OPTIONS] VOLUME
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-flow inspect

Inspect a bake.
Display a list of started/finished tasks of BAKE_ID.
Usage:
1
neuro-flow inspect [OPTIONS] BAKE
Copied!
Options:
Name
Description
-a, --attempt INTEGER
Attempt number, the last attempt by default
-o, --output-graph FILE
A path to Graphviz (DOT) file. Autogenerated from BAKE_ID and attempt number by default
--dot
Save DOT file with tasks statuses.
--pdf
Save PDF file with tasks statuses.
--view
Open generated PDF file with tasks statuses.
--help
Show this message and exit.

neuro-flow kill

Kill a job.
Kill JOB-ID, use kill ALL for killing all jobs.
Usage:
1
neuro-flow kill [OPTIONS] JOB_ID [SUFFIX]
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-flow logs

Print logs.
Display logs for JOB-ID
Usage:
1
neuro-flow logs [OPTIONS] JOB_ID [SUFFIX]
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-flow mkvolumes

Create all remote folders for volumes.
Usage:
1
neuro-flow mkvolumes [OPTIONS]
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-flow ps

List all jobs
Usage:
1
neuro-flow ps [OPTIONS]
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-flow restart

Start a batch.
Run BATCH pipeline remotely on the cluster.
Usage:
1
neuro-flow restart [OPTIONS] BAKE
Copied!
Options:
Name
Description
-a, --attempt INTEGER
Attempt number, the last attempt by default
--local-executor
Run primary job locally
--from-failed / --no-from-failed
Restart from the point of failure
--help
Show this message and exit.

neuro-flow run

Run a job.
RUN job JOB-ID or ATTACH to it if the job is already running
For multi-jobs an explicit job suffix can be used with explicit job arguments.
Usage:
1
neuro-flow run [OPTIONS] JOB_ID [ARGS]...
Copied!
Options:
Name
Description
-s, --suffix TEXT
Optional suffix for multi-jobs
-p, --param <TEXT TEXT>...
Set params of the batch config
--dry-run
Print run command instead of starting job.
--help
Show this message and exit.

neuro-flow show

Show output of baked task.
Display a logged output of TASK_ID from BAKE_ID.
Usage:
1
neuro-flow show [OPTIONS] BAKE TASK_ID
Copied!
Options:
Name
Description
-a, --attempt INTEGER
Attempt number, the last attempt by default
-r, --raw / -R, --no-raw
Raw mode disables the output postprocessing (the output is processed by default)
--help
Show this message and exit.

neuro-flow status

Show job status.
Print status for JOB-ID
Usage:
1
neuro-flow status [OPTIONS] JOB_ID [SUFFIX]
Copied!
Options:
Name
Description
--help
Show this message and exit.

neuro-flow upload

Upload volume.
Upload local files to remote for VOLUME, use upload ALL for uploading all volumes.
Usage:
1
neuro-flow upload [OPTIONS] VOLUME
Copied!
Options:
Name
Description
--help
Show this message and exit.
Last modified 1mo ago