releasebrief

Turn git commits into useful summaries. AI-powered standups, weekly recaps, and team reports from your commit history.

npx @aaaaorg/releasebrief --week

📋 Git Recap — 47 commits across 3 repos

## Summary
This week focused on user authentication and performance improvements.
Key changes include OAuth integration, caching layer optimization, and
several bug fixes in the payment flow.

### Highlights
- ✨ Added OAuth2 support for Google and GitHub login
- ⚡ Reduced API response time by 40% with Redis caching
- 🐛 Fixed race condition in payment webhook handling

Features

• 🕐 Time-based summaries: --week, --today, --since "Monday"
• 📁 Multi-repo support: Scan multiple projects at once
• 👥 Team mode: Get summaries for your whole team
• 🤖 Multiple AI providers: OpenAI, Anthropic, Ollama, OpenRouter
• 📝 Flexible formats: Markdown, plain text, Slack-ready, JSON
• ⚡ No AI mode: Just list commits with --no-ai

Quick Start

# Install globally
npm install -g @aaaaorg/releasebrief

# Configure your AI provider
releasebrief setup

# Generate a weekly summary
releasebrief --week

Usage

# Today's commits
releasebrief --today

# Last 7 days
releasebrief --week

# Custom date range
releasebrief --since "2026-01-01" --until "2026-01-31"

# Filter by author
releasebrief --week --author "Jane"

# Team summary (all authors)
releasebrief --week --team

# Scan multiple repos
releasebrief --week --repos ~/projects/app ~/projects/api

# Include file change stats for richer AI context
releasebrief --week --diff-stats

# Skip AI, just list commits
releasebrief --week --no-ai

# Output as JSON
releasebrief --week --format json

Configuration

Run releasebrief setup to configure your AI provider:

releasebrief setup
# Follow the prompts to set provider and API key

Or set environment variables:

export OPENAI_API_KEY="sk-..."
# or
export ANTHROPIC_API_KEY="sk-ant-..."

Check current config:

releasebrief config

Supported Providers

| Provider | Models | Notes | |----------|--------|-------| | OpenAI | gpt-4o, gpt-4o-mini, etc. | Best quality | | Anthropic | claude-3-5-sonnet, etc. | Great for nuanced summaries | | Ollama | llama3.2, mistral, etc. | Free, runs locally | | OpenRouter | Any model | Gateway to many providers |

CI / Automation

Run releasebrief in CI pipelines with zero interactivity:

# CI mode: env-var config, no spinners, no prompts
ANTHROPIC_API_KEY=sk-ant-... releasebrief --ci --week --output summary.md

# Post to Slack or Discord via webhook
releasebrief --ci --week --webhook https://hooks.slack.com/services/...

# Combine: save file + post webhook + suppress stdout
releasebrief --ci --week --output summary.md --webhook $SLACK_URL --quiet

GitHub Action

- uses: aaaaorg/releasebrief@v1
  with:
    provider: anthropic
    api-key: ${{ secrets.ANTHROPIC_API_KEY }}
    args: --week --format slack
    webhook: ${{ secrets.SLACK_WEBHOOK }}

Output Formats

• markdown (default): Clean markdown with headers
• plain: Simple text, no formatting
• slack: Slack-flavored markdown with emojis
• json: Structured data for pipelines

Examples

Daily Standup

releasebrief --today --format plain

Weekly Team Report

releasebrief --week --team --repos ~/work/*

Monthly Summary for a Specific Author

releasebrief --since "2026-01-01" --until "2026-01-31" --author "alice"

Requirements

• Node.js 18+
• Git (in PATH)
• API key for your chosen LLM provider (or Ollama running locally)

License

MIT © aaaaorg