Integrations

GitScribe works seamlessly with your existing tools. From IDEs to CI/CD pipelines, we've got you covered.

IDE Integrations

Visual Studio Code

Install the official GitScribe extension for VS Code:

  1. Open VS Code
  2. Go to Extensions (Ctrl+Shift+X)
  3. Search for "GitScribe"
  4. Click Install

Or install via command line:

code --install-extension gitscribe.gitscribe-vscode

Features

  • Generate commit messages from Source Control panel
  • Keyboard shortcut - Ctrl+Shift+G (Cmd+Shift+G on Mac)
  • Inline diff analysis
  • Configuration sync with .gitscribe.toml

Settings

// settings.json
{
  "gitscribe.autoStage": false,
  "gitscribe.showPreview": true,
  "gitscribe.keyBinding": "ctrl+shift+g",
  "gitscribe.model": "gpt-4"
}

JetBrains IDEs

Available for IntelliJ IDEA, WebStorm, PyCharm, and other JetBrains IDEs:

  1. Open Settings/Preferences
  2. Go to Plugins
  3. Search for "GitScribe"
  4. Click Install and restart IDE

Usage

  • Right-click in editor: "Generate Commit Message"
  • VCS menu: "GitScribe → Generate"
  • Commit dialog: Click "Generate with GitScribe" button

Vim/Neovim

Install the GitScribe plugin:

Using vim-plug

" ~/.vimrc or ~/.config/nvim/init.vim
Plug 'gitscribe/vim-gitscribe'

Using Lazy.nvim

-- ~/.config/nvim/lua/plugins/gitscribe.lua
return {
  "gitscribe/vim-gitscribe",
  config = function()
    require("gitscribe").setup({
      model = "local",
      auto_stage = false,
    })
  end,
}

Commands

:GitScribe         " Generate commit message
:GitScribeConfig   " Open configuration
:GitScribeStatus   " Show current status

Sublime Text

Install via Package Control:

  1. Open Command Palette (Ctrl+Shift+P)
  2. Type "Package Control: Install Package"
  3. Search for "GitScribe"
  4. Press Enter to install

Git GUI Integrations

TortoiseGit

GitScribe integrates seamlessly with TortoiseGit:

  1. Right-click in your repository
  2. TortoiseGit → Settings
  3. Hook Scripts → Add
  4. Hook Type: Start Commit Hook
  5. Command: gitscribe.exe generate --tortoise

GitHub Desktop

Enable GitScribe in GitHub Desktop:

  1. File → Options (or GitHub Desktop → Preferences on Mac)
  2. Integrations tab
  3. External Editor: Set to gitscribe
  4. Check "Use GitScribe for commits"

GitKraken

# Add custom hook
echo 'gitscribe generate --format json' > .git/hooks/prepare-commit-msg
chmod +x .git/hooks/prepare-commit-msg

Tower

Configure Tower to use GitScribe:

  1. Tower → Preferences → Git Config
  2. Commit Message → External Tool
  3. Command: /usr/local/bin/gitscribe generate

CI/CD Integrations

GitHub Actions

name: Auto-commit with GitScribe
on:
  workflow_dispatch:
  schedule:
    - cron: '0 9 * * 1' # Weekly on Monday

jobs:
  auto-commit:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      
      - name: Install GitScribe
        run: |
          curl -sSL https://gitscri.be/install | sh
          
      - name: Configure GitScribe
        run: |
          gitscribe config set ai.model gpt-4
          gitscribe config set ai.api_key ${{ secrets.GITSCRIBE_API_KEY }}
          
      - name: Make changes
        run: |
          # Your automated changes here
          npm update
          
      - name: Commit with GitScribe
        run: |
          git add .
          gitscribe generate --commit

GitLab CI

# .gitlab-ci.yml
auto-commit:
  stage: maintenance
  image: gitscribe/gitscribe:latest
  script:
    - gitscribe config set ai.api_key $GITSCRIBE_API_KEY
    - git add .
    - gitscribe generate --commit
  only:
    - schedules

Jenkins

pipeline {
  agent any
  
  stages {
    stage('Commit Changes') {
      steps {
        sh '''
          curl -sSL https://gitscri.be/install | sh
          gitscribe generate --commit
        '''
      }
    }
  }
}

Shell Integrations

Git Aliases

# Add to ~/.gitconfig
[alias]
  # Quick commit with GitScribe
  gs = !gitscribe generate --commit
  
  # GitScribe with preview
  gsp = !gitscribe generate --preview
  
  # Amend with GitScribe
  gsa = !gitscribe generate --amend

Zsh Plugin

# Add to ~/.zshrc
zinit light gitscribe/zsh-gitscribe

# Or with oh-my-zsh
git clone https://github.com/gitscribe/oh-my-zsh-gitscribe   ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/gitscribe
# Add 'gitscribe' to plugins in ~/.zshrc

Fish Functions

# ~/.config/fish/functions/gc.fish
function gc --description 'Commit with GitScribe'
  gitscribe generate --commit $argv
end

# ~/.config/fish/functions/gcp.fish  
function gcp --description 'Commit and push with GitScribe'
  gitscribe generate --commit $argv && git push
end

API Integrations

Pre-commit Hook

# .pre-commit-config.yaml
repos:
  - repo: https://github.com/gitscribe/pre-commit-hooks
    rev: v1.0.0
    hooks:
      - id: gitscribe-generate
        stages: [commit-msg]
      - id: gitscribe-validate
        stages: [commit-msg]

Husky

# Install husky
npm install --save-dev husky

# Add GitScribe hook
npx husky add .husky/prepare-commit-msg 'gitscribe generate --hook'

Git Hooks (Manual)

#!/bin/sh
# .git/hooks/prepare-commit-msg

# Generate commit message with GitScribe
if [ -z "$2" ]; then
  gitscribe generate --output "$1"
fi

Custom Integrations

REST API

# Generate commit message via API
curl -X POST https://api.gitscri.be/v1/generate   -H "Authorization: Bearer YOUR_API_KEY"   -H "Content-Type: application/json"   -d '{
    "diff": "\$(git diff --staged)",
    "model": "gpt-4",
    "style": "conventional"
  }'

SDK Integration

Node.js

const { GitScribe } = require('@gitscribe/sdk');

const gitscribe = new GitScribe({
  apiKey: process.env.GITSCRIBE_API_KEY,
  model: 'gpt-4'
});

const message = await gitscribe.generate({
  diff: await exec('git diff --staged'),
  style: 'conventional'
});

console.log(message);

Python

from gitscribe import GitScribe

client = GitScribe(
    api_key=os.environ["GITSCRIBE_API_KEY"],
    model="gpt-4"
)

message = client.generate(
    diff=subprocess.check_output(["git", "diff", "--staged"]),
    style="conventional"
)

print(message)

Browser Extensions

GitHub

Install the GitScribe browser extension for GitHub:

Features:

  • Generate PR descriptions
  • Enhance commit messages in PR view
  • Quick commit from GitHub web editor

GitLab

Enable in GitLab settings:

  1. Project Settings → Integrations
  2. Add "GitScribe"
  3. Enter API key
  4. Save changes

Mobile Apps

Working Copy (iOS)

Configure GitScribe in Working Copy:

  1. Settings → Git Config
  2. Commit Template
  3. Set to: gitscribe://generate

Termux (Android)

# Install in Termux
pkg install git curl
curl -sSL https://gitscri.be/install | sh

Need help with integrations? Check our API documentation or join our Discord for support.