GIT AI COMMIT

Tired of writing commit messages? Let the computer do it for you!

It's shit, but better than "WIP"!

Installation

bun add -g git-aicommit

Configuration

This cli tool uses standard rc files:

• local .git-aicommitrc
• $HOME/.git-aicommitrc
• $HOME/.git-aicommit/config
• $HOME/.config/git-aicommit
• $HOME/.config/git-aicommit/config
• /etc/git-aicommitrc
• /etc/git-aicommit/config

Or default config is used if no config file is found.

To override default config, create a config file and export an object with the following properties:

touch $HOME/.git-aicommitrc

// $HOME/.git-aicommitrc
export default {
    openAiKey: process.env.OPENAI_API_KEY,
    baseURL: process.env.OPENAI_BASE_URL || null,
    defaultHeaders: null,
    defaultQuery: null,
    autocommit: true,
    openCommitTextEditor: false,
    language: 'english',
    projectInstruction: null,
    systemMessagePromptTemplate: '' +
        'You are expert software developer, your job is to write clear and concise Git commit messages. ' +
        'Your responsibility is to ensure that these messages accurately describe the changes made in each commit,' +
        'follow established guidelines. Provide a clear history of changes to the codebase.' +
        'Write 1-2 sentences. Output only the commit message without comments or other text.',
    humanPromptTemplate: '' +
        'Read the following git diff for a multiple files and ' +
        'write 1-2 sentences commit message in {language} ' +
        'without mentioning lines or files. ' +
        'If the reason behind the changed can be deducted from the changed, provide this reason.\n' +
        'Current branch: {branch}\n' +
        '{projectInstruction}\n' +
        '{customInstruction}\n' +
        'Git diff:\n' +
        '{diff}',
    excludeFromDiff: [
        '*.lock', '*.lockb', '*-lock.json', '*-lock.yaml'
    ],
    diffFilter: 'ACMRTUXB',
    modelName: "gpt-4.1-mini",
    completionPromptParams: {
        maxTokens: 2000,
    },
}

Prompt Template Variables

The humanPromptTemplate supports the following variables:

• {diff} - The git diff of staged changes
• {language} - The language for the commit message (default: 'english')
• {branch} - Current git branch name
• {projectInstruction} - Project-level instructions (configurable via config file)
• {customInstruction} - Custom instruction passed via command line

Example usage with custom instruction:

git-aicommit added fix for issue #123

Command line arguments

git-aicommit --openAiKey="sk-..." --completionPromptParams.temperature=0.3 --no-autocommit

Usage

export OPENAI_API_KEY=sk-YOUR_API_KEY
git-aicommit

Or make an alias:

alias gai="git add --all && git-aicommit && git push"

## And run it:
gai

Azure OpenAI Integration

To use Azure OpenAI instead of the official OpenAI API, set the following environment variables:

export OPENAI_API_KEY="your-azure-api-key"
export OPENAI_BASE_URL="https://<your-instance>.openai.azure.com/openai/deployments/<your-deployment>"
export OPENAI_DEFAULT_HEADERS='{"api-key": "your-azure-api-key"}'
export OPENAI_DEFAULT_QUERY='{"api-version": "2024-02-15-preview"}'

Or add them to your config file:

// $HOME/.git-aicommitrc
export default {
    openAiKey: process.env.AZURE_OPENAI_API_KEY,
    baseURL: process.env.AZURE_OPENAI_BASE_URL,
    defaultHeaders: { 'api-key': process.env.AZURE_OPENAI_API_KEY },
    defaultQuery: { 'api-version': '2024-02-15-preview' },
}

It's that simple!