Skip to content

Commit

Permalink
Better 'cylc message' CLI help text.
Browse files Browse the repository at this point in the history
  • Loading branch information
hjoliver committed Mar 11, 2024
1 parent 969764d commit 8b856b5
Showing 1 changed file with 20 additions and 10 deletions.
30 changes: 20 additions & 10 deletions cylc/flow/scripts/message.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,26 @@
# along with this program. If not, see <http://www.gnu.org/licenses/>.
r"""cylc message [OPTIONS] -- ARGS
Record task messages.
Send messages to:
- The job stdout/stderr.
- The job status file, if there is one.
- The scheduler, if communication is possible.
Jobs use this command to record and report status such as success and
failure. Applications run by jobs can use this command to report messages
and to report registered task outputs.
Command to record and send messages from task jobs back to the scheduler.
Messages are sent to:
- job stdout/stderr
- the job status file, if there is one
- the scheduler, if communication is possible
Jobs automatically use this command to record and report job status: started
(running) and success or failure.
Applications run by jobs can use this command to report custom messages and
and registered task output messages.
For custom outputs, use the task message not the associated output name:
[runtime]
[[my-task]]
# ...
[[[outputs]]]
# <output-name> = <task-message>
x = "file x completed and archived"
Messages can be specified as arguments. A '-' indicates that the command should
read messages from STDIN. When reading from STDIN, multiple messages are
Expand Down

0 comments on commit 8b856b5

Please sign in to comment.