cylc-flow icon indicating copy to clipboard operation
cylc-flow copied to clipboard

CLI: VIP and VR should accurately report options for components

Open wxtim opened this issue 2 years ago • 2 comments

Problem

The current VIP and VR scripts tell users what atomic scripts would be being called. That is,

cylc vip /loc/myworkflow --workflow-name foo -s='BAZ=42'
...
$ cylc validate /loc/myworkflow
...
$ cylc install /loc/myworkflow
...
$ cylc play foo -s='BAZ=42'

These reports should also include a full list of options relevant to that command, as is effectively done for Cylc Play in https://github.com/cylc/cylc-flow/pull/5377:

That is, when called the output should be

...
$ cylc validate /loc/myworkflow -s='BAZ=42'
...
$ cylc install /loc/myworkflow --workflow-name foo
...
$ cylc play foo -s='BAZ=42'

wxtim avatar Feb 28 '23 13:02 wxtim

I did something similar for argparse, easy conversion.

oliver-sanders avatar Feb 28 '23 16:02 oliver-sanders

Don't have the time to push this one through ATM.

Closing this PR: https://github.com/cylc/cylc-flow/pull/5385, but will leave the branch behind.

oliver-sanders avatar Jan 24 '24 15:01 oliver-sanders