Repository navigation
Command reference documents short flags that do not exist #52
Description
Problem Statement
The command reference currently states that global short flags -v and -q are available, but the actual CLI only supports long-form --verbose and --quiet. This creates a documentation/runtime mismatch that causes avoidable command failures for users and agent workflows following the reference.
Impact: Commands like trop -v list and trop -q reserve fail at argument parsing instead of running, which can break scripts and automated usage based on the documented interface.
Affected Files / Lines
plugins/trop/skills/trop-reference/references/cli-commands.md:57- Documents:
--verbose / -vand--quiet / -q.
- Documents:
trop-cli/src/cli.rs:22verboseis defined as long-only:#[arg(long, global = true)].
trop-cli/src/cli.rs:26quietis defined as long-only:#[arg(long, global = true)].
Additional source-of-truth context:
reference/ImplementationSpecification.md:333-337specifies long forms only (--verbose,--quiet, etc.).
Recommended Fix
Align the command reference with the implemented/spec'd CLI behavior by removing unsupported short aliases from the docs.
--- a/plugins/trop/skills/trop-reference/references/cli-commands.md
+++ b/plugins/trop/skills/trop-reference/references/cli-commands.md
@@
-All commands accept: `--verbose` / `-v`, `--quiet` / `-q`, `--data-dir <path>`, `--busy-timeout <seconds>`, `--help` / `-h`
+All commands accept: `--verbose`, `--quiet`, `--data-dir <path>`, `--busy-timeout <seconds>`, `--help` / `-h`Optional hardening to prevent future drift: add tests that explicitly verify -v and -q are rejected unless short aliases are intentionally introduced later.
// trop-cli/tests/cli.rs
#[test]
fn test_cli_short_verbose_flag_not_supported() {
let mut cmd = Command::cargo_bin("trop").unwrap();
cmd.arg("-v").arg("list");
cmd.assert().failure().stderr(predicate::str::contains("error:"));
}
#[test]
fn test_cli_short_quiet_flag_not_supported() {
let mut cmd = Command::cargo_bin("trop").unwrap();
cmd.arg("-q").arg("list");
cmd.assert().failure().stderr(predicate::str::contains("error:"));
}Validation Strategy
-
Docs validation
- Confirm
plugins/trop/skills/trop-reference/references/cli-commands.mdno longer advertises-v/-q.
- Confirm
-
Manual CLI verification
trop --verbose listsucceeds.trop --quiet listsucceeds.trop -v listfails with argument parsing error.trop -q listfails with argument parsing error.
-
Automated checks
- Add/adjust tests in
trop-cli/tests/cli.rs(ortrop-cli/tests/global_options.rs) for unsupported short flags. - Run
cargo testto ensure behavior is documented and enforced.
- Add/adjust tests in
🤖 Discovered by Codex · expanded by Codex · filed by Claude Code
Activity
Remove undocumented -v/-q short flags from command reference (gh issue:
plx commentedon Apr 9, 2026
Addressed via
8120e5cin PR #48Changes:
-vand-qshort flag aliases fromplugins/trop/skills/trop-reference/references/cli-commands.md, aligning the command reference with the implemented CLI (which only supports--verboseand--quietlong forms).trop-cli/tests/cli.rs(test_cli_short_verbose_flag_not_supportedandtest_cli_short_quiet_flag_not_supported) to prevent future documentation/runtime drift.All 9 CLI tests pass, including the new guards. Full test suite (178 tests) passes cleanly.
🤖 Posted by Claude Code