Refactor CLI help copy to terse, period-less Codex-CLI style#154
Merged
Conversation
Rewrites every user-facing help string to the convention the Codex CLI uses: terse, imperative, sentence-case one-liners with no trailing period. Genuinely multi-sentence help (e.g. "X. Default: Y.") keeps normal punctuation. - Command summaries (root --help + each command's --help) tightened and de-periodised: e.g. "Transcribe a file, URL, or YouTube/podcast link — or a whole batch", "Hold a live two-way voice conversation with a voice agent", "Push-to-talk dictation: record the mic, get the transcript back". - ~180 option/argument help strings dropped their trailing period across every command, plus the shared option factories and root flags. - Only public command docstrings were touched (snapshot-covered); internal helper docstrings and CLIError messages are unchanged. - Regenerated the six --help snapshot goldens; updated two unit tests that pinned the old copy. - Added bare-invocation tests for sessions/transcripts/webhooks so the no_args_is_help=True flag (now sharing a changed line with the help string) stays covered by the mutation gate. - Recorded the help-copy convention in AGENTS.md. https://claude.ai/code/session_0172UnMSRedHhDjc1MdKpig6
…refactor-3n3h04 # Conflicts: # aai_cli/commands/dub/__init__.py # aai_cli/commands/speak/__init__.py # tests/__snapshots__/test_snapshots_help_root.ambr # tests/__snapshots__/test_snapshots_help_run.ambr
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rewrites every user-facing help string to the convention the Codex CLI
uses: terse, imperative, sentence-case one-liners with no trailing
period. Genuinely multi-sentence help (e.g. "X. Default: Y.") keeps
normal punctuation.
de-periodised: e.g. "Transcribe a file, URL, or YouTube/podcast link —
or a whole batch", "Hold a live two-way voice conversation with a voice
agent", "Push-to-talk dictation: record the mic, get the transcript
back".
every command, plus the shared option factories and root flags.
internal helper docstrings and CLIError messages are unchanged.
that pinned the old copy.
no_args_is_help=True flag (now sharing a changed line with the help
string) stays covered by the mutation gate.
https://claude.ai/code/session_0172UnMSRedHhDjc1MdKpig6