From ad27da39946285192c68fa2babee0be3249df3d3 Mon Sep 17 00:00:00 2001 From: Tim Pillinger <26465611+wxtim@users.noreply.github.com> Date: Thu, 18 Jan 2024 17:04:10 +0000 Subject: [PATCH] Remove most help file tests. Keep cli help tests for message, broadcast and tui. --- tests/functional/cli/04-kgo.t | 21 ++- tests/functional/cli/04-kgo/cat-log.help | 93 ---------- .../functional/cli/04-kgo/check-versions.help | 57 ------ tests/functional/cli/04-kgo/clean.help | 81 --------- tests/functional/cli/04-kgo/client.help | 26 --- .../cli/04-kgo/completion-server.help | 23 --- tests/functional/cli/04-kgo/config.help | 114 ------------ tests/functional/cli/04-kgo/cycle-point.help | 63 ------- tests/functional/cli/04-kgo/diff.help | 58 ------- tests/functional/cli/04-kgo/dump.help | 43 ----- tests/functional/cli/04-kgo/ext-trigger.help | 40 ----- tests/functional/cli/04-kgo/function-run.help | 9 - .../functional/cli/04-kgo/get-resources.help | 39 ----- .../cli/04-kgo/get-workflow-contact.help | 17 -- .../cli/04-kgo/get-workflow-version.help | 37 ---- tests/functional/cli/04-kgo/graph.help | 98 ----------- tests/functional/cli/04-kgo/hold.help | 89 ---------- tests/functional/cli/04-kgo/install.help | 108 ------------ tests/functional/cli/04-kgo/jobs-kill.help | 22 --- tests/functional/cli/04-kgo/jobs-poll.help | 21 --- tests/functional/cli/04-kgo/jobs-submit.help | 28 --- tests/functional/cli/04-kgo/kill.help | 64 ------- tests/functional/cli/04-kgo/lint.help | 40 ----- tests/functional/cli/04-kgo/list.help | 91 ---------- tests/functional/cli/04-kgo/pause.help | 47 ----- tests/functional/cli/04-kgo/ping.help | 57 ------ tests/functional/cli/04-kgo/play.help | 152 ---------------- tests/functional/cli/04-kgo/poll.help | 66 ------- tests/functional/cli/04-kgo/psutils.help | 15 -- tests/functional/cli/04-kgo/reinstall.help | 82 --------- tests/functional/cli/04-kgo/release.help | 73 -------- tests/functional/cli/04-kgo/reload.help | 65 ------- tests/functional/cli/04-kgo/remote-init.help | 32 ---- tests/functional/cli/04-kgo/remote-tidy.help | 22 --- tests/functional/cli/04-kgo/remove.help | 54 ------ .../functional/cli/04-kgo/report-timings.help | 50 ------ tests/functional/cli/04-kgo/scan.help | 86 ---------- tests/functional/cli/04-kgo/set-outputs.help | 83 --------- .../functional/cli/04-kgo/set-verbosity.help | 40 ----- tests/functional/cli/04-kgo/show.help | 59 ------- tests/functional/cli/04-kgo/stop.help | 87 ---------- tests/functional/cli/04-kgo/subscribe.help | 29 ---- tests/functional/cli/04-kgo/trigger.help | 82 --------- tests/functional/cli/04-kgo/validate.help | 80 --------- tests/functional/cli/04-kgo/view.help | 82 --------- tests/functional/cli/04-kgo/vip.help | 158 ----------------- tests/functional/cli/04-kgo/vr.help | 162 ------------------ .../functional/cli/04-kgo/workflow-state.help | 70 -------- 48 files changed, 10 insertions(+), 3005 deletions(-) delete mode 100644 tests/functional/cli/04-kgo/cat-log.help delete mode 100644 tests/functional/cli/04-kgo/check-versions.help delete mode 100644 tests/functional/cli/04-kgo/clean.help delete mode 100644 tests/functional/cli/04-kgo/client.help delete mode 100644 tests/functional/cli/04-kgo/completion-server.help delete mode 100644 tests/functional/cli/04-kgo/config.help delete mode 100644 tests/functional/cli/04-kgo/cycle-point.help delete mode 100644 tests/functional/cli/04-kgo/diff.help delete mode 100644 tests/functional/cli/04-kgo/dump.help delete mode 100644 tests/functional/cli/04-kgo/ext-trigger.help delete mode 100644 tests/functional/cli/04-kgo/function-run.help delete mode 100644 tests/functional/cli/04-kgo/get-resources.help delete mode 100644 tests/functional/cli/04-kgo/get-workflow-contact.help delete mode 100644 tests/functional/cli/04-kgo/get-workflow-version.help delete mode 100644 tests/functional/cli/04-kgo/graph.help delete mode 100644 tests/functional/cli/04-kgo/hold.help delete mode 100644 tests/functional/cli/04-kgo/install.help delete mode 100644 tests/functional/cli/04-kgo/jobs-kill.help delete mode 100644 tests/functional/cli/04-kgo/jobs-poll.help delete mode 100644 tests/functional/cli/04-kgo/jobs-submit.help delete mode 100644 tests/functional/cli/04-kgo/kill.help delete mode 100644 tests/functional/cli/04-kgo/lint.help delete mode 100644 tests/functional/cli/04-kgo/list.help delete mode 100644 tests/functional/cli/04-kgo/pause.help delete mode 100644 tests/functional/cli/04-kgo/ping.help delete mode 100644 tests/functional/cli/04-kgo/play.help delete mode 100644 tests/functional/cli/04-kgo/poll.help delete mode 100644 tests/functional/cli/04-kgo/psutils.help delete mode 100644 tests/functional/cli/04-kgo/reinstall.help delete mode 100644 tests/functional/cli/04-kgo/release.help delete mode 100644 tests/functional/cli/04-kgo/reload.help delete mode 100644 tests/functional/cli/04-kgo/remote-init.help delete mode 100644 tests/functional/cli/04-kgo/remote-tidy.help delete mode 100644 tests/functional/cli/04-kgo/remove.help delete mode 100644 tests/functional/cli/04-kgo/report-timings.help delete mode 100644 tests/functional/cli/04-kgo/scan.help delete mode 100644 tests/functional/cli/04-kgo/set-outputs.help delete mode 100644 tests/functional/cli/04-kgo/set-verbosity.help delete mode 100644 tests/functional/cli/04-kgo/show.help delete mode 100644 tests/functional/cli/04-kgo/stop.help delete mode 100644 tests/functional/cli/04-kgo/subscribe.help delete mode 100644 tests/functional/cli/04-kgo/trigger.help delete mode 100644 tests/functional/cli/04-kgo/validate.help delete mode 100644 tests/functional/cli/04-kgo/view.help delete mode 100644 tests/functional/cli/04-kgo/vip.help delete mode 100644 tests/functional/cli/04-kgo/vr.help delete mode 100644 tests/functional/cli/04-kgo/workflow-state.help diff --git a/tests/functional/cli/04-kgo.t b/tests/functional/cli/04-kgo.t index 36f0125af38..a6c22b09775 100644 --- a/tests/functional/cli/04-kgo.t +++ b/tests/functional/cli/04-kgo.t @@ -17,21 +17,20 @@ #------------------------------------------------------------------------------- # Test "cylc set-verbosity" . "$(dirname "$0")/test_header" -set_test_number 47 +set_test_number 3 KGO="/net/home/h02/tpilling/metomi/cylc-flow/tests/functional/cli/04-kgo/" -# Get scripts described by cylc.flow entrypoints. -SCRIPTS=$(python -c "import cylc.flow as cf; print(' '.join(i.name for i in cf.iter_entry_points('cylc.command') if i.module_name.startswith('cylc.flow')))") +# List of sample scripts to test help documentation. +# broadcast - we want to keep this script consistent. +# message - we want to keep this script consistent. This script has two +# valid arg groups. +# tui - slightly non-standard script. +SCRIPTS="broadcast message tui" for script in $SCRIPTS; do # Generate KGO # cylc $script --help > $KGO/$script.help 2>&1 - - # These three scripts can change the order of items printed: - if [[ $script != "vip" && $script != "scan" && $script != "vr" ]]; then - cylc "$script" --help > "$script.help" 2>&1 - cmp_ok "$script.help" "$KGO/$script.help" - fi - -done \ No newline at end of file + cylc "$script" --help > "$script.help" 2>&1 + cmp_ok "$script.help" "$KGO/$script.help" +done diff --git a/tests/functional/cli/04-kgo/cat-log.help b/tests/functional/cli/04-kgo/cat-log.help deleted file mode 100644 index 44135c129c3..00000000000 --- a/tests/functional/cli/04-kgo/cat-log.help +++ /dev/null @@ -1,93 +0,0 @@ -Usage: cylc cat-log [OPTIONS] ID ... - -View Cylc workflow and job log files. - -Print, tail-follow, print path, or list directory, of local or remote job -and scheduler logs. Job runner view commands (e.g. 'qcat') are used if defined -in global config and the job is running. - -For standard log types use the short-cut option argument or full filename (e.g. -for job stdout "-f o" or "-f job.out" will do). - -To list the local job log directory of a remote task, choose "-m l" (directory -list mode) and a local file, e.g. "-f a" (job-activity.log). - -If remote job logs are retrieved to the workflow host on completion (global -config '[JOB-HOST]retrieve job logs = True') and the job is not currently -running, the local (retrieved) log will be accessed unless '-o/--force-remote' -is used. - -The correct cycle point format of the workflow must be used for job logs, -but can be discovered with '--mode=d' (print-dir). - -Examples: - # for a task "2020/bar" in workflow "foo" - - # Print workflow log: - $ cylc cat-log foo - - # Print specific workflow log: - $ cylc cat-log foo -f scheduler/02-start-01.log - - # Print task stdout: - $ cylc cat-log foo//2020/bar - $ cylc cat-log -f o foo//2020/bar - - # Print task stderr: - $ cylc cat-log -f e foo//2020/bar - - # Print a custom file in a job's log directory: - $ cylc cat-log -f my-log-file foo//2020/bar - - # Follow a log file: - $ cylc cat-log foo//2020/bar -m f - - -Log Files: - Select the log file to view with the --file option. - Either provide the file path or use one of the short options: - - Job Logs: - j job - o job.out - e job.err - a job-activity.log - s job.status - x job.xtrace - - Workflow Logs: - c workflow configuration file (raw) - p workflow configuration file (processed) - i install log - s scheduler log - - Use "--mode=l" to list available log files for a workflow/job. - -Arguments: - ID ... Workflow/Cycle/Family/Task ID(s) - -Options: - -h, --help show this help message and exit - -f LOG, --file=LOG The file to view. Default for job logs "out", default - for workflow logs "scheduler/log". See "Log Files" - above for possible values. - -m MODE, --mode=MODE Mode: p(print), l(list-dir), d(print-dir), c(cat), - t(tail). Default c(cat). - -r INT, --rotation=INT - Workflow log integer rotation number. 0 for current, 1 - for next oldest, etc. - -o, --force-remote View remote logs remotely even if they have been - retrieved to the workflow host (default False). - -s INT, -t INT, --submit-number=INT, --try-number=INT - Job submit number (default=NN, i.e. latest). - --remote-arg=REMOTE_ARGS - (for internal use: continue processing on job host) - --prepend-path Prepend the file path to the output in the format - : - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. diff --git a/tests/functional/cli/04-kgo/check-versions.help b/tests/functional/cli/04-kgo/check-versions.help deleted file mode 100644 index e5d71fa2860..00000000000 --- a/tests/functional/cli/04-kgo/check-versions.help +++ /dev/null @@ -1,57 +0,0 @@ -Usage: cylc check-versions [OPTIONS] WORKFLOW | PATH - -Check that Cylc versions match on different platforms. - -Check that the remote versions of Cylc invoked on each of the platforms used by -a workflow matches the version this script is run with. - -Note: - Cylc supports multiple parallel installations at different versions via the - Cylc wrapper script. For more information see the installation section of the - documentation. - -Use -v/--verbose to see the command invoked to determine the remote version -(all remote Cylc command invocations will be of the same form, which may be -site dependent -- see cylc global config documentation. - - -Arguments: - WORKFLOW | PATH Workflow ID or path - -Options: - -h, --help show this help message and exit - -e, --error Exit with error status if 8.2.5.dev is not available - on all remote platforms. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - -s NAME=VALUE, --set=NAME=VALUE - Set the value of a Jinja2 template variable in the - workflow definition. Values should be valid Python - literals so strings must be quoted e.g. - 'STR="string"', INT=43, BOOL=True. This option can be - used multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - -z NAME=VALUE1,VALUE2,..., --set-list=NAME=VALUE1,VALUE2,..., --template-list=NAME=VALUE1,VALUE2,... - Set the value of a Jinja2 template variable in the - workflow definition as a comma separated list of - Python strings. Values containing commas must be - quoted. e.g. '+s STR=a,b,c' => ['a', 'b', 'c'] or '+ s - STR=a,"b,c"' => ['a', 'b,c'] This option can be used - multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - --set-file=FILE Set the value of Jinja2 template variables in the - workflow definition from a file containing NAME=VALUE - pairs (one per line). As with --set values should be - valid Python literals so strings must be quoted e.g. - STR='string'. NOTE: these settings persist across - workflow restarts, but can be set again on the "cylc - play" command line if they need to be overridden. diff --git a/tests/functional/cli/04-kgo/clean.help b/tests/functional/cli/04-kgo/clean.help deleted file mode 100644 index dbf635bde2e..00000000000 --- a/tests/functional/cli/04-kgo/clean.help +++ /dev/null @@ -1,81 +0,0 @@ -Usage: cylc clean [OPTIONS] WORKFLOW ... - -Delete a stopped workflow. - -Remove workflow files from the local scheduler filesystem and any remote hosts -the workflow was installed on. - -NOTE: this command is intended for workflows installed with `cylc install`. If -this is run for a workflow that was instead written directly in ~/cylc-run and -not backed up elsewhere, it will be lost. - -It will also remove any symlink directory targets. - -Workflow IDs can be hierarchical, corresponding to the path under ~/cylc-run. - -Examples: - # Remove the workflow at ~/cylc-run/foo/bar - $ cylc clean foo/bar - - # Remove multiple workflows - $ cylc clean one two three - - # Remove the workflow's log directory - $ cylc clean foo/bar --rm log - - # Remove the log and work directories - $ cylc clean foo/bar --rm log:work - # or - $ cylc clean foo/bar --rm log --rm work - - # Remove all job log files from the 2020 cycle points - $ cylc clean foo/bar --rm 'log/job/2020*' - - # Remove all .csv files - $ cylc clean foo/bar --rm '**/*.csv' - - # Only remove the workflow on the local filesystem - $ cylc clean foo/bar --local-only - - # Only remove the workflow on remote install targets - $ cylc clean foo/bar --remote-only - -This command can operate on multiple workflows, globs may also be used: - Multiple Workflows: - # Operate on two workflows - workflow-1 workflow-2 - - Globs (note: globs should be quoted): - # Match all workflows - '*' - - # Match the workflows foo-1, foo-2 - 'foo-[12]' - - See `cylc help id` for more details. - - -Arguments: - WORKFLOW ... Workflow ID(s) - -Options: - -h, --help show this help message and exit - --rm=DIR[:DIR:...] Only clean the specified subdirectories (or files) in - the run directory, rather than the whole run - directory. Accepts quoted globs. - --local-only, --local - Only clean on the local filesystem (not remote hosts). - --remote-only, --remote - Only clean on remote hosts (not the local filesystem). - -y, --yes Skip interactive prompt if trying to clean multiple - run directories at once. - --timeout=REMOTE_TIMEOUT - The number of seconds to wait for cleaning to take - place on remote hosts before cancelling. Default: 120. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. diff --git a/tests/functional/cli/04-kgo/client.help b/tests/functional/cli/04-kgo/client.help deleted file mode 100644 index 6721f7787c6..00000000000 --- a/tests/functional/cli/04-kgo/client.help +++ /dev/null @@ -1,26 +0,0 @@ -Usage: cylc client [OPTIONS] WORKFLOW METHOD - -(This command is for internal use.) - -Invoke workflow runtime client, expect JSON from STDIN for keyword arguments. -Use the -n option if client function requires no keyword arguments. - - -Arguments: - WORKFLOW Workflow ID - METHOD Network API function name - -Options: - -h, --help show this help message and exit - -n, --no-input Do not read from STDIN, assume null input - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/completion-server.help b/tests/functional/cli/04-kgo/completion-server.help deleted file mode 100644 index 0ddc9397653..00000000000 --- a/tests/functional/cli/04-kgo/completion-server.help +++ /dev/null @@ -1,23 +0,0 @@ -Usage: cylc completion-server [OPTIONS] - -A server for providing Cylc CLI completion results. - -This server accepts requests containing the command line and returns responses -containing possible completions for the last word on the command line. - -See `cylc get-resources` for available completion scripts using this server. - - -Options: - -h, --help show this help message and exit - --timeout=TIMEOUT The maximum idle time before the server shuts down in - seconds. - --once Exit after returning the first response (for testing - purposes). - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. diff --git a/tests/functional/cli/04-kgo/config.help b/tests/functional/cli/04-kgo/config.help deleted file mode 100644 index 9efe78b7346..00000000000 --- a/tests/functional/cli/04-kgo/config.help +++ /dev/null @@ -1,114 +0,0 @@ -Usage: cylc config [OPTIONS] [WORKFLOW | PATH] - -Parse and print Cylc configuration files. - -Print parsed configuration, after runtime inheritance. If WORKFLOW is -specified, print the workflow configuration, otherwise print the global -configuration. - -Note: - This is different to `cylc view` which doesn't parse the configuration, - so is useful for debugging Jinja2. - -By default, unset values are printed as an empty string, or (for -historical reasons) as "None" with -o/--one-line. These defaults -can be changed with the -n/--null-value option. - -Examples: - # print global configuration - $ cylc config - - # print workflow configuration - $ cylc config myflow - - # print specific setting from the global config - $ cylc config -i '[platforms][myplatform]hosts - - # print specific section from workflow config - $ cylc config -i '[scheduling][graph]' myflow - - # print workflow config, first setting the initial cycle point - $ cylc config --initial-cycle-point=now myflow - - -Arguments: - [WORKFLOW | PATH] Workflow ID or path - -Options: - -h, --help show this help message and exit - -i [SEC...]ITEM, --item=[SEC...]ITEM - Item or section to print (multiple use allowed). - -d, --defaults Include the hard-coded Cylc default values in the - output. - -n STRING, --null-value=STRING - The string to print for unset values (default - nothing). - -o, --one-line Print multiple single-value items at once. - --print-hierarchy, --print-filenames, --hierarchy - Print the list of locations in which configuration - files are looked for. An existing configuration file - lower down the list overrides any settings it shares - with those higher up. - --initial-cycle-point=CYCLE_POINT or OFFSET, --icp=CYCLE_POINT or OFFSET - Set the initial cycle point. Required if not defined - in flow.cylc. May be either an absolute point or an - offset: See https://bit.ly/3MYHqVh (Cylc documentation - link). - --against-source Load the workflow configuration from the source - directory it was installed from using any options - (e.g. template variables) which have been set in the - installation. This is useful if you want to see how - changes made to the workflow source would affect the - installation if reinstalled. Note if this option is - used the provided workflow must have been installed by - `cylc install`. - -O OPT_CONF_KEYS, --opt-conf-key=OPT_CONF_KEYS - Use optional Rose Config Setting (If Cylc-Rose is - installed) - -D DEFINES, --define=DEFINES - Each of these overrides the `[SECTION]KEY` setting in - a `rose-suite.conf` file. Can be used to disable a - setting using the syntax `--define=[SECTION]!KEY` or - even `--define=[!SECTION]`. - -S ROSE_TEMPLATE_VARS, --rose-template-variable=ROSE_TEMPLATE_VARS, --define-suite=ROSE_TEMPLATE_VARS - As `--define`, but with an implicit `[SECTION]` for - workflow variables. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - -s NAME=VALUE, --set=NAME=VALUE - Set the value of a Jinja2 template variable in the - workflow definition. Values should be valid Python - literals so strings must be quoted e.g. - 'STR="string"', INT=43, BOOL=True. This option can be - used multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - -z NAME=VALUE1,VALUE2,..., --set-list=NAME=VALUE1,VALUE2,..., --template-list=NAME=VALUE1,VALUE2,... - Set the value of a Jinja2 template variable in the - workflow definition as a comma separated list of - Python strings. Values containing commas must be - quoted. e.g. '+s STR=a,b,c' => ['a', 'b', 'c'] or '+ s - STR=a,"b,c"' => ['a', 'b,c'] This option can be used - multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - --set-file=FILE Set the value of Jinja2 template variables in the - workflow definition from a file containing NAME=VALUE - pairs (one per line). As with --set values should be - valid Python literals so strings must be quoted e.g. - STR='string'. NOTE: these settings persist across - workflow restarts, but can be set again on the "cylc - play" command line if they need to be overridden. - - Platform printing options: - --platform-names Print a list of platforms and platform group names - from the configuration. - --platforms Print platform and platform group configurations, - including metadata. diff --git a/tests/functional/cli/04-kgo/cycle-point.help b/tests/functional/cli/04-kgo/cycle-point.help deleted file mode 100644 index 4cfc4c14890..00000000000 --- a/tests/functional/cli/04-kgo/cycle-point.help +++ /dev/null @@ -1,63 +0,0 @@ -Usage: cylc cycle-point [OPTIONS] [POINT] - -Utility for simple date-time cycle point arithmetic. - -For more generic date-time manipulations see the "isodatetime" command. - -Filename templating replaces elements of a template string with corresponding -elements of the current or given cycle point. - -Use ISO 8601 or posix date-time format elements: - $ cylc cycle-point 2010080T00 --template foo-CCYY-MM-DD-Thh.nc - foo-2010-08-08-T00.nc - $ cylc cycle-point 2010080T00 --template foo-%Y-%m-%d-T%H.nc - foo-2010-08-08-T00.nc - -Other examples: - # print offset from an explicit cycle point: - $ cylc cycle-point --offset-hours=6 20100823T1800Z - 20100824T0000Z - - # print offset from $CYLC_TASK_CYCLE_POINT (as in workflow tasks): - $ export CYLC_TASK_CYCLE_POINT=20100823T1800Z - $ cylc cycle-point --offset-hours=-6 - 20100823T1200Z - - # cycle point filename templating, explicit template: - $ export CYLC_TASK_CYCLE_POINT=2010-08 - $ cylc cycle-point --offset-years=2 --template=foo-CCYY-MM.nc - foo-2012-08.nc - - # cycle point filename templating, template in a variable: - $ export CYLC_TASK_CYCLE_POINT=2010-08 - $ export MYTEMPLATE=foo-CCYY-MM.nc - $ cylc cycle-point --offset-years=2 --template=MYTEMPLATE - foo-2012-08.nc - - -Arguments: - [POINT] ISO8601 date-time, default=$CYLC_TASK_CYCLE_POINT - -Options: - -h, --help show this help message and exit - --offset-hours=HOURS Add N hours to CYCLE (may be negative) - --offset-days=DAYS Add N days to CYCLE (N may be negative) - --offset-months=MONTHS - Add N months to CYCLE (N may be negative) - --offset-years=YEARS Add N years to CYCLE (N may be negative) - --offset=ISO_OFFSET Add an ISO 8601-based interval representation to CYCLE - --equal=POINT2 Succeed if POINT2 is equal to POINT (format agnostic). - --template=TEMPLATE Filename template string or variable - --time-zone=TEMPLATE Control the formatting of the result's timezone (e.g. - Z, +13:00, -hh) - --num-expanded-year-digits=NUMBER - Specify a number of expanded year digits to print in - the result - --print-year Print only CCYY of result - --print-month Print only MM of result - --print-day Print only DD of result - --print-hour Print only hh of result - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. diff --git a/tests/functional/cli/04-kgo/diff.help b/tests/functional/cli/04-kgo/diff.help deleted file mode 100644 index cdeac615974..00000000000 --- a/tests/functional/cli/04-kgo/diff.help +++ /dev/null @@ -1,58 +0,0 @@ -Usage: cylc diff [OPTIONS] WORKFLOW_1 WORKFLOW_2 - -Compare two workflow configurations and display any differences. - -Differencing is done after parsing the flow.cylc files so it takes -account of default values that are not explicitly defined, it disregards -the order of configuration items, and it sees any include-file content -after inlining has occurred. - -Files in the workflow bin directory and other sub-directories of the -run directory are not currently differenced. - - -Arguments: - WORKFLOW_1 Workflow ID or path - WORKFLOW_2 Workflow ID or path - -Options: - -h, --help show this help message and exit - -n, --nested print flow.cylc section headings in nested form. - --initial-cycle-point=CYCLE_POINT or OFFSET, --icp=CYCLE_POINT or OFFSET - Set the initial cycle point. Required if not defined - in flow.cylc. May be either an absolute point or an - offset: See https://bit.ly/3MYHqVh (Cylc documentation - link). - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - -s NAME=VALUE, --set=NAME=VALUE - Set the value of a Jinja2 template variable in the - workflow definition. Values should be valid Python - literals so strings must be quoted e.g. - 'STR="string"', INT=43, BOOL=True. This option can be - used multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - -z NAME=VALUE1,VALUE2,..., --set-list=NAME=VALUE1,VALUE2,..., --template-list=NAME=VALUE1,VALUE2,... - Set the value of a Jinja2 template variable in the - workflow definition as a comma separated list of - Python strings. Values containing commas must be - quoted. e.g. '+s STR=a,b,c' => ['a', 'b', 'c'] or '+ s - STR=a,"b,c"' => ['a', 'b,c'] This option can be used - multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - --set-file=FILE Set the value of Jinja2 template variables in the - workflow definition from a file containing NAME=VALUE - pairs (one per line). As with --set values should be - valid Python literals so strings must be quoted e.g. - STR='string'. NOTE: these settings persist across - workflow restarts, but can be set again on the "cylc - play" command line if they need to be overridden. diff --git a/tests/functional/cli/04-kgo/dump.help b/tests/functional/cli/04-kgo/dump.help deleted file mode 100644 index 2d8ab40521b..00000000000 --- a/tests/functional/cli/04-kgo/dump.help +++ /dev/null @@ -1,43 +0,0 @@ -Usage: cylc dump [OPTIONS] WORKFLOW - -Print information about a running workflow. - -For command line monitoring: -* `cylc tui` -* `watch cylc dump WORKFLOW_ID` works for small simple workflows - -For more information about a specific task, such as the current state of -its prerequisites and outputs, see 'cylc show'. - -Examples: - # Display the state of all running tasks, sorted by cycle point: - $ cylc dump --tasks --sort WORKFLOW_ID | grep running - - # Display the state of all tasks in a particular cycle point: - $ cylc dump -t WORKFLOW_ID | grep 2010082406 - - -Arguments: - WORKFLOW Workflow ID - -Options: - -h, --help show this help message and exit - -g, --global Global information only. - -t, --tasks Task states only. - -f, --flows Print flow numbers with tasks. - -r, --raw, --raw-format - Display raw format. - -p, --pretty, --pretty-print - Display raw format with indents and newlines. - -s, --sort Task states only; sort by cycle point instead of name. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/ext-trigger.help b/tests/functional/cli/04-kgo/ext-trigger.help deleted file mode 100644 index 4d95c1d168b..00000000000 --- a/tests/functional/cli/04-kgo/ext-trigger.help +++ /dev/null @@ -1,40 +0,0 @@ -Usage: cylc ext-trigger [OPTIONS] WORKFLOW MSG TRIGGER_ID - -Report an external event message to a scheduler. - -External triggers allow any program to send a message to the Cylc scheduler. -Cylc can use this message as a signal that an external prerequisite has been -satisfied and trigger the task accordingly. - -The WORKFLOW argument should be unique to each external trigger event. When -an incoming message satisfies a task's external trigger the message TRIGGER_ID -is broadcast to all downstream tasks in the cycle point as -``$CYLC_EXT_TRIGGER_ID``. Tasks can use ``$CYLC_EXT_TRIGGER_ID``, for example, -to identify a new data file that the external triggering system is responding -to. - -Use the retry options in case the target workflow is down or out of contact. - -Note: to manually trigger a task use 'cylc trigger', not this command. - - -Arguments: - WORKFLOW Workflow ID - MSG External trigger message - TRIGGER_ID Unique trigger ID - -Options: - -h, --help show this help message and exit - --max-tries=INT Maximum number of send attempts (default: 5). - --retry-interval=SEC Delay in seconds before retrying (default: 10.0). - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/function-run.help b/tests/functional/cli/04-kgo/function-run.help deleted file mode 100644 index b51f4525a06..00000000000 --- a/tests/functional/cli/04-kgo/function-run.help +++ /dev/null @@ -1,9 +0,0 @@ -USAGE: cylc function-run - -(This command is for internal use.) - -Run a Python function "(*args, **kwargs)" in the process pool. It must be -defined in a module of the same name. Positional and keyword arguments must be -passed in as JSON strings. is the workflow source dir, needed to find -local xtrigger modules. - diff --git a/tests/functional/cli/04-kgo/get-resources.help b/tests/functional/cli/04-kgo/get-resources.help deleted file mode 100644 index fc99bd372ee..00000000000 --- a/tests/functional/cli/04-kgo/get-resources.help +++ /dev/null @@ -1,39 +0,0 @@ -Usage: cylc get-resources [OPTIONS] [RESOURCE] [DIR] - -Extract resources from the cylc.flow package. - -If the directory is omitted the resource will be copied either to your -current working directory for regular resources, or to the first configured -"source" directory (~/cylc-src by default) for the tutorials. - -Examples: - # list all resources - $ cylc get-resources --list - - # copy the Cylc wrapper script to the current directory: - $ cylc get-resources cylc - - # copy the Cylc wrapper script to a/b/c: - $ cylc get-resources cylc a/b/c - - # copy the "runtime-tutorial" to your "source" directory: - $ cylc get-resources tutorial/runtime-tutorial - - # copy all of the tutorials to your "source" directory: - $ cylc get-resources tutorial - - -Arguments: - [RESOURCE] Resource to extract. - [DIR] Target directory. - -Options: - -h, --help show this help message and exit - --list List available resources. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. diff --git a/tests/functional/cli/04-kgo/get-workflow-contact.help b/tests/functional/cli/04-kgo/get-workflow-contact.help deleted file mode 100644 index b761ac630b2..00000000000 --- a/tests/functional/cli/04-kgo/get-workflow-contact.help +++ /dev/null @@ -1,17 +0,0 @@ -Usage: cylc get-workflow-contact [OPTIONS] WORKFLOW - -Print contact information of a running workflow. - - -Arguments: - WORKFLOW Workflow ID - -Options: - -h, --help show this help message and exit - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. diff --git a/tests/functional/cli/04-kgo/get-workflow-version.help b/tests/functional/cli/04-kgo/get-workflow-version.help deleted file mode 100644 index a1beac516d2..00000000000 --- a/tests/functional/cli/04-kgo/get-workflow-version.help +++ /dev/null @@ -1,37 +0,0 @@ -Usage: cylc get-workflow-version [OPTIONS] WORKFLOW ... - -Find out what version of Cylc a running workflow is using. - -To find the version you've invoked at the command line see "cylc version". - -This command can operate on multiple workflows, globs may also be used: - Multiple Workflows: - # Operate on two workflows - workflow-1 workflow-2 - - Globs (note: globs should be quoted): - # Match all workflows - '*' - - # Match the workflows foo-1, foo-2 - 'foo-[12]' - - See `cylc help id` for more details. - - -Arguments: - WORKFLOW ... Workflow ID(s) - -Options: - -h, --help show this help message and exit - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/graph.help b/tests/functional/cli/04-kgo/graph.help deleted file mode 100644 index 9ab650a8d8c..00000000000 --- a/tests/functional/cli/04-kgo/graph.help +++ /dev/null @@ -1,98 +0,0 @@ -Usage: cylc graph [OPTIONS] WORKFLOW | PATH [START] [STOP] - -Produces graphical and textual representations of workflow dependencies. - -Examples: - # generate a graphical representation of workflow dependencies - # (requires graphviz to be installed in the Cylc environment) - $ cylc graph one - - # print a textual representation of the graph of the flow one - $ cylc graph one --reference - - # display the difference between the flows one and two - $ cylc graph one --diff two - - # render the graph to a svg file - $ cylc graph one -o 'one.svg' - - -Arguments: - WORKFLOW | PATH Workflow ID or path - [START] Graph start; defaults to initial cycle point - [STOP] Graph stop point or interval; defaults to 3 points from START - -Options: - -h, --help show this help message and exit - -g GROUPING, --group=GROUPING - task family to group. Can be used multiple times. Use - '' to specify all families above root. - -c, --cycles Group tasks by cycle point. - -t, --transpose Transpose graph. - -o OUTPUT Output the graph to a file. The file extension - determines the format. E.G. "graph.png", "graph.svg", - "graph.dot". - -n, --namespaces Plot the workflow namespace inheritance hierarchy - (task run time properties). - -r, --reference Output in a sorted plain text format for comparison - purposes. If not given, assume --output-file=-. - --show-suicide Show suicide triggers. Not shown by default. - --initial-cycle-point=CYCLE_POINT or OFFSET, --icp=CYCLE_POINT or OFFSET - Set the initial cycle point. Required if not defined - in flow.cylc. May be either an absolute point or an - offset: See https://bit.ly/3MYHqVh (Cylc documentation - link). - --diff=DIFF Show the difference between two workflows (implies - --reference) - --against-source Load the workflow configuration from the source - directory it was installed from using any options - (e.g. template variables) which have been set in the - installation. This is useful if you want to see how - changes made to the workflow source would affect the - installation if reinstalled. Note if this option is - used the provided workflow must have been installed by - `cylc install`. - -O OPT_CONF_KEYS, --opt-conf-key=OPT_CONF_KEYS - Use optional Rose Config Setting (If Cylc-Rose is - installed) - -D DEFINES, --define=DEFINES - Each of these overrides the `[SECTION]KEY` setting in - a `rose-suite.conf` file. Can be used to disable a - setting using the syntax `--define=[SECTION]!KEY` or - even `--define=[!SECTION]`. - -S ROSE_TEMPLATE_VARS, --rose-template-variable=ROSE_TEMPLATE_VARS, --define-suite=ROSE_TEMPLATE_VARS - As `--define`, but with an implicit `[SECTION]` for - workflow variables. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - -s NAME=VALUE, --set=NAME=VALUE - Set the value of a Jinja2 template variable in the - workflow definition. Values should be valid Python - literals so strings must be quoted e.g. - 'STR="string"', INT=43, BOOL=True. This option can be - used multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - -z NAME=VALUE1,VALUE2,..., --set-list=NAME=VALUE1,VALUE2,..., --template-list=NAME=VALUE1,VALUE2,... - Set the value of a Jinja2 template variable in the - workflow definition as a comma separated list of - Python strings. Values containing commas must be - quoted. e.g. '+s STR=a,b,c' => ['a', 'b', 'c'] or '+ s - STR=a,"b,c"' => ['a', 'b,c'] This option can be used - multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - --set-file=FILE Set the value of Jinja2 template variables in the - workflow definition from a file containing NAME=VALUE - pairs (one per line). As with --set values should be - valid Python literals so strings must be quoted e.g. - STR='string'. NOTE: these settings persist across - workflow restarts, but can be set again on the "cylc - play" command line if they need to be overridden. diff --git a/tests/functional/cli/04-kgo/hold.help b/tests/functional/cli/04-kgo/hold.help deleted file mode 100644 index 8bf4517aa7d..00000000000 --- a/tests/functional/cli/04-kgo/hold.help +++ /dev/null @@ -1,89 +0,0 @@ -Usage: cylc hold [OPTIONS] ID ... - -Hold task(s) in a workflow. - -Held tasks do not submit their jobs even if ready to run. - -To pause an entire workflow use "cylc pause". - -Examples: - # Hold mytask at cycle point 1234 in my_workflow (if it has not yet spawned, - # it will hold as soon as it spawns): - $ cylc hold my_workflow//1234/mytask - - # Hold all active tasks at cycle 1234 in my_workflow (note: tasks - # before/after this cycle point will not be held): - $ cylc hold 'my_workflow//1234/*' - - # Hold all active instances of mytask in my_workflow (note: this will not - # hold any unspawned tasks that might spawn in the future): - $ cylc hold 'my_workflow//*/mytask' - - # Hold all active failed tasks: - $ cylc hold 'my_workflow//*:failed' - - # Hold all tasks after cycle point 1234 in my_workflow: - $ cylc hold my_workflow// --after=1234 - - # Hold cycles 1, 2 & 3 in my_workflow: - $ cylc hold my_workflow// //1 //2 //3 - - # Hold cycle "1" in "my_workflow_1" and "my_workflow_2": - $ cylc hold my_workflow_1//1 my_workflow_2//1 - -Note: To pause a workflow (immediately preventing all job submission), use -'cylc pause' instead. - -See also 'cylc release'. - -This command can operate on multiple workflows, globs may also be used: - Multiple Workflows: - # Operate on two workflows - workflow-1 workflow-2 - - Globs (note: globs should be quoted): - # Match all workflows - '*' - - # Match the workflows foo-1, foo-2 - 'foo-[12]' - - See `cylc help id` for more details. - -This command can operate on multiple tasks, globs and selectors may -be used: - Multiple Tasks: - # Operate on two tasks - workflow //cycle-1/task-1 //cycle-2/task-2 - - Globs (note: globs should be quoted and only match active tasks): - # Match any the active task "foo" in all cycles - '//*/foo' - - # Match the tasks "foo-1" and "foo-2" - '//*/foo-[12]' - - Selectors (note: selectors only match active tasks): - # match all failed tasks in cycle "1" - //1:failed - - See `cylc help id` for more details. - - -Arguments: - ID ... Cycle/Family/Task ID(s) - -Options: - -h, --help show this help message and exit - --after=CYCLE_POINT Hold all tasks after this cycle point. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/install.help b/tests/functional/cli/04-kgo/install.help deleted file mode 100644 index 23b8593734f..00000000000 --- a/tests/functional/cli/04-kgo/install.help +++ /dev/null @@ -1,108 +0,0 @@ -Usage: cylc install [OPTIONS] [SOURCE_NAME | PATH] - -Install a workflow into ~/cylc-run. - -The workflow can then be started, stopped, and targeted by name. - -Normal installation creates a numbered run directory -"~/cylc-run//run". - -If a SOURCE_NAME is supplied, Cylc will search for the workflow source in the -list of directories given by "global.cylc[install]source dirs", and install -the first match. The installed workflow ID will start with SOURCE_NAME, -unless --workflow-name is used. - -If a PATH is supplied, Cylc will install the workflow from the source directory -given by the path. Relative paths must start with "./" to avoid ambiguity with -SOURCE_NAME (i.e. "foo/bar" will be interpreted as a source name, whereas -"./foo/bar" will be interpreted as a path). The installed workflow ID will -start with the basename of the path, unless --workflow-name is used. - -If no argument is supplied, Cylc will install the workflow from the source -in the current working directory. - -A "_cylc-install/source" symlink to the source directory will be created in -"~/cylc-run/". Any files or directories (excluding .git, .svn) -from the source directory are copied to the new run directory. A ".service" -directory will also be created in the run directory; this is used for server -authentication files at runtime. - -Examples: - # Install workflow "dogs/fido" from the first match in - # `global.cylc[install]source dirs`, e.g. ~/cylc-src/dogs/fido/flow.cylc, - # with run directory ~/cylc-run/dogs/fido/run1 (if "run1" already exists, - # this will increment) - $ cylc install dogs/fido - - # Install $PWD as "rabbit", if $PWD is ~/bunny/rabbit, with - # run directory ~/cylc-run/rabbit/run1 - $ cylc install - - # Install $PWD as "rabbit", if $PWD is ~/bunny/rabbit, with - # run directory ~/cylc-run/rabbit (note: no "run1" sub-directory) - $ cylc install --no-run-name - - # Install $PWD as "fido", regardless of what $PWD is called, with - # run directory ~/cylc-run/fido/run1 - $ cylc install --workflow-name=fido - - # Install $PWD/bunny/rabbit/ as "rabbit", with run directory - # ~/cylc-run/rabbit/run1 - $ cylc install ./bunny/rabbit - - # Install /home/somewhere/badger as "badger", with run directory - # ~/cylc-run/badger/run1 - $ cylc install /home/somewhere/badger - - # Install $PWD as "cats", if $PWD is ~/cats, with run directory - # ~/cylc-run/cats/paws - $ cylc install --run-name=paws - -The same workflow can be installed with multiple names; this results in -multiple workflow run directories that link to the same workflow definition. - - -Arguments: - [SOURCE_NAME | PATH] Workflow source name or path to source directory - -Options: - -h, --help show this help message and exit - -O OPT_CONF_KEYS, --opt-conf-key=OPT_CONF_KEYS - Use optional Rose Config Setting (If Cylc-Rose is - installed) - -D DEFINES, --define=DEFINES - Each of these overrides the `[SECTION]KEY` setting in - a `rose-suite.conf` file. Can be used to disable a - setting using the syntax `--define=[SECTION]!KEY` or - even `--define=[!SECTION]`. - -S ROSE_TEMPLATE_VARS, --rose-template-variable=ROSE_TEMPLATE_VARS, --define-suite=ROSE_TEMPLATE_VARS - As `--define`, but with an implicit `[SECTION]` for - workflow variables. - -n WORKFLOW_NAME, --workflow-name=WORKFLOW_NAME - Install into ~/cylc-run//runN - --symlink-dirs=SYMLINK_DIRS - Enter a comma-delimited list, in the form - 'log=path/to/store, share = $HOME/some/path, ...'. Use - this option to override the global.cylc configuration - for local symlinks for the run, log, work, share and - share/cycle directories. Enter an empty list '' to - skip making localhost symlink dirs. - -r RUN_NAME, --run-name=RUN_NAME - Give the run a custom name instead of automatically - numbering it. - --no-run-name Install the workflow directly into ~/cylc- - run/, without an automatic run number - or custom run name. - --no-ping When scanning for active instances of the workflow, do - not attempt to contact the schedulers to get status. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/jobs-kill.help b/tests/functional/cli/04-kgo/jobs-kill.help deleted file mode 100644 index 1e07df8f6ed..00000000000 --- a/tests/functional/cli/04-kgo/jobs-kill.help +++ /dev/null @@ -1,22 +0,0 @@ -Usage: cylc jobs-kill [OPTIONS] JOB-LOG-ROOT [JOB-LOG-DIR ...] - -(This command is for internal use. Users should use "cylc kill".) - -Read job status files to obtain the names of the job runners and the job IDs -in the runners. Invoke the relevant job runner commands to ask the job runners -to terminate the jobs. - - -Arguments: - JOB-LOG-ROOT The log/job sub-directory for the workflow - [JOB-LOG-DIR ...] A point/name/submit_num sub-directory - -Options: - -h, --help show this help message and exit - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. diff --git a/tests/functional/cli/04-kgo/jobs-poll.help b/tests/functional/cli/04-kgo/jobs-poll.help deleted file mode 100644 index aeb0b802a11..00000000000 --- a/tests/functional/cli/04-kgo/jobs-poll.help +++ /dev/null @@ -1,21 +0,0 @@ -Usage: cylc jobs-poll [OPTIONS] JOB-LOG-ROOT [JOB-LOG-DIR ...] - -(This command is for internal use. Users should use "cylc poll".) - -Read job status files to obtain the statuses of the jobs. If necessary, Invoke -the relevant job runner commands to ask the job runners for more statuses. - - -Arguments: - JOB-LOG-ROOT The log/job sub-directory for the workflow - [JOB-LOG-DIR ...] A point/name/submit_num sub-directory - -Options: - -h, --help show this help message and exit - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. diff --git a/tests/functional/cli/04-kgo/jobs-submit.help b/tests/functional/cli/04-kgo/jobs-submit.help deleted file mode 100644 index 5048522810f..00000000000 --- a/tests/functional/cli/04-kgo/jobs-submit.help +++ /dev/null @@ -1,28 +0,0 @@ -Usage: cylc jobs-submit [OPTIONS] JOB-LOG-ROOT [JOB-LOG-DIR ...] - -(This command is for internal use.) - -Submit jobs to relevant job runners. -On a remote job host, this command reads the job files from STDIN. - - -Arguments: - JOB-LOG-ROOT The log/job sub-directory for the workflow - [JOB-LOG-DIR ...] A point/name/submit_num sub-directory - -Options: - -h, --help show this help message and exit - --remote-mode Is this being run on a remote job host? - --utc-mode (for remote mode) is the workflow running in UTC mode? - --clean-env Clean job submission environment. - --env=VAR=VALUE Variable to pass from parent environment to job submit - environment. This option can be used multiple times. - --path=PATH Executable location to pass to job submit environment. - This option can be used multiple times. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. diff --git a/tests/functional/cli/04-kgo/kill.help b/tests/functional/cli/04-kgo/kill.help deleted file mode 100644 index 55d91549ddf..00000000000 --- a/tests/functional/cli/04-kgo/kill.help +++ /dev/null @@ -1,64 +0,0 @@ -Usage: cylc kill [OPTIONS] ID ... - -Kill running or submitted jobs. - -Examples: - # kill a specific task in my_workflow - $ cylc kill my_workflow//1/a - - # kill multiple tasks in my_workflow - $ cylc kill myflow// //1/a //1/b //1/c - - # kill all active tasks in the my_workflow - $ cylc kill 'my_workflow//*' - -This command can operate on multiple workflows, globs may also be used: - Multiple Workflows: - # Operate on two workflows - workflow-1 workflow-2 - - Globs (note: globs should be quoted): - # Match all workflows - '*' - - # Match the workflows foo-1, foo-2 - 'foo-[12]' - - See `cylc help id` for more details. - -This command can operate on multiple tasks, globs and selectors may -be used: - Multiple Tasks: - # Operate on two tasks - workflow //cycle-1/task-1 //cycle-2/task-2 - - Globs (note: globs should be quoted and only match active tasks): - # Match any the active task "foo" in all cycles - '//*/foo' - - # Match the tasks "foo-1" and "foo-2" - '//*/foo-[12]' - - Selectors (note: selectors only match active tasks): - # match all failed tasks in cycle "1" - //1:failed - - See `cylc help id` for more details. - - -Arguments: - ID ... Cycle/Family/Task ID(s) - -Options: - -h, --help show this help message and exit - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/lint.help b/tests/functional/cli/04-kgo/lint.help deleted file mode 100644 index b96ef6e9ddd..00000000000 --- a/tests/functional/cli/04-kgo/lint.help +++ /dev/null @@ -1,40 +0,0 @@ -Usage: cylc lint [OPTIONS] [WORKFLOW | PATH] - -Check .cylc and .rc files for code style, deprecated syntax and other issues. - -By default, suggestions are written to stdout. - -In-place mode ("-i, --inplace") writes suggestions into the file as comments. -Commit to version control before using this, in case you want to back out. - -A non-zero return code will be returned if any issues are identified. -This can be overridden by providing the "--exit-zero" flag. - -pyproject.toml configuration: - [cylc-lint] # any of ['cylc-lint', 'cylclint', 'cylc_lint'] - ignore = ['S001', 'S002'] # List of rules to ignore - exclude = ['etc/foo.cylc'] # List of files to ignore - rulesets = ['style', '728'] # Sets default rulesets to check - max-line-length = 130 # Max line length for linting - - -Arguments: - [WORKFLOW | PATH] Workflow ID or path - -Options: - -h, --help show this help message and exit - -i, --inplace Modify files in place, adding comments to files. If - not set, the script will work as a linter - -r LINTER, --ruleset=LINTER - Set of rules to use: ("728", "style", "all") - --list-codes List all linter codes. - -n CODE, --ignore=CODE - Ignore this check number. - --exit-zero Exit with status code "0" even if there are issues. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. diff --git a/tests/functional/cli/04-kgo/list.help b/tests/functional/cli/04-kgo/list.help deleted file mode 100644 index e853fd2be08..00000000000 --- a/tests/functional/cli/04-kgo/list.help +++ /dev/null @@ -1,91 +0,0 @@ -Usage: cylc list [OPTIONS] WORKFLOW | PATH - -List tasks and families defined in a workflow. - -Print runtime namespace names (tasks and families), the first-parent -inheritance graph, or actual tasks for a given cycle range. - -The first-parent inheritance graph determines the primary task family -groupings that are collapsible in cylc visualisation tools. - -To visualize the full multiple inheritance hierarchy use: - $ cylc graph -n - - -Arguments: - WORKFLOW | PATH Workflow ID or path - -Options: - -h, --help show this help message and exit - -a, --all-tasks Print all tasks, not just those used in the graph. - -n, --all-namespaces Print all runtime namespaces, not just tasks. - -m, --mro Print the linear "method resolution order" for each - namespace (the multiple-inheritance precedence order - as determined by the C3 linearization algorithm). - -t, --tree Print the first-parent inheritance hierarchy in tree - form. - -b, --box With -t/--tree, using unicode box characters. Your - terminal must be able to display unicode characters. - -w, --with-titles Print namespaces titles too. - -p [START],[STOP], --points=[START],[STOP] - Print task IDs from [START] to [STOP] cycle points. - Both bounds are optional and STOP can be an interval - from START (or from the initial cycle point, by - default). Use '-p , ' for the default range. - --against-source Load the workflow configuration from the source - directory it was installed from using any options - (e.g. template variables) which have been set in the - installation. This is useful if you want to see how - changes made to the workflow source would affect the - installation if reinstalled. Note if this option is - used the provided workflow must have been installed by - `cylc install`. - --initial-cycle-point=CYCLE_POINT or OFFSET, --icp=CYCLE_POINT or OFFSET - Set the initial cycle point. Required if not defined - in flow.cylc. May be either an absolute point or an - offset: See https://bit.ly/3MYHqVh (Cylc documentation - link). - -O OPT_CONF_KEYS, --opt-conf-key=OPT_CONF_KEYS - Use optional Rose Config Setting (If Cylc-Rose is - installed) - -D DEFINES, --define=DEFINES - Each of these overrides the `[SECTION]KEY` setting in - a `rose-suite.conf` file. Can be used to disable a - setting using the syntax `--define=[SECTION]!KEY` or - even `--define=[!SECTION]`. - -S ROSE_TEMPLATE_VARS, --rose-template-variable=ROSE_TEMPLATE_VARS, --define-suite=ROSE_TEMPLATE_VARS - As `--define`, but with an implicit `[SECTION]` for - workflow variables. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - -s NAME=VALUE, --set=NAME=VALUE - Set the value of a Jinja2 template variable in the - workflow definition. Values should be valid Python - literals so strings must be quoted e.g. - 'STR="string"', INT=43, BOOL=True. This option can be - used multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - -z NAME=VALUE1,VALUE2,..., --set-list=NAME=VALUE1,VALUE2,..., --template-list=NAME=VALUE1,VALUE2,... - Set the value of a Jinja2 template variable in the - workflow definition as a comma separated list of - Python strings. Values containing commas must be - quoted. e.g. '+s STR=a,b,c' => ['a', 'b', 'c'] or '+ s - STR=a,"b,c"' => ['a', 'b,c'] This option can be used - multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - --set-file=FILE Set the value of Jinja2 template variables in the - workflow definition from a file containing NAME=VALUE - pairs (one per line). As with --set values should be - valid Python literals so strings must be quoted e.g. - STR='string'. NOTE: these settings persist across - workflow restarts, but can be set again on the "cylc - play" command line if they need to be overridden. diff --git a/tests/functional/cli/04-kgo/pause.help b/tests/functional/cli/04-kgo/pause.help deleted file mode 100644 index 06170e5b3c0..00000000000 --- a/tests/functional/cli/04-kgo/pause.help +++ /dev/null @@ -1,47 +0,0 @@ -Usage: cylc pause [OPTIONS] WORKFLOW ... - -Pause a workflow. - -This suspends submission of all tasks in a workflow. - -Examples: - # pause my_workflow - $ cylc pause my_workflow - - # resume my_workflow - $ cylc play my_workflow - -(Not to be confused with `cylc hold` which suspends submission of individual -tasks within a workflow). - -This command can operate on multiple workflows, globs may also be used: - Multiple Workflows: - # Operate on two workflows - workflow-1 workflow-2 - - Globs (note: globs should be quoted): - # Match all workflows - '*' - - # Match the workflows foo-1, foo-2 - 'foo-[12]' - - See `cylc help id` for more details. - - -Arguments: - WORKFLOW ... Workflow ID(s) - -Options: - -h, --help show this help message and exit - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/ping.help b/tests/functional/cli/04-kgo/ping.help deleted file mode 100644 index 42c8f30c4d1..00000000000 --- a/tests/functional/cli/04-kgo/ping.help +++ /dev/null @@ -1,57 +0,0 @@ -Usage: cylc ping [OPTIONS] ID ... - -Test communication with a running workflow. - -If workflow WORKFLOW is running or TASK in WORKFLOW is currently running, -exit with success status, else exit with error status. - -This command can operate on multiple workflows, globs may also be used: - Multiple Workflows: - # Operate on two workflows - workflow-1 workflow-2 - - Globs (note: globs should be quoted): - # Match all workflows - '*' - - # Match the workflows foo-1, foo-2 - 'foo-[12]' - - See `cylc help id` for more details. - -This command can operate on multiple tasks, globs and selectors may -be used: - Multiple Tasks: - # Operate on two tasks - workflow //cycle-1/task-1 //cycle-2/task-2 - - Globs (note: globs should be quoted and only match active tasks): - # Match any the active task "foo" in all cycles - '//*/foo' - - # Match the tasks "foo-1" and "foo-2" - '//*/foo-[12]' - - Selectors (note: selectors only match active tasks): - # match all failed tasks in cycle "1" - //1:failed - - See `cylc help id` for more details. - - -Arguments: - ID ... Cycle/Family/Task ID(s) - -Options: - -h, --help show this help message and exit - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/play.help b/tests/functional/cli/04-kgo/play.help deleted file mode 100644 index bf08327fa26..00000000000 --- a/tests/functional/cli/04-kgo/play.help +++ /dev/null @@ -1,152 +0,0 @@ -Usage: cylc play [OPTIONS] WORKFLOW - -Start, resume, or restart a workflow. - -The scheduler will run as a daemon unless you specify --no-detach. - -To avoid overwriting existing run directories, workflows that already ran can -only be restarted from prior state. To start again, "cylc install" a new copy -or "cylc clean" the existing run directory. - -By default, new runs begin at the start of the graph, determined by the initial -cycle point. You can also begin at a later cycle point (--start-cycle-point), -or at specified tasks (--start-task) within the graph. - -For convenience, any dependence on tasks prior to the start cycle point (or to -the cycle point of the earliest task specified by --start-task) will be taken -as satisfied. - -Examples: - # Start (at the initial cycle point), restart, or resume workflow WORKFLOW - $ cylc play WORKFLOW - - # Start a new run from a cycle point after the initial cycle point - # (integer cycling) - $ cylc play --start-cycle-point=3 WORKFLOW - # (datetime cycling): - $ cylc play --start-cycle-point=20250101T0000Z WORKFLOW - - # Start a new run from specified tasks in the graph - $ cylc play --start-task=3/foo WORKFLOW - $ cylc play -t 3/foo -t 3/bar WORKFLOW - - # Start, restart or resume the second installed run of the workflow - # "dogs/fido" - $ cylc play dogs/fido/run2 - -At restart, tasks recorded as submitted or running are polled to determine what -happened to them while the workflow was down. - - -Arguments: - WORKFLOW Workflow ID - -Options: - -h, --help show this help message and exit - -O OPT_CONF_KEYS, --opt-conf-key=OPT_CONF_KEYS - Use optional Rose Config Setting (If Cylc-Rose is - installed) - -D DEFINES, --define=DEFINES - Each of these overrides the `[SECTION]KEY` setting in - a `rose-suite.conf` file. Can be used to disable a - setting using the syntax `--define=[SECTION]!KEY` or - even `--define=[!SECTION]`. - -S ROSE_TEMPLATE_VARS, --rose-template-variable=ROSE_TEMPLATE_VARS, --define-suite=ROSE_TEMPLATE_VARS - As `--define`, but with an implicit `[SECTION]` for - workflow variables. - -N, --no-detach, --non-daemon - Do not daemonize the scheduler (infers --format=plain) - --profile Output profiling (performance) information - --start-cycle-point=CYCLE_POINT, --startcp=CYCLE_POINT - Set the start cycle point, which may be after the - initial cycle point. If the specified start point is - not in the sequence, the next on-sequence point will - be used. (Not to be confused with the initial cycle - point) - --final-cycle-point=CYCLE_POINT, --fcp=CYCLE_POINT - Set the final cycle point. This command line option - overrides the workflow config option - '[scheduling]final cycle point'. - --stop-cycle-point=CYCLE_POINT, --stopcp=CYCLE_POINT - Set the stop cycle point. Shut down after all have - PASSED this cycle point. (Not to be confused the final - cycle point.) This command line option overrides the - workflow config option '[scheduling]stop after cycle - point'. - -t TASK_ID, --start-task=TASK_ID, --starttask=TASK_ID - Start from this task instance, given by - '/'. This can be used multiple times to - start from multiple tasks at once. Dependence on tasks - with cycle points earlier than the earliest start-task - will be ignored. A sub-graph of the workflow will run - if selected tasks do not lead on to the full graph. - --pause Pause the workflow immediately on start up. - --hold-after=CYCLE_POINT, --hold-cycle-point=CYCLE_POINT, --holdcp=CYCLE_POINT - Hold all tasks after this cycle point. - --reference-log Generate a reference log for use in reference - --reference-test Do a test run against a previously generated - reference. - --host=HOST Specify the host on which to start-up the workflow. If - not specified, a host will be selected using the - '[scheduler]run hosts' global config. - --format=FORMAT The format of the output: 'plain'=human readable, - 'json' - --main-loop=PLUGIN_NAME - Specify an additional plugin to run in the main These - are used in combination with those specified - [scheduler][main loop]plugins. Can be used multiple - times. - --abort-if-any-task-fails - If set workflow will abort with status 1 if any task - fails. - --initial-cycle-point=CYCLE_POINT or OFFSET, --icp=CYCLE_POINT or OFFSET - Set the initial cycle point. Required if not defined - in flow.cylc. May be either an absolute point or an - offset: See https://bit.ly/3MYHqVh (Cylc documentation - link). - -m STRING, --mode=STRING - Run mode: live, dummy, simulation (default live). - --downgrade Allow the workflow to be restarted with an older - version of Cylc, NOT RECOMMENDED. By default Cylc - prevents you from restarting a workflow with an older - version of Cylc than it was previously run with. Use - this flag to disable this check. - --upgrade Allow the workflow to be restarted with a newer - version of Cylc. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. - -s NAME=VALUE, --set=NAME=VALUE - Set the value of a Jinja2 template variable in the - workflow definition. Values should be valid Python - literals so strings must be quoted e.g. - 'STR="string"', INT=43, BOOL=True. This option can be - used multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - -z NAME=VALUE1,VALUE2,..., --set-list=NAME=VALUE1,VALUE2,..., --template-list=NAME=VALUE1,VALUE2,... - Set the value of a Jinja2 template variable in the - workflow definition as a comma separated list of - Python strings. Values containing commas must be - quoted. e.g. '+s STR=a,b,c' => ['a', 'b', 'c'] or '+ s - STR=a,"b,c"' => ['a', 'b,c'] This option can be used - multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - --set-file=FILE Set the value of Jinja2 template variables in the - workflow definition from a file containing NAME=VALUE - pairs (one per line). As with --set values should be - valid Python literals so strings must be quoted e.g. - STR='string'. NOTE: these settings persist across - workflow restarts, but can be set again on the "cylc - play" command line if they need to be overridden. diff --git a/tests/functional/cli/04-kgo/poll.help b/tests/functional/cli/04-kgo/poll.help deleted file mode 100644 index 873e1607239..00000000000 --- a/tests/functional/cli/04-kgo/poll.help +++ /dev/null @@ -1,66 +0,0 @@ -Usage: cylc poll [OPTIONS] ID ... - -Poll (query) jobs to verify and update their statuses. - -This checks the job status file and queries the job runner on the job platform. - -Pollable tasks are those in the n=0 window with an associated job ID, -including incomplete finished tasks. - -Examples: - # poll all pollable tasks in my_workflow - $ cylc poll 'my_workflow//*' - - # poll specific tasks in my_workflow - $ cylc poll my_workflow// //1/a //1/b - -This command can operate on multiple workflows, globs may also be used: - Multiple Workflows: - # Operate on two workflows - workflow-1 workflow-2 - - Globs (note: globs should be quoted): - # Match all workflows - '*' - - # Match the workflows foo-1, foo-2 - 'foo-[12]' - - See `cylc help id` for more details. - -This command can operate on multiple tasks, globs and selectors may -be used: - Multiple Tasks: - # Operate on two tasks - workflow //cycle-1/task-1 //cycle-2/task-2 - - Globs (note: globs should be quoted and only match active tasks): - # Match any the active task "foo" in all cycles - '//*/foo' - - # Match the tasks "foo-1" and "foo-2" - '//*/foo-[12]' - - Selectors (note: selectors only match active tasks): - # match all failed tasks in cycle "1" - //1:failed - - See `cylc help id` for more details. - - -Arguments: - ID ... Cycle/Family/Task ID(s) - -Options: - -h, --help show this help message and exit - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/psutils.help b/tests/functional/cli/04-kgo/psutils.help deleted file mode 100644 index 34ea5065572..00000000000 --- a/tests/functional/cli/04-kgo/psutils.help +++ /dev/null @@ -1,15 +0,0 @@ -Usage: Report system utilisation information. - -(This command is for internal use.) - -This is for use in situations where Cylc needs to extract information from -the `psutil` on remote platforms. - -Exits: - 0 - If successful. - 2 - For errors in extracting results from psutil - 1 - For all other errors. - - -Options: - -h, --help show this help message and exit diff --git a/tests/functional/cli/04-kgo/reinstall.help b/tests/functional/cli/04-kgo/reinstall.help deleted file mode 100644 index 23ca69e9039..00000000000 --- a/tests/functional/cli/04-kgo/reinstall.help +++ /dev/null @@ -1,82 +0,0 @@ -Usage: cylc reinstall [OPTIONS] WORKFLOW - -Reinstall a previously installed workflow. - -Examples: - # Having previously installed: - $ cylc install myflow - - # To reinstall the latest run: - $ cylc reinstall myflow - - # Or, to reinstall a specific run: - $ cylc reinstall myflow/run2 - - # If the workflow is running: - $ cylc reinstall myflow # reinstall as usual - $ cylc reload myflow # pick up changes in the workflow config - -What reinstall does: - Reinstall synchronises files between the workflow source and the specified - run directory. - - Any files which have been added, updated or removed in the source directory - will be added, updated or removed in the run directory. Cylc uses "rsync" - to do this (run in "--debug" mode to see the exact command used). - -How changes are displayed: - Reinstall will first perform a dry run showing the files it would change. - This is displayed in "rsync" format e.g: - - send foo # this means the file "foo" would be added/updated - del. bar # this means the file "bar" would be deleted - -How to prevent reinstall deleting files: - Reinstall will delete any files which are not present in the source directory - (i.e. if you delete a file from the source directory, a reinstall would - remove the file from the run directory too). The "work/" and "share/" - directory are excluded from this. These are the recommended locations for any - files created at runtime. - - You can extend the list of "excluded" paths by creating a ".cylcignore" file. - For example the following file would exclude "data/" and any ".csv" files - from being overwritten by a reinstallation: - - $ cat .cylcignore - data - *.csv - - Note any paths listed in ".cylcignore" will not be installed by - "cylc install" even if present in the source directory. - - -Arguments: - WORKFLOW Workflow ID - -Options: - -h, --help show this help message and exit - -O OPT_CONF_KEYS, --opt-conf-key=OPT_CONF_KEYS - Use optional Rose Config Setting (If Cylc-Rose is - installed) - -D DEFINES, --define=DEFINES - Each of these overrides the `[SECTION]KEY` setting in - a `rose-suite.conf` file. Can be used to disable a - setting using the syntax `--define=[SECTION]!KEY` or - even `--define=[!SECTION]`. - -S ROSE_TEMPLATE_VARS, --rose-template-variable=ROSE_TEMPLATE_VARS, --define-suite=ROSE_TEMPLATE_VARS - As `--define`, but with an implicit `[SECTION]` for - workflow variables. - --clear-rose-install-options - Clear options previously set by cylc-rose. - --yes Skip interactive prompts. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/release.help b/tests/functional/cli/04-kgo/release.help deleted file mode 100644 index 3bd286b5e7a..00000000000 --- a/tests/functional/cli/04-kgo/release.help +++ /dev/null @@ -1,73 +0,0 @@ -Usage: cylc release [OPTIONS] ID ... - -Release held tasks in a workflow. - -Examples: - # Release mytask at cycle 1234 in my_workflow - $ cylc release my_workflow//1234/mytask - - # Release all active tasks at cycle 1234 in my_workflow - $ cylc release 'my_workflow//1234/*' - - # Release all active instances of mytask in my_workflow - $ cylc release 'my_workflow//*/mytask' - - # Release all held tasks and remove the hold point - $ cylc release my_workflow --all - -Held tasks do not submit their jobs even if ready to run. - -See also 'cylc hold'. - -This command can operate on multiple workflows, globs may also be used: - Multiple Workflows: - # Operate on two workflows - workflow-1 workflow-2 - - Globs (note: globs should be quoted): - # Match all workflows - '*' - - # Match the workflows foo-1, foo-2 - 'foo-[12]' - - See `cylc help id` for more details. - -This command can operate on multiple tasks, globs and selectors may -be used: - Multiple Tasks: - # Operate on two tasks - workflow //cycle-1/task-1 //cycle-2/task-2 - - Globs (note: globs should be quoted and only match active tasks): - # Match any the active task "foo" in all cycles - '//*/foo' - - # Match the tasks "foo-1" and "foo-2" - '//*/foo-[12]' - - Selectors (note: selectors only match active tasks): - # match all failed tasks in cycle "1" - //1:failed - - See `cylc help id` for more details. - - -Arguments: - ID ... Cycle/Family/Task ID(s) - -Options: - -h, --help show this help message and exit - --all Release all held tasks and remove the 'hold after - cycle point', if set. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/reload.help b/tests/functional/cli/04-kgo/reload.help deleted file mode 100644 index 35b8170ec74..00000000000 --- a/tests/functional/cli/04-kgo/reload.help +++ /dev/null @@ -1,65 +0,0 @@ -Usage: cylc reload [OPTIONS] WORKFLOW ... - -Reload the configuration of a running workflow. - -Example: - # install and run the workflow - $ cylc install - $ cylc play my_workflow - - # make changes to the workflow source directory - - # reinstall the workflow - $ cylc reinstall my_workflow - - # reload the workflow to pick up changes - $ cylc reload my_workflow - # the workflow is now running with the new config - -All settings including task definitions, with the exception of workflow log -config, can be changed on reload. Changes to task definitions take effect -immediately, unless a task is already running at reload time. - -Upon reload, remote file installation will be triggered for all relevant -platforms on the next job submit. Any changed files that are configured to be -included in the file installation will be transferred to the appropriate remote -platform(s). - -If the workflow was started with Jinja2 template variables set on the command -line (cylc play --set 'FOO="bar"' WORKFLOW_ID) the same template settings apply -to the reload (only changes to the flow.cylc file itself are reloaded). - -If the modified workflow definition does not parse, failure to reload will -be reported but no harm will be done to the running workflow. - -This command can operate on multiple workflows, globs may also be used: - Multiple Workflows: - # Operate on two workflows - workflow-1 workflow-2 - - Globs (note: globs should be quoted): - # Match all workflows - '*' - - # Match the workflows foo-1, foo-2 - 'foo-[12]' - - See `cylc help id` for more details. - - -Arguments: - WORKFLOW ... Workflow ID(s) - -Options: - -h, --help show this help message and exit - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/remote-init.help b/tests/functional/cli/04-kgo/remote-init.help deleted file mode 100644 index c77a1edc124..00000000000 --- a/tests/functional/cli/04-kgo/remote-init.help +++ /dev/null @@ -1,32 +0,0 @@ -Usage: cylc remote-init [OPTIONS] INSTALL_TARGET RUND [DIRS_TO_BE_SYMLINKED ...] - -(This command is for internal use.) - -Initialise an install target. - -Initialisation creates a workflow run directory on the install target, -"$HOME/cylc-run//". The .service directory is also created and -populated with the install target authentication files and the contact file. - -Symlinks are created for run, work, share, share/cycle, log directories, -configured in the global.flow. - -Return: - 0: - On success or if initialisation not required: - - Print task_remote_cmd.REMOTE_INIT_DONE - 1: - On failure. - - -Arguments: - INSTALL_TARGET Target to be initialised - RUND The run directory of the workflow - [DIRS_TO_BE_SYMLINKED ...] Directories to be symlinked - -Options: - -h, --help show this help message and exit - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. diff --git a/tests/functional/cli/04-kgo/remote-tidy.help b/tests/functional/cli/04-kgo/remote-tidy.help deleted file mode 100644 index 2b160da0cf7..00000000000 --- a/tests/functional/cli/04-kgo/remote-tidy.help +++ /dev/null @@ -1,22 +0,0 @@ -Usage: cylc remote-tidy [OPTIONS] INSTALL_TARGET RUND - -(This command is for internal use.) - -Remove ".service/contact" from a task remote (i.e. a [owner@]host). -Remove ".service" directory on the remote if emptied. -Remove authentication keys. - - -Arguments: - INSTALL_TARGET target platform to be tidied - RUND The run directory of the workflow - -Options: - -h, --help show this help message and exit - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. diff --git a/tests/functional/cli/04-kgo/remove.help b/tests/functional/cli/04-kgo/remove.help deleted file mode 100644 index ddc3580dc97..00000000000 --- a/tests/functional/cli/04-kgo/remove.help +++ /dev/null @@ -1,54 +0,0 @@ -Usage: cylc remove [OPTIONS] ID ... - -Remove one or more task instances from a running workflow. - -This command can operate on multiple workflows, globs may also be used: - Multiple Workflows: - # Operate on two workflows - workflow-1 workflow-2 - - Globs (note: globs should be quoted): - # Match all workflows - '*' - - # Match the workflows foo-1, foo-2 - 'foo-[12]' - - See `cylc help id` for more details. - -This command can operate on multiple tasks, globs and selectors may -be used: - Multiple Tasks: - # Operate on two tasks - workflow //cycle-1/task-1 //cycle-2/task-2 - - Globs (note: globs should be quoted and only match active tasks): - # Match any the active task "foo" in all cycles - '//*/foo' - - # Match the tasks "foo-1" and "foo-2" - '//*/foo-[12]' - - Selectors (note: selectors only match active tasks): - # match all failed tasks in cycle "1" - //1:failed - - See `cylc help id` for more details. - - -Arguments: - ID ... Cycle/Family/Task ID(s) - -Options: - -h, --help show this help message and exit - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/report-timings.help b/tests/functional/cli/04-kgo/report-timings.help deleted file mode 100644 index fc9a10d161a..00000000000 --- a/tests/functional/cli/04-kgo/report-timings.help +++ /dev/null @@ -1,50 +0,0 @@ -Usage: cylc report-timings [OPTIONS] WORKFLOW - -Display workflow timing information. - -Retrieve workflow timing information for wait and run time performance -analysis. Raw output and summary output (in text or HTML format) are available. -Output is sent to standard output, unless an output filename is supplied. - -Summary Output (the default): - Data stratified by host and job runner that provides a statistical - summary of: - 1. Queue wait time (duration between task submission and start times) - 2. Task run time (duration between start and succeed times) - 3. Total run time (duration between task submission and succeed times) - Summary tables can be output in plain text format, or HTML with embedded SVG - boxplots. Both summary options require the Pandas library, and the HTML - summary option requires the Matplotlib library. - -Raw Output: - A flat list of tabular data that provides (for each task and cycle) the - 1. Time of successful submission - 2. Time of task start - 3. Time of task successful completion - as well as information about the job runner and remote host to permit - stratification/grouping if desired by downstream processors. - -Timings are shown only for succeeded tasks. - -For long-running or large workflows (i.e. workflows with many task events), -the database query to obtain the timing information may take some time. - - -Arguments: - WORKFLOW Workflow ID - -Options: - -h, --help show this help message and exit - -r, --raw Show raw timing output suitable for custom - diagnostics. - -s, --summary Show textual summary timing output for tasks. - -w, --web-summary Show HTML summary timing output for tasks. - -O OUTPUT_FILENAME, --output-file=OUTPUT_FILENAME - Output to a specific file - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. diff --git a/tests/functional/cli/04-kgo/scan.help b/tests/functional/cli/04-kgo/scan.help deleted file mode 100644 index d6e44b0a923..00000000000 --- a/tests/functional/cli/04-kgo/scan.help +++ /dev/null @@ -1,86 +0,0 @@ -Usage: cylc scan [OPTIONS] - -List your source, and/or installed, and/or running workflows. - -By default, running workflows are listed as indicated by the presence of -scheduler contact files, ~/cylc-run//.service/contact. - -With "--ping" or "-t rich", attempt to contact the schedulers. If any are not -found to be running, their contact files will be removed (these files may left -behind if the scheduler did not shut down cleanly). - -Examples: - # list all active workflows (i.e. running or paused) - $ cylc scan - - # show more information about active workflows - $ cylc scan -t rich - - # don't rely on colour for job state totals - $ cylc scan -t rich --colour-blind - - # list workflows that are installed but stopped or not run yet - $ cylc scan --state stopped - - # list all workflows (active or inactive) - $ cylc scan --state=running,paused,stopped - $ cylc scan --state=all # or using the shorthand - - # filter workflows by name - $ cylc scan --name '^f.*' # show only flows starting with "f" - - # list source workflows in tree format - # (looks in the dirs configured by "global.cylc[install]source dirs") - $ cylc scan --source -t tree - - # print contact file data in JSON format - $ cylc scan -t json - -Workflow States: - ▶ running - ◧ stopping - ■ stopped - ‖ paused - -Task States: - ■ submitted - ■ submit-failed - ■ running - ■ succeeded - ■ failed - -Options: - -h, --help show this help message and exit - -n NAME, --name=NAME Filter workflows by registered name using a regex. Can - be used multiple times, workflows will be displayed if - their name matches ANY of the provided regexes. - --states=STATES Choose which workflows to display by providing a list - of states or "all" to show everything. See the full - `cylc scan` help for a list of supported states. - -s, --source List source workflows from configured source - directories (overrides the --states option). - -t FORMAT, --format=FORMAT - Output data and format (default "plain"). ("name": - list the workflow IDs only) ("plain": - name,host:port,PID on one line) ("tree": - name,host:port,PID in tree format) ("json": full - contact data in JSON format) ("rich": include task - state summary data) - --sort Sort flows by name before writing them (takes longer). - --colour-blind, --color-blind - Don't depend on colour to convey information. Use this - rather than --color=never so you still get bold text. - --ping Connect to schedulers and remove contact files if they - are not found to be running. Contact files can be left - behind when schedulers get killed. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/set-outputs.help b/tests/functional/cli/04-kgo/set-outputs.help deleted file mode 100644 index 856bedc2bd0..00000000000 --- a/tests/functional/cli/04-kgo/set-outputs.help +++ /dev/null @@ -1,83 +0,0 @@ -Usage: cylc set-outputs [OPTIONS] ID ... - -Artificially satisfy task outputs. - -Mark task outputs as completed and spawn downstream tasks that depend on those -outputs. By default it marks tasks as succeeded. - -This allows you to manually intervene with Cylc's scheduling algorithm by -artificially satisfying outputs of tasks. - -If a flow number is given, the child tasks will start (or continue) that flow. - -Examples: - # For example, for the following dependency graph: - R1 = ''' - a => b & c => d - foo:x => bar => baz - ''' - - # spawn 1/b and 1/c, but 1/d will not subsequently run - $ cylc set-outputs my_workflow//1/a - - # spawn 1/b and 1/c as flow 2, followed by 1/d - $ cylc set-outputs --flow=2 my_workflow//1/a - - # spawn 1/bar as flow 3, followed by 1/baz - $ cylc set-outputs --flow=3 --output=x my_workflow//1/foo - -Use --output multiple times to spawn off of several outputs at once. - -This command can operate on multiple workflows, globs may also be used: - Multiple Workflows: - # Operate on two workflows - workflow-1 workflow-2 - - Globs (note: globs should be quoted): - # Match all workflows - '*' - - # Match the workflows foo-1, foo-2 - 'foo-[12]' - - See `cylc help id` for more details. - -This command can operate on multiple tasks, globs and selectors may -be used: - Multiple Tasks: - # Operate on two tasks - workflow //cycle-1/task-1 //cycle-2/task-2 - - Globs (note: globs should be quoted and only match active tasks): - # Match any the active task "foo" in all cycles - '//*/foo' - - # Match the tasks "foo-1" and "foo-2" - '//*/foo-[12]' - - Selectors (note: selectors only match active tasks): - # match all failed tasks in cycle "1" - //1:failed - - See `cylc help id` for more details. - - -Arguments: - ID ... Cycle/Family/Task ID(s) - -Options: - -h, --help show this help message and exit - -o OUTPUT, --output=OUTPUT - Set OUTPUT (default "succeeded") completed. - -f FLOW, --flow=FLOW Number of the flow to attribute the outputs. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/set-verbosity.help b/tests/functional/cli/04-kgo/set-verbosity.help deleted file mode 100644 index 0a945b976d5..00000000000 --- a/tests/functional/cli/04-kgo/set-verbosity.help +++ /dev/null @@ -1,40 +0,0 @@ -Usage: cylc set-verbosity [OPTIONS] LEVEL WORKFLOW ... - -Change the logging severity level of a running workflow. - -Only messages at or above the chosen severity level will be logged; for -example, if you choose WARNING, only warnings and critical messages will be -logged. - -This command can operate on multiple workflows, globs may also be used: - Multiple Workflows: - # Operate on two workflows - workflow-1 workflow-2 - - Globs (note: globs should be quoted): - # Match all workflows - '*' - - # Match the workflows foo-1, foo-2 - 'foo-[12]' - - See `cylc help id` for more details. - - -Arguments: - LEVEL DEBUG, INFO, NORMAL, WARNING, ERROR, CRITICAL - WORKFLOW ... Workflow ID(s) - -Options: - -h, --help show this help message and exit - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/show.help b/tests/functional/cli/04-kgo/show.help deleted file mode 100644 index 9e2233c5b09..00000000000 --- a/tests/functional/cli/04-kgo/show.help +++ /dev/null @@ -1,59 +0,0 @@ -Usage: cylc show [OPTIONS] ID ... - -Display workflow and task information, for tasks in the current n-window. - -Query a running workflow for: - # view workflow metadata - $ cylc show my_workflow - - # view task metadata - $ cylc show my_workflow --task-def my_task - - # view prerequisites & outputs for a live task - $ cylc show my_workflow//1/my_task - -Output completion status is shown for all tasks in the current n-window. - -Prerequisite satisfaction is not shown for past tasks reloaded from the -workflow database. - -This command can operate on multiple tasks, globs and selectors may -be used: - Multiple Tasks: - # Operate on two tasks - workflow //cycle-1/task-1 //cycle-2/task-2 - - Globs (note: globs should be quoted and only match active tasks): - # Match any the active task "foo" in all cycles - '//*/foo' - - # Match the tasks "foo-1" and "foo-2" - '//*/foo-[12]' - - Selectors (note: selectors only match active tasks): - # match all failed tasks in cycle "1" - //1:failed - - See `cylc help id` for more details. - - -Arguments: - ID ... Workflow/Cycle/Family/Task ID(s) - -Options: - -h, --help show this help message and exit - --list-prereqs Print a task's pre-requisites as a list. - --json Print output in JSON format. - --task-def=TASK_NAME View metadata for a task definition (can be used - multiple times) - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/stop.help b/tests/functional/cli/04-kgo/stop.help deleted file mode 100644 index d7425ca75d4..00000000000 --- a/tests/functional/cli/04-kgo/stop.help +++ /dev/null @@ -1,87 +0,0 @@ -Usage: cylc stop [OPTIONS] ID ... - -Tell a workflow to shut down. - -Examples: - # wait for active tasks to finish, then shut down - $ cylc stop my_workflow - - # kill active tasks, then shut down - $ cylc stop my_workflow --kill - - # shut down immediately, leave active tasks alone - $ cylc stop my_workflow --now - - # shut down all workflows - $ cylc stop '*' - - # shut down after the cycle 1234 has been passed - $ cylc stop my_workflow//1234 - - # shut down after the task foo in cycle 1234 has succeeded - $ cylc stop my_workflow//1234/foo - -By default stopping workflows wait for submitted and running tasks to complete -before shutting down. You can change this behaviour with the --mode option. - -There are several shutdown methods: - - 1. (default) stop after current active tasks finish - 2. (--now) stop immediately, orphaning current active tasks - 3. (--kill) stop after killing current active tasks - 4. (if ID specifies a cycle point) stop after the cycle point - 5. (if ID specifies a task ID) stop after the task has succeeded - 6. (--wall-clock=T) stop after time T (an ISO 8601 date-time format e.g. - CCYYMMDDThh:mm, CCYY-MM-DDThh, etc). - -Tasks that become ready after the shutdown is ordered will be submitted -immediately if the workflow is restarted. Remaining task event handlers and -job poll and kill commands, however, will be executed prior to shutdown, unless ---now is used. - -This command exits immediately unless --max-polls is greater than zero, in -which case it polls to wait for workflow shutdown. - -This command can operate on multiple workflows, globs may also be used: - Multiple Workflows: - # Operate on two workflows - workflow-1 workflow-2 - - Globs (note: globs should be quoted): - # Match all workflows - '*' - - # Match the workflows foo-1, foo-2 - 'foo-[12]' - - See `cylc help id` for more details. - - -Arguments: - ID ... Workflow/Cycle/Family/Task ID(s) - -Options: - -h, --help show this help message and exit - -k, --kill Shut down after killing currently active tasks. - --flow=INT Stop flow number INT from spawning more tasks. The - scheduler will shut down if it is the only flow. - -n, --now Shut down without waiting for active tasks to - complete. If this option is specified once, wait for - task event handler, job poll/kill to complete. If this - option is specified more than once, tell the workflow - to terminate immediately. - -w STOP, --wall-clock=STOP - Shut down after time STOP (ISO 8601 formatted) - --max-polls=INT Maximum number of polls (default: 0). - --interval=SECS Polling interval in seconds (default: 60). - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/subscribe.help b/tests/functional/cli/04-kgo/subscribe.help deleted file mode 100644 index 1f44d8a55b6..00000000000 --- a/tests/functional/cli/04-kgo/subscribe.help +++ /dev/null @@ -1,29 +0,0 @@ -Usage: cylc subscribe [OPTIONS] WORKFLOW - -(This command is for internal use.) - -Invoke workflow subscriber to receive published workflow output. - - -Arguments: - WORKFLOW Workflow ID - -Options: - -h, --help show this help message and exit - -T TOPICS, --topics=TOPICS - Specify a comma delimited list of subscription topics. - Directly published data-store topics include: 'edges', - 'families', 'family_proxies', 'jobs', 'tasks', - 'task_proxies', 'workflow' and 'all'. - -o, --once Show a single publish then exit. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/trigger.help b/tests/functional/cli/04-kgo/trigger.help deleted file mode 100644 index 5e2d802bcce..00000000000 --- a/tests/functional/cli/04-kgo/trigger.help +++ /dev/null @@ -1,82 +0,0 @@ -Usage: cylc trigger [OPTIONS] ID ... - -Force tasks to run despite unsatisfied prerequisites. - -* Triggering an unqueued waiting task queues it, regardless of prerequisites. -* Triggering a queued task submits it, regardless of queue limiting. -* Triggering an active task has no effect (it already triggered). - -Incomplete and active-waiting tasks in the n=0 window already belong to a flow. -Triggering them queues them to run (or rerun) in the same flow. - -Beyond n=0, triggered tasks get all current active flow numbers by default, or -specified flow numbers via the --flow option. Those flows - if/when they catch -up - will see tasks that ran after triggering event as having run already. - -Examples: - # trigger task foo in cycle 1234 in test - $ cylc trigger test//1234/foo - - # trigger all failed tasks in test - $ cylc trigger 'test//*:failed' - - # start a new flow by triggering 1234/foo in test - $ cylc trigger --flow=new test//1234/foo - -This command can operate on multiple workflows, globs may also be used: - Multiple Workflows: - # Operate on two workflows - workflow-1 workflow-2 - - Globs (note: globs should be quoted): - # Match all workflows - '*' - - # Match the workflows foo-1, foo-2 - 'foo-[12]' - - See `cylc help id` for more details. - -This command can operate on multiple tasks, globs and selectors may -be used: - Multiple Tasks: - # Operate on two tasks - workflow //cycle-1/task-1 //cycle-2/task-2 - - Globs (note: globs should be quoted and only match active tasks): - # Match any the active task "foo" in all cycles - '//*/foo' - - # Match the tasks "foo-1" and "foo-2" - '//*/foo-[12]' - - Selectors (note: selectors only match active tasks): - # match all failed tasks in cycle "1" - //1:failed - - See `cylc help id` for more details. - - -Arguments: - ID ... Cycle/Family/Task ID(s) - -Options: - -h, --help show this help message and exit - --flow=FLOW Assign the triggered task to all active flows (all); - no flow (none); a new flow (new); or a specific flow - (e.g. 2). The default is all. Reuse the option to - assign multiple specific flows. - --meta=DESCRIPTION description of triggered flow (with --flow=new). - --wait Wait for merge with current active flows before - flowing on. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. diff --git a/tests/functional/cli/04-kgo/validate.help b/tests/functional/cli/04-kgo/validate.help deleted file mode 100644 index 9cc88e39d4c..00000000000 --- a/tests/functional/cli/04-kgo/validate.help +++ /dev/null @@ -1,80 +0,0 @@ -Usage: cylc validate [OPTIONS] WORKFLOW | PATH - -Validate a workflow configuration. - -If the workflow definition uses include-files, reported line numbers will -correspond to the inlined version seen by the parser; -use 'cylc view -i,--inline WORKFLOW' for comparison. - - -Arguments: - WORKFLOW | PATH Workflow ID or path - -Options: - -h, --help show this help message and exit - -O OPT_CONF_KEYS, --opt-conf-key=OPT_CONF_KEYS - Use optional Rose Config Setting (If Cylc-Rose is - installed) - -D DEFINES, --define=DEFINES - Each of these overrides the `[SECTION]KEY` setting in - a `rose-suite.conf` file. Can be used to disable a - setting using the syntax `--define=[SECTION]!KEY` or - even `--define=[!SECTION]`. - -S ROSE_TEMPLATE_VARS, --rose-template-variable=ROSE_TEMPLATE_VARS, --define-suite=ROSE_TEMPLATE_VARS - As `--define`, but with an implicit `[SECTION]` for - workflow variables. - --check-circular Check for circular dependencies in graphs when the - number of tasks is greater than 100 (smaller graphs - are always checked). This can be slow when the number - of tasks is high. - -o FILENAME, --output=FILENAME - Specify a file name to dump the processed flow.cylc. - --profile Output profiling (performance) information - -m STRING, --mode=STRING - Run mode: live, dummy, simulation (default live). - --initial-cycle-point=CYCLE_POINT or OFFSET, --icp=CYCLE_POINT or OFFSET - Set the initial cycle point. Required if not defined - in flow.cylc. May be either an absolute point or an - offset: See https://bit.ly/3MYHqVh (Cylc documentation - link). - --against-source Load the workflow configuration from the source - directory it was installed from using any options - (e.g. template variables) which have been set in the - installation. This is useful if you want to see how - changes made to the workflow source would affect the - installation if reinstalled. Note if this option is - used the provided workflow must have been installed by - `cylc install`. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - -s NAME=VALUE, --set=NAME=VALUE - Set the value of a Jinja2 template variable in the - workflow definition. Values should be valid Python - literals so strings must be quoted e.g. - 'STR="string"', INT=43, BOOL=True. This option can be - used multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - -z NAME=VALUE1,VALUE2,..., --set-list=NAME=VALUE1,VALUE2,..., --template-list=NAME=VALUE1,VALUE2,... - Set the value of a Jinja2 template variable in the - workflow definition as a comma separated list of - Python strings. Values containing commas must be - quoted. e.g. '+s STR=a,b,c' => ['a', 'b', 'c'] or '+ s - STR=a,"b,c"' => ['a', 'b,c'] This option can be used - multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - --set-file=FILE Set the value of Jinja2 template variables in the - workflow definition from a file containing NAME=VALUE - pairs (one per line). As with --set values should be - valid Python literals so strings must be quoted e.g. - STR='string'. NOTE: these settings persist across - workflow restarts, but can be set again on the "cylc - play" command line if they need to be overridden. diff --git a/tests/functional/cli/04-kgo/view.help b/tests/functional/cli/04-kgo/view.help deleted file mode 100644 index 0b96ce45718..00000000000 --- a/tests/functional/cli/04-kgo/view.help +++ /dev/null @@ -1,82 +0,0 @@ -Usage: cylc view [OPTIONS] WORKFLOW | PATH - -Print a processed workflow configuration. - -Note: - This is different to `cylc config` which displays the parsed - configuration (as Cylc would see it). - - -Arguments: - WORKFLOW | PATH Workflow ID or path - -Options: - -h, --help show this help message and exit - -i, --inline Inline include-files. - -e, --empy View after EmPy template processing (implies - '-i/--inline' as well). - -j, --jinja2 View after Jinja2 template processing (implies - '-i/--inline' as well). - -p, --process View after all processing (EmPy, Jinja2, inlining, - line-continuation joining). - -m, --mark (With '-i') Mark inclusions in the left margin. - -l, --label (With '-i') Label file inclusions with the file name. - Line numbers will not correspond to those reported by - the parser. - --single (With '-i') Inline only the first instances of any - multiply-included files. Line numbers will not - correspond to those reported by the parser. - -c, --cat Concatenate continuation lines (line numbers will not - correspond to those reported by the parser). - --against-source Load the workflow configuration from the source - directory it was installed from using any options - (e.g. template variables) which have been set in the - installation. This is useful if you want to see how - changes made to the workflow source would affect the - installation if reinstalled. Note if this option is - used the provided workflow must have been installed by - `cylc install`. - -O OPT_CONF_KEYS, --opt-conf-key=OPT_CONF_KEYS - Use optional Rose Config Setting (If Cylc-Rose is - installed) - -D DEFINES, --define=DEFINES - Each of these overrides the `[SECTION]KEY` setting in - a `rose-suite.conf` file. Can be used to disable a - setting using the syntax `--define=[SECTION]!KEY` or - even `--define=[!SECTION]`. - -S ROSE_TEMPLATE_VARS, --rose-template-variable=ROSE_TEMPLATE_VARS, --define-suite=ROSE_TEMPLATE_VARS - As `--define`, but with an implicit `[SECTION]` for - workflow variables. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - -s NAME=VALUE, --set=NAME=VALUE - Set the value of a Jinja2 template variable in the - workflow definition. Values should be valid Python - literals so strings must be quoted e.g. - 'STR="string"', INT=43, BOOL=True. This option can be - used multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - -z NAME=VALUE1,VALUE2,..., --set-list=NAME=VALUE1,VALUE2,..., --template-list=NAME=VALUE1,VALUE2,... - Set the value of a Jinja2 template variable in the - workflow definition as a comma separated list of - Python strings. Values containing commas must be - quoted. e.g. '+s STR=a,b,c' => ['a', 'b', 'c'] or '+ s - STR=a,"b,c"' => ['a', 'b,c'] This option can be used - multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - --set-file=FILE Set the value of Jinja2 template variables in the - workflow definition from a file containing NAME=VALUE - pairs (one per line). As with --set values should be - valid Python literals so strings must be quoted e.g. - STR='string'. NOTE: these settings persist across - workflow restarts, but can be set again on the "cylc - play" command line if they need to be overridden. diff --git a/tests/functional/cli/04-kgo/vip.help b/tests/functional/cli/04-kgo/vip.help deleted file mode 100644 index e4ab08ffaaa..00000000000 --- a/tests/functional/cli/04-kgo/vip.help +++ /dev/null @@ -1,158 +0,0 @@ -Usage: cylc validate-install-play [OPTIONS] [SOURCE_NAME | PATH] - -Validate install and play a single workflow. - -This script is equivalent to: - - $ cylc validate /path/to/myworkflow - $ cylc install /path/to/myworkflow - $ cylc play myworkflow - - - -Arguments: - [SOURCE_NAME | PATH] Workflow source name or path to source directory - -Options: - -h, --help show this help message and exit - -O OPT_CONF_KEYS, --opt-conf-key=OPT_CONF_KEYS - [validate, install] Use optional Rose Config - Setting (If Cylc-Rose is installed) - -N, --no-detach, --non-daemon - [play] Do not daemonize the scheduler (infers - --format=plain) - -n WORKFLOW_NAME, --workflow-name=WORKFLOW_NAME - [install] Install into ~/cylc- - run//runN - --check-circular [validate] Check for circular dependencies in - graphs when the number of tasks is greater than 100 - (smaller graphs are always checked). This can be slow - when the number of tasks is high. - -o FILENAME, --output=FILENAME - [validate] Specify a file name to dump the - processed flow.cylc. - --symlink-dirs=SYMLINK_DIRS - [install] Enter a comma-delimited list, in - the form 'log=path/to/store, share = $HOME/some/path, - ...'. Use this option to override the global.cylc - configuration for local symlinks for the run, log, - work, share and share/cycle directories. Enter an - empty list '' to skip making localhost symlink dirs. - -r RUN_NAME, --run-name=RUN_NAME - [install] Give the run a custom name instead - of automatically numbering it. - --no-run-name [install] Install the workflow directly into - ~/cylc-run/, without an automatic run - number or custom run name. - --no-ping [install] When scanning for active instances - of the workflow, do not attempt to contact the - schedulers to get status. - --profile [validate, play] Output profiling - (performance) information - --start-cycle-point=CYCLE_POINT, --startcp=CYCLE_POINT - [play] Set the start cycle point, which may - be after the initial cycle point. If the specified - start point is not in the sequence, the next on- - sequence point will be used. (Not to be confused with - the initial cycle point) - --final-cycle-point=CYCLE_POINT, --fcp=CYCLE_POINT - [play] Set the final cycle point. This - command line option overrides the workflow config - option '[scheduling]final cycle point'. - --stop-cycle-point=CYCLE_POINT, --stopcp=CYCLE_POINT - [play] Set the stop cycle point. Shut down - after all have PASSED this cycle point. (Not to be - confused the final cycle point.) This command line - option overrides the workflow config option - '[scheduling]stop after cycle point'. - -t TASK_ID, --start-task=TASK_ID, --starttask=TASK_ID - [play] Start from this task instance, given - by '/'. This can be used multiple times - to start from multiple tasks at once. Dependence on - tasks with cycle points earlier than the earliest - start-task will be ignored. A sub-graph of the - workflow will run if selected tasks do not lead on to - the full graph. - --pause [play] Pause the workflow immediately on - start up. - --hold-after=CYCLE_POINT, --hold-cycle-point=CYCLE_POINT, --holdcp=CYCLE_POINT - [play] Hold all tasks after this cycle point. - --reference-log [play] Generate a reference log for use in - reference - --reference-test [play] Do a test run against a previously - generated reference. - --host=HOST [play] Specify the host on which to start-up - the workflow. If not specified, a host will be - selected using the '[scheduler]run hosts' global - config. - --format=FORMAT [play] The format of the output: - 'plain'=human readable, 'json' - --main-loop=PLUGIN_NAME - [play] Specify an additional plugin to run in - the main These are used in combination with those - specified [scheduler][main loop]plugins. Can be used - multiple times. - --abort-if-any-task-fails - [play] If set workflow will abort with status - 1 if any task fails. - --initial-cycle-point=CYCLE_POINT or OFFSET, --icp=CYCLE_POINT or OFFSET - [validate, play] Set the initial cycle point. - Required if not defined in flow.cylc. May be either an - absolute point or an offset: See - https://bit.ly/3MYHqVh (Cylc documentation link). - -m STRING, --mode=STRING - [validate, play] Run mode: live, dummy, - simulation (default live). - --downgrade [play] Allow the workflow to be restarted - with an older version of Cylc, NOT RECOMMENDED. By - default Cylc prevents you from restarting a workflow - with an older version of Cylc than it was previously - run with. Use this flag to disable this check. - --upgrade [play] Allow the workflow to be restarted - with a newer version of Cylc. - -D DEFINES, --define=DEFINES - [validate, install] Each of these overrides - the `[SECTION]KEY` setting in a `rose-suite.conf` - file. Can be used to disable a setting using the - syntax `--define=[SECTION]!KEY` or even - `--define=[!SECTION]`. - -S ROSE_TEMPLATE_VARS, --rose-template-variable=ROSE_TEMPLATE_VARS, --define-suite=ROSE_TEMPLATE_VARS - [validate, install] As `--define`, but with - an implicit `[SECTION]` for workflow variables. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. - -s NAME=VALUE, --set=NAME=VALUE - Set the value of a Jinja2 template variable in the - workflow definition. Values should be valid Python - literals so strings must be quoted e.g. - 'STR="string"', INT=43, BOOL=True. This option can be - used multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - -z NAME=VALUE1,VALUE2,..., --set-list=NAME=VALUE1,VALUE2,..., --template-list=NAME=VALUE1,VALUE2,... - Set the value of a Jinja2 template variable in the - workflow definition as a comma separated list of - Python strings. Values containing commas must be - quoted. e.g. '+s STR=a,b,c' => ['a', 'b', 'c'] or '+ s - STR=a,"b,c"' => ['a', 'b,c'] This option can be used - multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - --set-file=FILE Set the value of Jinja2 template variables in the - workflow definition from a file containing NAME=VALUE - pairs (one per line). As with --set values should be - valid Python literals so strings must be quoted e.g. - STR='string'. NOTE: these settings persist across - workflow restarts, but can be set again on the "cylc - play" command line if they need to be overridden. diff --git a/tests/functional/cli/04-kgo/vr.help b/tests/functional/cli/04-kgo/vr.help deleted file mode 100644 index 7f2e3cad22a..00000000000 --- a/tests/functional/cli/04-kgo/vr.help +++ /dev/null @@ -1,162 +0,0 @@ -Usage: cylc validate-reinstall [OPTIONS] WORKFLOW - -Validate, reinstall and apply changes to a workflow. - -Validate and reinstall a workflow then either: - -* "Reload" the workflow (if it is running), -* or "play" it (if it is stopped). - -This command is equivalent to: - $ cylc validate myworkflow --against-source - $ cylc reinstall myworkflow - # if myworkflow is running: - $ cylc reload myworkflow - # else: - $ cylc play myworkflow - -Note: - "cylc validate --against-source" checks the code in the workflow source - directory against any options (e.g. template variables) which have been set - in the installed workflow to ensure the change can be safely applied. - - -Arguments: - WORKFLOW Workflow ID - -Options: - -h, --help show this help message and exit - -O OPT_CONF_KEYS, --opt-conf-key=OPT_CONF_KEYS - [validate, install] Use optional Rose Config - Setting (If Cylc-Rose is installed) - -N, --no-detach, --non-daemon - [play] Do not daemonize the scheduler (infers - --format=plain) - --clear-rose-install-options - [reinstall] Clear options previously set by - cylc-rose. - --yes [reinstall] Skip interactive prompts. - --check-circular [validate] Check for circular dependencies in - graphs when the number of tasks is greater than 100 - (smaller graphs are always checked). This can be slow - when the number of tasks is high. - -o FILENAME, --output=FILENAME - [validate] Specify a file name to dump the - processed flow.cylc. - --against-source [validate] Load the workflow configuration - from the source directory it was installed from using - any options (e.g. template variables) which have been - set in the installation. This is useful if you want to - see how changes made to the workflow source would - affect the installation if reinstalled. Note if this - option is used the provided workflow must have been - installed by `cylc install`. - --profile [play, validate] Output profiling - (performance) information - --start-cycle-point=CYCLE_POINT, --startcp=CYCLE_POINT - [play] Set the start cycle point, which may - be after the initial cycle point. If the specified - start point is not in the sequence, the next on- - sequence point will be used. (Not to be confused with - the initial cycle point) - --final-cycle-point=CYCLE_POINT, --fcp=CYCLE_POINT - [play] Set the final cycle point. This - command line option overrides the workflow config - option '[scheduling]final cycle point'. - --stop-cycle-point=CYCLE_POINT, --stopcp=CYCLE_POINT - [play] Set the stop cycle point. Shut down - after all have PASSED this cycle point. (Not to be - confused the final cycle point.) This command line - option overrides the workflow config option - '[scheduling]stop after cycle point'. - -t TASK_ID, --start-task=TASK_ID, --starttask=TASK_ID - [play] Start from this task instance, given - by '/'. This can be used multiple times - to start from multiple tasks at once. Dependence on - tasks with cycle points earlier than the earliest - start-task will be ignored. A sub-graph of the - workflow will run if selected tasks do not lead on to - the full graph. - --pause [play] Pause the workflow immediately on - start up. - --hold-after=CYCLE_POINT, --hold-cycle-point=CYCLE_POINT, --holdcp=CYCLE_POINT - [play] Hold all tasks after this cycle point. - --reference-log [play] Generate a reference log for use in - reference - --reference-test [play] Do a test run against a previously - generated reference. - --host=HOST [play] Specify the host on which to start-up - the workflow. If not specified, a host will be - selected using the '[scheduler]run hosts' global - config. - --format=FORMAT [play] The format of the output: - 'plain'=human readable, 'json' - --main-loop=PLUGIN_NAME - [play] Specify an additional plugin to run in - the main These are used in combination with those - specified [scheduler][main loop]plugins. Can be used - multiple times. - --abort-if-any-task-fails - [play] If set workflow will abort with status - 1 if any task fails. - --initial-cycle-point=CYCLE_POINT or OFFSET, --icp=CYCLE_POINT or OFFSET - [play, validate] Set the initial cycle point. - Required if not defined in flow.cylc. May be either an - absolute point or an offset: See - https://bit.ly/3MYHqVh (Cylc documentation link). - -m STRING, --mode=STRING - [play, validate] Run mode: live, dummy, - simulation (default live). - --downgrade [play] Allow the workflow to be restarted - with an older version of Cylc, NOT RECOMMENDED. By - default Cylc prevents you from restarting a workflow - with an older version of Cylc than it was previously - run with. Use this flag to disable this check. - --upgrade [play] Allow the workflow to be restarted - with a newer version of Cylc. - -D DEFINES, --define=DEFINES - [validate, install] Each of these overrides - the `[SECTION]KEY` setting in a `rose-suite.conf` - file. Can be used to disable a setting using the - syntax `--define=[SECTION]!KEY` or even - `--define=[!SECTION]`. - -S ROSE_TEMPLATE_VARS, --rose-template-variable=ROSE_TEMPLATE_VARS, --define-suite=ROSE_TEMPLATE_VARS - [validate, install] As `--define`, but with - an implicit `[SECTION]` for workflow variables. - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'. - --comms-timeout=SEC Set a timeout for network connections to the running - workflow. The default is no timeout. For task - messaging connections see site/user config file - documentation. - -s NAME=VALUE, --set=NAME=VALUE - Set the value of a Jinja2 template variable in the - workflow definition. Values should be valid Python - literals so strings must be quoted e.g. - 'STR="string"', INT=43, BOOL=True. This option can be - used multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - -z NAME=VALUE1,VALUE2,..., --set-list=NAME=VALUE1,VALUE2,..., --template-list=NAME=VALUE1,VALUE2,... - Set the value of a Jinja2 template variable in the - workflow definition as a comma separated list of - Python strings. Values containing commas must be - quoted. e.g. '+s STR=a,b,c' => ['a', 'b', 'c'] or '+ s - STR=a,"b,c"' => ['a', 'b,c'] This option can be used - multiple times on the command line. NOTE: these - settings persist across workflow restarts, but can be - set again on the "cylc play" command line if they need - to be overridden. - --set-file=FILE Set the value of Jinja2 template variables in the - workflow definition from a file containing NAME=VALUE - pairs (one per line). As with --set values should be - valid Python literals so strings must be quoted e.g. - STR='string'. NOTE: these settings persist across - workflow restarts, but can be set again on the "cylc - play" command line if they need to be overridden. diff --git a/tests/functional/cli/04-kgo/workflow-state.help b/tests/functional/cli/04-kgo/workflow-state.help deleted file mode 100644 index 193ed9aff4c..00000000000 --- a/tests/functional/cli/04-kgo/workflow-state.help +++ /dev/null @@ -1,70 +0,0 @@ -Usage: cylc workflow-state [OPTIONS] WORKFLOW - -Retrieve task states from the workflow database. - -Print task states retrieved from a workflow database; or (with --task, ---point, and --status) poll until a given task reaches a given state; or (with ---task, --point, and --message) poll until a task receives a given message. -Polling is configurable with --interval and --max-polls; for a one-off -check use --max-polls=1. The workflow database does not need to exist at -the time polling commences but allocated polls are consumed waiting for -it (consider max-polls*interval as an overall timeout). - -Note for non-cycling tasks --point=1 must be provided. - -For your own workflows the database location is determined by your -site/user config. For other workflows, e.g. those owned by others, or -mirrored workflow databases, use --run-dir=DIR to specify the location. - -Examples: - $ cylc workflow-state WORKFLOW_ID --task=TASK --point=POINT --status=STATUS - # returns 0 if TASK.POINT reaches STATUS before the maximum number of - # polls, otherwise returns 1. - - $ cylc workflow-state WORKFLOW_ID --task=TASK --point=POINT --status=STATUS \ - > --offset=PT6H - # adds 6 hours to the value of CYCLE for carrying out the polling operation. - - $ cylc workflow-state WORKFLOW_ID --task=TASK --status=STATUS --task-point - # uses CYLC_TASK_CYCLE_POINT environment variable as the value for the - # CYCLE to poll. This is useful when you want to use cylc workflow-state in a - # cylc task. - - -Arguments: - WORKFLOW Workflow ID - -Options: - -h, --help show this help message and exit - -t TASK, --task=TASK Specify a task to check the state of. - -p CYCLE, --point=CYCLE - Specify the cycle point to check task states for. - -T, --task-point Use the CYLC_TASK_CYCLE_POINT environment variable as - the cycle point to check task states for. Shorthand - for --point=$CYLC_TASK_CYCLE_POINT - -d DIR, --run-dir=DIR - The top level cylc run directory if non-standard. The - database should be DIR/WORKFLOW_ID/log/db. Use to - interrogate workflows owned by others, etc.; see note - above. - -s OFFSET, --offset=OFFSET - Specify an offset to add to the targeted cycle point - -S STATUS, --status=STATUS - Specify a particular status or triggering condition to - check for. Valid triggering conditions to check for - include: 'fail', 'finish', 'start', 'submit' and - 'succeed'. Valid states to check for include: - 'waiting', 'expired', 'preparing', 'submit-failed', - 'submitted', 'running', 'failed' and 'succeeded'. - -O MSG, -m MSG, --output=MSG, --message=MSG - Check custom task output by message string or trigger - string. - --max-polls=INT Maximum number of polls (default: 10). - --interval=SECS Polling interval in seconds (default: 60). - -q, --quiet Decrease verbosity. - -v, --verbose Increase Verbosity - --debug Equivalent to -v -v - --no-timestamp Don't timestamp logged messages. - --color=WHEN, --color=WHEN - When to use color/bold text in terminal output. - Options are 'never', 'auto' and 'always'.