Skip to content

docs(cli): document --quiet/--silent as global options that precede the subcommand#285

Open
decherneyge wants to merge 2 commits into
microsoft:mainfrom
decherneyge:docs/global-quiet-silent-flag-placement
Open

docs(cli): document --quiet/--silent as global options that precede the subcommand#285
decherneyge wants to merge 2 commits into
microsoft:mainfrom
decherneyge:docs/global-quiet-silent-flag-placement

Conversation

@decherneyge

Copy link
Copy Markdown

Problem

--quiet/-q and --silent/-s are defined on the Typer app callback (src/conductor/cli/app.py), not on the run command, which makes them global options that must appear before the subcommand:

conductor --quiet run workflow.yaml     # works
conductor run workflow.yaml --quiet     # exit 2: "No such option: --quiet"

The documentation contradicted this in several places:

  • docs/cli-reference.md listed both flags in the conductor run options table (under the conductor run <workflow.yaml> [OPTIONS] syntax line) and had two examples that fail as written — the --quiet debugging example and the CI/CD --silent --log-file auto pattern.
  • README.md had the same table problem, and its flag descriptions were also inaccurate (--silent prints the JSON result, it doesn't "suppress all output except errors").
  • The conductor skill's quick reference (plugins/conductor/skills/conductor/SKILL.md) showed conductor run workflow.yaml -q ....

(plugins/conductor/skills/conductor/references/execution.md already documented the ordering correctly and was used as the template.)

Changes

  • Add a Global Options section to docs/cli-reference.md with correct/incorrect ordering examples; remove --quiet/--silent from the run options table and leave a pointer note; fix both broken examples.
  • Fix the README.md run-options table the same way and show correctly ordered examples with accurate descriptions.
  • Fix the mis-ordered examples in the conductor skill's quick reference.
  • Add an Unreleased > Documentation CHANGELOG entry.

Docs-only change — no code touched.

🤖 Generated with Claude Code

…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>
@decherneyge

Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree

@jrob5756 jrob5756 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

Comment thread docs/cli-reference.md
conductor --quiet run workflow.yaml

# Incorrect: rejected with "No such option: --quiet"
conductor run workflow.yaml --quiet

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread docs/cli-reference.md Outdated
Comment on lines +17 to +18
The following options apply to every subcommand and **must appear before the
subcommand name**:

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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**:

Comment thread CHANGELOG.md Outdated
Comment on lines +78 to +80
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

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Suggested change
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>
@decherneyge

Copy link
Copy Markdown
Author

Thanks for the review, @jrob5756 — all three points addressed in 7084be0:

  • conductor run --help epilog now shows conductor --silent run workflow.yaml --log-file auto; swept the rest of the CLI help text and that was the only misordered example.
  • Reframed the section as Root-Level Options using your suggested wording, plus a note that the verbosity flags govern workflow progress output (run/resume) and may not affect other commands. Synced the terminology in the run-table note, the examples, the README, and the skill quick reference.
  • CHANGELOG reworded per your suggestion so the failing examples are attributed to docs/cli-reference.md (and the --help epilog) — the README only had the options-table placement issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants