feat(help): dedup usage --format, tg help format topic-help, voice-setup status glyph#40
Open
alex-mextner wants to merge 1 commit into
Open
feat(help): dedup usage --format, tg help format topic-help, voice-setup status glyph#40alex-mextner wants to merge 1 commit into
tg help format topic-help, voice-setup status glyph#40alex-mextner wants to merge 1 commit into
Conversation
…setup status glyph Implements the ROADMAP "tg help specifics" item (three sub-points): 1. Usage block no longer repeats `[--format plain|html]` on every line — it is a global modifier shown ONCE in Options. The examples read cleanly and a one-line note says the global options apply to any form. 2. `tg help format` is the canonical formatting reference (the standard `tg help <topic>` convention, advertised in `tg --help`). `tg help` with no topic prints the main help; an unknown topic errors 3-part and exits non-zero. `--format-help` is kept as a back-compat alias (byte-identical output). 3. `tg voice setup` shows actual STATUS: a green ✓ when configured, a yellow ○ when pending (install-* state principle). The glyph is plain unicode so the SAME message is meaningful on both surfaces — colorized for the terminal, ANSI-free in the Telegram onboarding reply (colorizeVoiceStatus is CLI-only). Docs synced (AGENTS.md, install-skill SKILL.md) to the `tg help format` form. Version 1.13.0 -> 1.14.0 + CHANGELOG; AGENTS test count 1066 -> 1074. Tests: bun test 1074 pass / 0 fail (+8 new across cli-subprocess + voice + help-color). Visual-proof captured for --help, help format/alias parity, and the colorized vs ANSI-free voice-status messages. NOTE: the pre-commit `review --staged` multi-model gate could not run — the installed `review` binary is broken on this host (ModuleNotFoundError: reviewlib; review-cli repo absent). The CI review-threads gate covers the PR. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Owner
Author
Visual proof —
|
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
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.
Why
The ROADMAP heading "tg help specifics" (CTO 2026-06-16) queued three help-UX fixes to land with the tg-cli help work (the
--tag+ colorize landed in #36; this is the follow-up increment). None of the three were done onmain.What
1. Usage no longer repeats
[--format plain|html]on every line. It was duplicated 8× across the usage examples.--formatis a global modifier — shown ONCE inOptions:now, with a one-line note that the global options apply to any send form.2.
tg help format— standard topic-help, replacing the bespoke--format-helpflag.tg help format→ the formatting reference (byte-identical to the old--format-help).tg help(no topic) → the main help (which now lists the available topics).tg help <unknown>→ a 3-part WHAT/WHY/HOW error on stderr, exit 1.--format-helpis kept as a back-compat alias (an agent-facing tool — older scripts/skills that learned the flag don't break).tg --helpadvertises the canonicaltg help formatform.3.
tg voice setupshows actual STATUS — green✓when configured, yellow○when pending (the install-* state principle). The glyph is plain unicode so the SAMEonboardingMessagestring is meaningful on BOTH surfaces:colorizeVoiceStatuscolors it for the terminal (CLI path only), while the daemon's Telegram onboarding reply stays ANSI-free (no escape-code garbage in chat).Docs synced to the
tg help formatform (AGENTS.md, install-skillSKILL.md). Version1.13.0 → 1.14.0+ CHANGELOG; AGENTS test count1066 → 1074.Tests
bun test: 1074 pass / 0 fail (+8 new acrosscli-subprocess,voice,help-color):tg help formatprints the reference;--format-helpalias is byte-identical; baretg helpprints main help;tg help boguserrors 3-part non-zero;--helpadvertisestg help format.onboardingMessageleads with✓/○; is ANSI-free;colorizeVoiceStatuscolors only the glyph (green ✓ / yellow ○) and is a no-op when disabled.Visual proof
tg help formatandtg --format-helpdiff = IDENTICAL. The colorizedtg voice setupstatus (green ✓ configured / yellow ○ pending) is attached below as a terminal render.Note
The prescribed pre-commit
review --stagedmulti-model gate could not run: the installedreviewbinary is broken on this host (ModuleNotFoundError: reviewlib; thereview-clirepo is absent at~/.files/repos/review-cli). The CIreview-threadsgate covers this PR; I self-reviewed the staged diff. Flagging the tooling breakage explicitly.🤖 Generated with Claude Code