Hey all! Is anyone aware of any API reference docs for the CLI on the metaflow website? I'm having a hard time finding anything. E.g., I just want to know everything I get from

python myflow.py --help

(and all the subcommands recursively under that). I was actually curious for the sake of using the

Runner

API, but the docs just say things like "Additional arguments that you would pass to

python myflow.py

after the

run

command" 🙂; further, in some cases these appear to be positional args for the CLI but must be kwargs for the

Runner

methods. E.g., specifically I was looking for

runner.resume(step_to_rerun="step_name")

, which, to its credit does match the CLI

--help

docs, but feels a bit surprising.

good feedback. at the moment,

python myflow.py <command> --help

is the best bet. i will add a note to create a new doc page

the runner API is actually built from the click API (more or less) so typically it will “work” (replacing - with _ as usual). So as @ancient-application-36103 mentioned, the

--help

is your best bet and you can assume that it works in the Runner API (it will in most cases). Note that it also follows the same hierarchy so:

myflow.py <option1> run <option2>

will be something like

Runner("myflow.py", option1).run(option2)

Makes sense; yeah I think online docs would be a nice to have (it's nice to be able to link in docs/messages, etc.) but the CLI

--help

will certainly get me what I need. Thanks!