// docs · v1.x

Which command do I need?

A task-to-command decision table for CommitBrief — staged review, historic diffs, PR review, CI gating, agent self-review, credential scanning, commit graphs, and commit messages — each row linked to the page that covers it in full.

Updated September 23, 2026

CommitBrief’s commands do genuinely different jobs, not eight ways to do the same job. This table maps a task to the command, and the command to the page that covers its flags and limits in full.

I want to…CommandDetails
Review my staged (or unstaged) changes locallycommitbrief / commitbrief --unstagedThe default — staged changes
Review an arbitrary range — a branch, a merge commit, three commits agocommitbrief diff <range>Historic ranges
Post review comments on a GitHub pull requestcommitbrief remote pr <number>Review a GitHub PR
Fail CI when a change carries too many findings, above a per-severity budgetcommitbrief guardPolicy gate
Let an AI agent self-review before it submits codecommitbrief mcpMCP server
Scan the working tree and git history for committed credentialscommitbrief leaksCredential audit
See which commits a filter selected, or a branch’s ahead/behind topologycommitbrief mapCommit graph
Turn a staged diff into a commit message, then commit itcommitbrief commitGenerate a commit message

Two commands are missing from that table on purpose: summary (a plain-language digest of a diff — not a decision between alternatives, just a different output; see commitbrief summary) and list (the full command reference, generated from the binary you have installed — see commitbrief list). Every flag any of the commands above accepts is in the flag reference.

This table is a starting point, not a substitute for the linked pages. guard and commitbrief --fail-on <severity> overlap on purpose — a single threshold versus a richer per-severity budget, see Gate CI on review findings for which one fits your pipeline — and remote pr is also the mode the GitHub Action drives for you in CI. Pick the row that matches your task, then read the page it points to before you script around it.

See also