Skip to main content

Git-history-aware codebase context generator for LLMs

Project description

gitbrief

Generate LLM-ready context from any git repository — in seconds.

gitbrief . --budget 8000 --clipboard              # copy to clipboard, ready to paste into Claude/GPT
gitbrief . --format xml                           # Claude-optimized XML output
gitbrief . --tree --prompt "Review for security"  # add directory tree + custom instruction
gitbrief . --changed-only --clipboard             # PR review: only files changed vs main
gitbrief . --changed-only --include-diff          # full PR context: diff + changed file contents
gitbrief-mcp                                      # start as MCP server (Claude Desktop integration)

PyPI version Python 3.10+ License: MIT Tests MCP


The problem

Every developer using LLMs (Claude, GPT, Gemini) manually copies code into chat windows. You paste some files, forget others, include outdated versions, blow the context window, and guess at what's relevant.

This is wasted engineering time.

The solution

gitbrief reads your git history to understand what's actually important right now, then packs the right files into a token-budget-aware document — perfect for pasting into any LLM.

$ gitbrief . --budget 8000 --stats

╭────────────────────────────╮
│ gitbrief allocation stats │
╰────────────────────────────╯
Token budget: 8,000 | Used: 7,999 (100%)
Files included: 6   | Skipped (budget): 194
Git commits analyzed: 100 | Branch: main

Top files by priority:
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━┓
┃ File                      ┃ Priority ┃ Tokens ┃ Changed? ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━┩
│ src/auth/middleware.py    │     0.95 │    432 │ 🔥       │
│ src/auth/tokens.py        │     0.91 │    318 │ 🔥       │
│ README.md                 │     0.83 │  1,240 │ 🔥       │
│ pyproject.toml            │     0.75 │    168 │ —        │
└───────────────────────────┴──────────┴────────┴──────────┘

Files marked 🔥 were modified in recent commits. The most relevant context surfaces automatically.


Why gitbrief beats alternatives

Feature gitbrief repomix llm-ctx manual
Git-history-aware ranking
Token budget control partial
Recency decay scoring
Recent commits narrative
PR review mode (changed files only)
Include git diff in output
Single command
--clipboard flag
XML output (Claude-optimized)
Directory tree in output
Append custom instruction
MCP server (Claude Desktop)

Install

pip install gitbrief

For MCP server support (Claude Desktop integration):

pip install "gitbrief[mcp]"

Requires Python 3.10+ and optionally a git repository.


Usage

# Basics
gitbrief .                          # current repo, 32k token budget
gitbrief /path/to/repo              # any repo

# Token budget control
gitbrief . --budget 8000            # fits GPT-4 32k
gitbrief . --budget 128000          # Claude 3.5 / GPT-4o full context

# Output
gitbrief . -o context.md            # write to file
gitbrief . --clipboard              # copy to clipboard (macOS/Linux/Windows)
gitbrief . | pbcopy                 # macOS: pipe to clipboard

# Format
gitbrief . --format xml             # Claude-optimized XML output (uses <documents> structure)
gitbrief . --format markdown        # default markdown output

# Filter
gitbrief . --no-tests               # skip test files (save tokens)

# PR review mode (v0.4+)
gitbrief . --changed-only                        # only files changed vs base branch (auto-detected)
gitbrief . --changed-only --base develop         # diff against a specific branch
gitbrief . --include-diff                        # add git diff to output
gitbrief . --changed-only --include-diff --clipboard  # ultimate PR review context

# Add context for LLM
gitbrief . --tree                   # include ASCII directory tree
gitbrief . --prompt "Review for security vulnerabilities"  # append instruction to context
gitbrief . --tree --prompt "What tests are missing?" --clipboard  # combine everything

# Debug
gitbrief . --stats                  # print allocation table to stderr
gitbrief . --max-commits 200        # analyze more git history

Claude Desktop Integration (MCP)

gitbrief v0.5.0 ships as an MCP server, letting you use it directly inside Claude Desktop — no terminal switching needed.

Setup

1. Install with MCP support:

pip install "gitbrief[mcp]"

2. Add to Claude Desktop config:

Edit ~/Library/Application Support/Claude/claude_desktop_config.json (macOS):

{
  "mcpServers": {
    "gitbrief": {
      "command": "gitbrief-mcp"
    }
  }
}

3. Restart Claude Desktop — you'll see gitbrief tools in the toolbar.

MCP tools exposed

Tool Description
pack_context Pack repo into LLM-ready context (the main gitbrief command)
get_repo_summary Get recent commits, hotspot files, and contributors
list_repo_files List files ranked by git-history priority

Example prompts in Claude Desktop

Once configured, you can say things like:

  • "Pack my repo at ~/projects/myapp with an 8k token budget"
  • "Show me what files changed most in ~/projects/api recently"
  • "Pack only the changed files in my current branch for PR review"

How ranking works

gitbrief assigns each file a priority score (0–1):

  • Recency (60%): exponential decay — files changed today = 1.0, untouched 6 months = ~0.25
  • Frequency (40%): normalized commit frequency across history
  • Recency bonus: +0.2 if the file appeared in the most recent 20% of commits
  • Type bonuses: README (+0.1), config files (+0.15)

Files are sorted by priority and greedily selected within your token budget.


Development

git clone https://github.com/faw21/gitbrief
cd gitbrief
python -m venv .venv && source .venv/bin/activate
pip install -e ".[dev]"
pytest tests/   # 84 tests, 90% coverage

Related Tools

standup-ai — Generate your daily standup from git history using AI.

gpr — AI-powered PR descriptions and commit messages from your git diff.

critiq — AI code reviewer that runs locally before you push. Catches bugs and security issues with CRITICAL/WARNING severity levels.

changelog-ai — Generate CHANGELOG entries from git history using AI.

git-chronicle — AI-powered git history narrator. Turns your git log into engaging stories (narrative, timeline, or detective mode).

# The full AI-powered git workflow:
standup-ai --yesterday                                    # 1. morning standup
critiq                                                    # 2. AI review before committing
gpr --commit-run                                          # 3. commit with AI message
gitbrief . --changed-only --clipboard                    # 4. pack context for PR review
gpr                                                       # 5. generate PR description
changelog-ai --release-version v1.x.0 --prepend CHANGELOG.md  # 6. update changelog
chronicle file src/payments.py --style detective          # 7. understand complex history

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitbrief-0.5.0.tar.gz (22.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gitbrief-0.5.0-py3-none-any.whl (20.4 kB view details)

Uploaded Python 3

File details

Details for the file gitbrief-0.5.0.tar.gz.

File metadata

  • Download URL: gitbrief-0.5.0.tar.gz
  • Upload date:
  • Size: 22.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for gitbrief-0.5.0.tar.gz
Algorithm Hash digest
SHA256 456866d61661e2025d5d79488990d881f48bcf8f4dc937996120e3895a9db6a6
MD5 e0da5ab6a5a60847b5183aeddbe0ec48
BLAKE2b-256 8d06ee5da8288ebbac46cc2a33ada2eada0082dcf9ab7573647b9d20713a9d10

See more details on using hashes here.

File details

Details for the file gitbrief-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: gitbrief-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 20.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.3

File hashes

Hashes for gitbrief-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 3dd2bcb88d5bf700461009c59a20f0440c3a18ba74cde57fc0d7e158883d0101
MD5 516e61831ce5e11f78549afa7fd96649
BLAKE2b-256 8d8b73f1ae638485ed183f559782ddc85606db6d2f5d86250ce90f004d1252dc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page