Menu

#297 docs: document every CLI command in docs/CLI.md

closed
nobody
None
2026-08-18
2026-08-08
Anonymous
No

Originally created by: AshSgDe29071999

Summary

  • Expand docs/CLI.md so every command printed by doberman --help is listed, including sub-group commands.
  • Add tables for auth enrollment (2fa, password), session taint recovery, and host hooks.
  • Keep the existing machine-readable flags section and examples; add a few enrollment/setup examples.

Why

Issue [#185] required the reference page to cover every help command. The page drifted to 10 of ~26 entry points and omitted the security-posture surface that SETUP walks users through.

Test plan

  • [x] Cross-checked command names against doberman --help and doberman {2fa,password,taint,hook} --help.
  • [x] Docs-only change; no code changes.

Fixes [#222]

Related

Tickets: #185
Tickets: #222

Discussion

  • Anonymous

    Anonymous - 2026-08-10

    Originally posted by: fu351

    The page finally covers the whole surface, not just the happy-path verbs. Pulling in auth enrollment (2fa, password), taint recovery, and the host hooks is exactly what [#222] asked for, and keeping the machine-readable flags section means existing readers lose nothing.

    One command is still missing: doberman hook codex-pre — the Codex PreToolUse gate, the counterpart to hook pre. Add that row to the Host hooks table and the page is complete. For catching these next time: enumerating straight from the @app.command / sub-group decorators in src/doberman/cli/ is the reliable source, since --help output depends on which doberman is on PATH.

    Then it's good to merge.

     

    Related

    Tickets: #222

  • Anonymous

    Anonymous - 2026-08-10

    Originally posted by: AshSgDe29071999

    Added doberman hook codex-pre to the Host hooks table — ready for another look.

     
  • Anonymous

    Anonymous - 2026-08-11

    Ticket changed by: fu351

    • status: open --> closed
     
  • Anonymous

    Anonymous - 2026-08-11

    Originally posted by: fu351

    29 commands in the source, 29 rows on the page, and not one invented verb — I checked against the Typer app before merging. You also got the detail right that tripped a past PR: every sub-command written out as doberman taint clear, never a bare taint. And the wording on the auth rows mirrors what the code actually gates instead of rounding up to something friendlier, which matters on a page describing 2FA and taint recovery. Nice work.

    I touched two rows on your branch before merging (5bb7b9f), both pre-existing gaps your "every command" goal deserved to have closed: the hook rows now mention --host codex, and tui says it needs the [tui] extra.

    Your JSON work so far (#315, [#230], [#229]) points straight at [#192] (level-5, good first challenge): one shared JSON-output contract across all the CLI's JSON commands. You've been enforcing those conventions one command at a time — that issue makes them official.

     

    Related

    Tickets: #192
    Tickets: #229
    Tickets: #230

  • Anonymous

    Anonymous - 2026-08-18

    Originally posted by: fu351

    @AshSgDe29071999 I ran a docs audit this week and CLI.md still covers every one of the 36 commands. Your pass is holding up perfectly.

    Quick community roll-call: are you in the Doberman Discord? If yes, drop your handle here (or DM me there) so I can match the GitHub side of your work to your Discord name. If not, you're warmly invited: https://discord.gg/Sfy5XGNqty

     

Log in to post a comment.