Workflow Create
Usage
dxflow workflow create <SOURCE> [OPTIONS]
Alias: dxflow workflow make.
Options
| Flag | Shorthand | Description | Type | Default |
|---|---|---|---|---|
--identity | -i | Workflow identity; folded to the engine's identity shape | string | |
--start | -s | Start workflow once it is created | bool | false |
--fit | -f | Cap every step's cpu and memory to the host capacity and match its gpu to the host, alongside a start | bool | false |
--link | -l | Assign a link to every step declaring one, alongside a start | bool | false |
SOURCE is the workflow to create, resolved to its YAML before it is sent to the engine:
- a local path —
./workflow.ymlor/abs/workflow.yml(a bare path is read as afile://file); file://<path>— an explicit local file;hub://<name>— a workflow from the dxflow hub, by name;http://…/https://…— fetched over HTTP.
--identity is folded before use, so --identity my-fastqc creates myfastqc. The success line reports what the engine settled on, and every later command accepts either form. See Identities.
--start runs the workflow as soon as it is created, in the same call, using the workflow's existing workflow.ini. To set per-run values, create the workflow and pass --override to workflow start.
--fit goes with --start. It caps each step's cpu and memory to the engine host's core count and total memory, and matches its gpu to the cards the host holds, so a definition asking for more than the host has still starts. See workflow start.
--link goes with --start and assigns a link to every step declaring one under link in the definition, while the license carries any. The success line carries what the start assigned, one [link → step] detail per link.
This command runs against a running engine — start one with boot up.
Example
dxflow workflow create ./workflow.yml
dxflow workflow create hub://fastqc --identity my-fastqc # creates myfastqc
dxflow workflow create ./workflow.yml --start
dxflow workflow create ./workflow.yml --start --fit
dxflow workflow create ./workflow.yml --start --link