Home

CommitBrief Wiki

User guide for CommitBrief, the local LLM-powered code-review CLI for git diffs.

This wiki documents only what ships in the binary. Every command, flag, and configuration key here was verified directly against the source.

Pages

Getting started

• Installation
• Quick start
• First-time setup

Commands

• Review (default command)
• init
• setup
• providers
• config
• doctor
• install-hook
• compress
• cache
• diff
• dry-run
• list

Configuration

• Configuration files
• Environment variables
• Global flags
• Filtering: ignore + path filters

Providers

• Providers overview
• Anthropic
• OpenAI
• Google Gemini
• Ollama (local)
• claude-cli / gemini-cli

Output

• Output formats
• COMMITBRIEF.md (review rules)
• OUTPUT.md (output template)
• JSON schema v1

Operations

• Cache behavior
• Secret scanner
• Cost preflight
• --fail-on and exit codes

Reference

• Severity levels
• Localization (en, tr)
• Troubleshooting