Skip to content
branchbrief branchbrief

Local CLI usage

The core command reads local git state and writes a branch brief.

Terminal window
branchbrief

Default behavior should:

  • Render Markdown to stdout.
  • Detect the current branch.
  • Detect or accept the base branch.
  • Collect commits, changed files, diff stats, and working tree status.
  • Classify risk from deterministic rules.
  • Suggest verification commands.
  • Avoid network access and LLM calls.

Use --repo-root when running from outside the repository root:

Terminal window
branchbrief --repo-root /path/to/repo --base main