dstack run¶
This command runs a given configuration.
Usage¶
$ dstack run --help
Usage: dstack run [-h] [--project PROJECT] [-t TAG] [-d] [WORKFLOW] [ARGS ...]
Positional Arguments:
WORKFLOW The name of a workflow
ARGS Override workflow arguments
Options:
--project PROJECT The name of the Hub project to execute the command for
-t, --tag TAG A tag name. Warning, if the tag exists, it will be overridden.
-d, --detach Do not poll for status update and logs
Arguments reference¶
The following arguments are required:
WORKFLOW
- (Required) The name of a workflow
The following arguments are optional:
--project PROJECT
– (Optional) The name of the Hub project to execute the command for-t TAG
,--tag TAG
– (Optional) A tag name. Warning, if the tag exists, it will be overridden.-d
,--detach
– (Optional) Run the workflow in the detached mode. Means, therun
command doesn't poll for logs and workflow status, but exits immediately.ARGS
– (Optional) UseARGS
to pass configuration arguments-h
,--help
– (Optional) Shows help for thedstack run
command. Combine it with the name of a workflow or provider to see the provider-specific help message.-p PORT [PORT ...]
,--port PORT [PORT ...]
– (Optional) Requests ports or define mappings for them (APP_PORT:LOCAL_PORT
)
NOTE:
By default, it runs it in the attached mode, so you'll see the output in real-time as your workflow is running.