Skip to content

Commit

Permalink
Clarify task id help.
Browse files Browse the repository at this point in the history
  • Loading branch information
hjoliver committed Feb 12, 2025
1 parent 3e65d8b commit 6217c17
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions cylc/flow/scripts/cylc.py
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,7 @@ def get_version(long=False):
$ cylc pause foo/run1
$ cylc stop foo/run1
In the case of numbered runs (e.g. "run1", "run2", ...) you can omit
the run number, Cylc will infer latest run.
If you omit run number ("run1", "run2", ...) Cylc will infer latest run.
$ cylc play foo
$ cylc pause foo
$ cylc stop foo
Expand All @@ -164,8 +163,7 @@ def get_version(long=False):
You can omit the user name when working on your own workflows.
Cycle / Family / Task / Job IDs:
Just as workflows have IDs, the things within workflows have IDs too.
These IDs take the format:
Just as workflows have IDs, so do objects within workflows:
cycle/task_or_family/job
Examples:
Expand All @@ -174,8 +172,7 @@ def get_version(long=False):
1/a/1 # The first job of the task "a" in the cycle point "1".
Full ID
We join the workflow and cycle/task/job IDs together using //:
workflow//cycle/task/job
Join workflow and cycle/task/job IDs with //: workflow//cycle/task/job
Examples:
w// # The workflow "w"
Expand All @@ -201,8 +198,9 @@ def get_version(long=False):
workflow//cycle/task/* # All jobs in workflow//cycle/job
Warning:
Remember to write IDs inside single quotes when using them on the
command line otherwise your shell may expand them.
Quote IDs on the command line to protect them from shell expansion.
Patterns only match tasks in the n=0 active window (except for the
`cylc show` command where they match in the wider n-window).
Filters
Filters allow you to filter for specific states.
Expand Down

0 comments on commit 6217c17

Please sign in to comment.