Skip to content

List command

Jump to bottom
Muhammet Şafak edited this page May 27, 2026 · 1 revision

commitbrief list

Print the command reference — every subcommand, every flag — plus a "Current configuration" summary block based on the resolved context.

Synopsis

commitbrief list

Takes no arguments. Tolerates being run outside a git repo (the summary block degrades gracefully).

Output

Two sections, both rendered as markdown:

1. Command reference

A static markdown document built into the binary. Covers:

  • Review (default) scopes and inherited flags
  • The diff subcommand
  • init, setup, providers (list|use|test)
  • config (show|get|set)
  • doctor, install-hook, compress
  • cache (clear|prune)
  • dry-run, list
  • Global flags and environment variables
  • Filtering layers

2. Current configuration

A live snapshot of what the binary would do right now:

  • Active provider + model
  • Where COMMITBRIEF.md is sourced from (repo file or embedded default)
  • Where OUTPUT.md is sourced from
  • Cache footprint (entry count + total size)
  • Active language + source

API keys are never printed here. Use commitbrief providers list (which masks them) for that.

Rendering

  • Default TTY: rendered via the terminal glamour theme (colored markdown).
  • --markdown / --json / non-TTY / --color=never: plain markdown (no ANSI).

The --output <file> global flag also applies; commitbrief list --markdown --output COMMANDS.md saves the reference to a file.

When to use

  • Quick reminder of a flag you cannot recall.
  • "What provider am I using right now?" — the summary answers.
  • Generating a static command-reference document for project docs.
  • Verifying a custom config layer (e.g. commitbrief list after --lang=tr to confirm the locale resolution).

Clone this wiki locally