DiffWeave AI

DiffWeave is a tool that automatically generates meaningful Git commit messages and pull request descriptions using large language models (LLMs). It analyzes your staged changes and creates descriptive commit messages, saving you time and ensuring consistent documentation.

Documentation available here

Installation & Quick Start

You can run DiffWeave via uvx diffweave-ai or from a local checkout using uv run diffweave-ai while developing this repo.

DiffWeave is installed as an isolated tool using uv:

# Make sure you have uv installed first
# https://docs.astral.sh/uv/getting-started/installation/

uvx diffweave-ai

Usage

Configure a model

Before generating commit messages, configure your model. DiffWeave supports two authentication types:

Token-based (OpenAI-compatible endpoints):

uvx diffweave-ai set-token-model "your-model-name" \
  --token "$YOUR_API_TOKEN" \
  --endpoint "https://your-endpoint-url"

The --endpoint flag defaults to https://api.openai.com/v1 if omitted.

Databricks (browser-based authentication):

uvx diffweave-ai set-databricks-browser-model "your-model-name" \
  --account "your-databricks-account"

This opens a browser window for authentication and caches the resulting token automatically.

Generate a commit message

Once you have a model configured and some changes staged in your current Git repository, run:

uvx diffweave-ai

This will:

• Show the current git status.
• Prompt you to stage files interactively.
• Generate a commit message using your configured model.
• Let you review and refine the message before committing.
• Run git commit, then prompt whether to git push.
• Optionally open the repository in a browser (requires --open-browser).

If you prefer a simpler, natural-language style instead of Conventional Commits, pass --simple:

uvx diffweave-ai --simple

To preview a message without committing:

uvx diffweave-ai --dry-run

For scripted or automated workflows (skips all prompts, commits, and pushes automatically):

uvx diffweave-ai --non-interactive

Generate a pull request description

To generate a PR title and body based on the diff between your branch and main:

uvx diffweave-ai pr

The result is copied to your clipboard automatically. Use --branch to diff against a branch other than main:

uvx diffweave-ai pr --branch my-base-branch

Features

• AI-powered commit message generation based on staged diffs
• Pull request description generation with automatic clipboard copy
• Interactive or non-interactive workflows
• Token-based (OpenAI-compatible) and Databricks browser authentication
• Optional simpler commit style via --simple
• Optional push and browser-open flow after committing