Cheat Sheet
Quick summary of the command line changes between Cylc 7 / Rose 2019 and Cylc 8.
Validating
Check the workflow configuration for errors:
Cylc 7 |
Rose 2019 |
Cylc 8 (Rose 2) |
cylc validate <name/path>
|
# validate from $PWD
rose suite-run --validate
|
cylc validate <name/path>
|
Installing & Running
Install a workflow from source and run it:
Cylc 7 |
Rose 2019 |
Cylc 8 (Rose 2) |
# no installation capability
# run from source
cylc run <name>
|
# install from $PWD
# then run
rose suite-run
|
# validate, install & play
cylc vip <name>
cylc vip # use $PWD
|
Reloading
To update a running workflow with changes from the source directory:
Cylc 7 |
Rose 2019 |
Cylc 8 (Rose 2) |
# update the live source
# directly, then
cylc reload <name>
|
# re-install from source
# and do ``cylc reload``
rose suite-run --reload
|
# Validate against source;
# Reinstall;
# Reload or Play
cylc vr <name>
|
Pausing & Unpausing
Tell a workflow not to submit any new jobs:
Cylc 7 & Rose 2019 |
Cylc 8 (Rose 2) |
cylc hold <name>
cylc unhold <name>
|
cylc pause <name>
cylc play <name>
|
Stopping
Stop a running workflow:
cylc stop <name>
Restarting
Restart a stopped workflow and pick up where it left off:
Cylc 7 |
Rose 2019 |
Cylc 8 (Rose 2) |
# no installation capability
# restart from source
cylc restart <name>
|
# regular restart
rose suite-restart
Or alternatively: # reinstall and restart
rose suite-run --restart
|
# optionally reinstall
cylc reinstall <name>
# restart
cylc play <name>
|
Deleting
Delete the workflow run directory (leave source files untouched):
Cylc 7 |
Rose 2019 |
Cylc 8 (Rose 2) |
rm -rf ~/cylc-run/<name>
|
rose suite-clean <name>
|
cylc clean <name>
|
Scanning
List all running workflows:
cylc scan
View A Workflow’s Configuration
View the parsed workflow configuration:
Cylc 7 |
Rose 2019 |
Cylc 8 (Rose 2) |
cylc get-config --sparse \
<name/path>
|
# install workflow
rose suite-run -l
# view installed config
cylc get-config --sparse \
<name/path>
|
cylc config <name/path>
|
Opening User Interfaces
Opening the graphical user interface (GUI) or terminal user interface (TUI) for monitoring / controlling running workflows:
Cylc 7 & Rose 2019 |
Cylc 8 (Rose 2) |
|
Terminal |
cylc monitor <name>
|
cylc tui <name>
|
Graphical |
cylc gui <name>
|
cylc gui
|
Web Server |
cylc review start
|
cylc hub
|
Static Graph Visualisation
Generate a visualisation for a workflow without running it:
Cylc 7 & Rose 2019 |
Cylc 8 (Rose 2) |
cylc graph <name>
|
cylc graph <name>
This generates a basic image file if Graphviz is installed. The web UI will have full graph vis. in a future release. |
Datetime Operations
Datetime operations in task scripts:
Cylc 7 & Rose 2019 |
Cylc 8 (Rose 2) |
rose date <point> --offset <offset>
|
isodatetime <point> --offset <offset>
|
rose date -c
# equivalent to:
rose date "$CYLC_TASK_CYCLE_POINT"
|
isodatetime ref
# equivalent to:
isodatetime "$CYLC_TASK_CYCLE_POINT"
|
Rose Stem
Run a Rose Stem test suite.
Rose 2019 |
Rose 2 (Cylc 8) |
# install and start
rose stem
|
# install
rose stem
# start
cylc play <name>
|