File tree Expand file tree Collapse file tree 1 file changed +3
-6
lines changed
Expand file tree Collapse file tree 1 file changed +3
-6
lines changed Original file line number Diff line number Diff line change @@ -75,16 +75,13 @@ function hflow_start() {
7575/*
7676** Function hflowRun: run a workflow
7777**
78- ** Parameters:
79- ** - wfVars -- values for '{{var}}' variables that may exist in workflow.json
80- ** - opts -- docopt JSON object from 'hflow' command with additional options:
78+ ** Parameters are passed as 'opts' -- docopt JSON object from 'hflow' command:
8179** '<workflow_dir_or_file>': (string/null) -- path to 'workflow'json' or directory that contains it
8280** '--log-provenance': (true/false) -- if true, provenance will be logged
8381** '--persist': (true/false) -- if true, workflow state will be persisted
8482** '--provenance-output': (string/null) -- path to file where provenance should be saved (defaults to 'provenance_log.txt')
85- ** '--var': [],
86- ** '--with-server': (true/false) --
87- ** '-p': (true/false) --
83+ ** '--var': (array of strings) -- some {{vars}} can be passed using this array
84+ ** '-p': (true/false) -- if true, load plugin modules
8885** '-s': (true/false) -- if true, initial signals to all workflow inputs will be sent (obsolete)
8986** recover: (true/false) -- if true, this is a recovery mode (workflow is replayed from a recovery file)
9087** '<persistence-log>': (string/null) -- name/path to the recovery file (must be set if 'recover' is true)
You can’t perform that action at this time.
0 commit comments