# Flags

> Every flag CommitBrief accepts, grouped by command and generated from the binary's own surface inventory — global flags first, then each command's local flags.

CommitBrief docs · v1.x · Reference

Canonical URL: https://commitbrief.com/docs/1.x/flags/

---

import FlagTable from "../../../src/components/surface/FlagTable.astro";

CommitBrief's flags split into two scopes. **Global flags** are declared on
the root command and inherited by every subcommand, so every subcommand
accepts them — `--json`, `--quiet`, `--provider`, and the path/commit
filters all parse on `commitbrief`, `commitbrief diff`, and
`commitbrief remote pr` alike. Accepting a flag isn't the same as honoring
it, though: in its default posting mode, `remote pr` **rejects**
`--json`/`--markdown`/`--output`/`--copy`/`--compact` — those five are
exempted under `--no-post`, since that mode renders locally instead of
posting to GitHub. The commit filters (`--author`, `--committer`,
`--start-date`, `--end-date`, `--text`) are rejected in every mode,
`--no-post` included, because `remote pr`'s diff always comes from
`gh pr diff`, never a local commit walk — see
[`remote pr`'s behavior notes](/docs/1.x/remote-pr#behavior-notes) for the
exact list. **Command flags** exist only on
the command they're listed under below — `commit`'s `--type` has no
meaning to `map`, and `--branches` has no meaning outside `map`.

The table below groups every non-hidden flag under the command it belongs
to. The root group, `commitbrief`, holds both: in that table, `--staged`
and `--unstaged` are local to the default review invocation itself;
everything else in that group is global. Local flags don't carry over to
`commit`, `guard`, or any other subcommand. This page doesn't repeat that
split per row; when a flag's behavior depends on which scope it's in, the
command's own page says so.

<FlagTable />

Two build-only flags are excluded: `--gen-surface` regenerates this
site's own surface data, and `--gen-man` generates the CLI's man pages
(`man/*.1`) — neither is part of the flags a normal invocation uses.

## See also

- [Which command do I need?](/docs/1.x/which-command) — task-to-command
  decision table.
- [`commitbrief list`](/docs/1.x/list) — the same commands with usage
  examples instead of a flag-by-flag table.
- [Environment variables](/docs/1.x/environment-variables) — the subset of
  settings also reachable without a flag.
- [Review scopes](/docs/1.x/review-scopes) — the path and commit filters in
  the `commitbrief` group, explained with examples.