AI Commit Messages
Sweep automatically generates commit messages based on your staged changes. When you open the Commit window, the plugin analyzes your diff and populates a descriptive commit message.
- Open the Commit window (
⌘ 0/Ctrl 0) - Wait a moment for the AI to analyze your changes
The plugin only updates the message when the field is empty, so your custom messages won't be overwritten.
You can also select specific files (and even specific diff hunks) to generate commit messages for. To regenerate a commit message, click the "Sweep" icon in the above image.
Customization
Sweep
By default, Sweep will learn from your last 10 commits. This helps match your team's commit style (e.g., conventional commits, ticket references). If this isn't doing what you want, we recommend configuring a custom commit template.
Custom Commit Template
Create a sweep-commit-template.md file in your project root with a prompt to define your commit format. This can be a prompt with examples like this:
Format: <type>: <brief description>
Types: feat, fix, docs, refactor, test
Examples:
- feat: Add user authentication endpoint
- fix: Resolve null pointer exception in login handler
- docs: Update API documentation for auth endpoints