README file from
GithubAI Commit for Obsidian
Generate meaningful git commit messages via DeepSeek AI directly from Obsidian Git source control view.
Adds a sparkle button next to the Commit button. Click it to generate a commit message from staged changes.
Features
- One-click generation — button in Obsidian Git source control view, or via command palette
- DeepSeek V4 Flash — fast and cheap default model, V4 Pro available
- Customizable prompt — adjust language, style, and tone
- Timeout & retry — configurable timeout (10–120s) with automatic retries (3 attempts)
- Plain messages — no Conventional Commits prefixes (unless you configure them in custom instructions)
Requirements
- Obsidian Git plugin installed and configured
- DeepSeek API key
- Git available on the system
Installation
From Community Plugins
- Open Settings → Community Plugins
- Search "AI Commit"
- Install and enable
Manual (BRAT)
- Install BRAT plugin
- Add
arumata/obsidian-ai-commitas a beta plugin
Manual (direct)
cd /path/to/vault/.obsidian/plugins
git clone https://github.com/arumata/obsidian-ai-commit.git ai-commit
cd ai-commit && npm install && npm run build
Settings
| Setting | Default | Description |
|---|---|---|
| API Key | — | DeepSeek API key (stored locally, never sent anywhere but DeepSeek) |
| Model | DeepSeek V4 Flash | V4 Flash (fast/cheap) or V4 Pro (more capable) |
| Timeout | 30s | API request timeout (10–120s) |
| Custom instructions | — | Extra prompt rules (e.g. "Always write in Russian") |
How It Works
- Stage files in Obsidian Git
- Click the ✨ button (or
Ctrl+P→ "Generate commit message") - The plugin runs
git diff --cached, sends the diff to DeepSeek - The generated message appears in the commit text area
- Review and click Commit
Development
npm install
npm run dev # Watch mode
npm run build # Production build