docs(cli): document --quiet/--silent as global options that precede the subcommand#285
Conversation
…he subcommand --quiet/-q and --silent/-s are defined on the Typer app callback, not on the run command, so they must appear before the subcommand name. docs/cli-reference.md and the README listed them in the 'conductor run' options table and showed examples like 'conductor run workflow.yaml --quiet' that fail with "No such option: --quiet" as written. - Add a Global Options section to docs/cli-reference.md (with correct/ incorrect ordering examples) and remove the two flags from the run options table, leaving a pointer note - Fix the two broken examples (--quiet and the CI/CD --silent pattern) - Fix the README run-options table the same way (its flag descriptions were also inaccurate) and show correctly ordered examples - Fix the same mis-ordering in the conductor skill's quick reference (references/execution.md already documented the ordering correctly) - Add an Unreleased > Documentation CHANGELOG entry Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
@microsoft-github-policy-service agree |
jrob5756
left a comment
There was a problem hiding this comment.
Thank you for contributing to Conductor! The placement fixes are right, but a few user-facing details still conflict with the CLI. Could you address those as well? Then we can merge! Thanks again!
| conductor --quiet run workflow.yaml | ||
|
|
||
| # Incorrect: rejected with "No such option: --quiet" | ||
| conductor run workflow.yaml --quiet |
There was a problem hiding this comment.
Could this PR also update the example in src/conductor/cli/app.py:409? conductor run --help still tells users to run conductor run workflow.yaml --silent --log-file auto, which the new section correctly explains will fail.
| The following options apply to every subcommand and **must appear before the | ||
| subcommand name**: |
There was a problem hiding this comment.
These options are parsed at the root, but their output behavior does not apply to every command. conductor --silent validate ..., for example, still prints the normal Rich report. I would describe them as root-level options unless the intent is to make every command honor the verbosity setting.
| The following options apply to every subcommand and **must appear before the | |
| subcommand name**: | |
| The following root-level options **must appear before the | |
| subcommand name**: |
| rejected with "No such option". `docs/cli-reference.md` and the README listed | ||
| them in the `conductor run` options table and showed post-subcommand examples | ||
| (`conductor run workflow.yaml --quiet`) that fail as written. Moved the flags |
There was a problem hiding this comment.
This reads as though both documents contained broken examples. The README only listed the flags in the run options table; the failing examples were in the CLI reference. Could we separate those two claims?
| rejected with "No such option". `docs/cli-reference.md` and the README listed | |
| them in the `conductor run` options table and showed post-subcommand examples | |
| (`conductor run workflow.yaml --quiet`) that fail as written. Moved the flags | |
| rejected with "No such option". `docs/cli-reference.md` and the README listed | |
| them in the `conductor run` options table, while `docs/cli-reference.md` also | |
| showed a post-subcommand example (`conductor run workflow.yaml --quiet`) that | |
| fails as written. Moved the flags |
…options - Fix the broken example in `conductor run --help` (app.py docstring): `conductor run workflow.yaml --silent --log-file auto` → `conductor --silent run workflow.yaml --log-file auto` - Rename Global Options → Root-Level Options per review: the flags are parsed at the root but their output behavior applies to workflow progress (run/resume), not every command. Note this in the section and sync the wording in the run-table note, examples, README, and skill. - Reword the CHANGELOG entry so the broken post-subcommand examples are attributed to docs/cli-reference.md (and the --help epilog), not the README, which only had the options-table placement issue. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
|
Thanks for the review, @jrob5756 — all three points addressed in 7084be0:
|
Problem
--quiet/-qand--silent/-sare defined on the Typer app callback (src/conductor/cli/app.py), not on theruncommand, which makes them global options that must appear before the subcommand:The documentation contradicted this in several places:
docs/cli-reference.mdlisted both flags in theconductor runoptions table (under theconductor run <workflow.yaml> [OPTIONS]syntax line) and had two examples that fail as written — the--quietdebugging example and the CI/CD--silent --log-file autopattern.README.mdhad the same table problem, and its flag descriptions were also inaccurate (--silentprints the JSON result, it doesn't "suppress all output except errors").plugins/conductor/skills/conductor/SKILL.md) showedconductor run workflow.yaml -q ....(
plugins/conductor/skills/conductor/references/execution.mdalready documented the ordering correctly and was used as the template.)Changes
docs/cli-reference.mdwith correct/incorrect ordering examples; remove--quiet/--silentfrom therunoptions table and leave a pointer note; fix both broken examples.README.mdrun-options table the same way and show correctly ordered examples with accurate descriptions.Unreleased > DocumentationCHANGELOG entry.Docs-only change — no code touched.
🤖 Generated with Claude Code