Docomit 🚀

The AI Copilot for Your Git Workflow & Documentation

Stop writing generic commit messages. Stop letting your documentation rot. > Docomit uses advanced AI to analyze your code changes, generate semantic commit messages, and automatically update your project documentation in real-time.

✨ Features

1. 🤖 Intelligent Commit Messages

Never write fix: bug again. Docomit analyzes your staged git diff and generates descriptive, concise commit messages following Conventional Commits standards.

• Context-Aware: Understands the "why" behind your changes.
• Customizable: Tweak the system prompt to match your team's tone (emojis, strict format, etc.).

2. 📚 Auto-Updating Documentation

The hardest part of coding is keeping docs in sync. Docomit does it for you.

• Smart Detection: When you change a file (e.g., auth.ts), Docomit finds the corresponding doc (e.g., docs/auth.md) and updates it.
• Context Fusion: Reads the source code, the diff, and the existing documentation to intelligently merge updates without overwriting your manual notes.
• Smart Mapping: Automatically learns your project structure to map source files to documentation files.

3. 🔒 Privacy & Security

• BYOK (Bring Your Own Key): Power users can input their own Google Gemini API Key. It is stored securely in VS Code Secrets and never leaves your machine.
• Free Tier: Don't have a key? Use our hosted tier (with usage limits) to get started instantly.

🚀 Getting Started

1. Install the Docomit extension from the Marketplace.
2. Open the Docomit Sidebar (look for the 📝 icon).
3. Sign In with GitHub to sync your settings and usage.
4. (Optional) Go to the Settings tab in the sidebar and enter your Google Gemini API Key for unlimited usage.

🛠 Usage Guide

Generating a Commit

1. Stage your changes: git add .
2. Click "✨ Generate Commit Message" in the sidebar.
3. Review the message in the text box and click the copy icon to use it.

Updating Documentation

1. Stage the files you want to document.
2. Click "📝 Update Docs for Staged Files".
3. Docomit will:

• Analyze the changes.
• Find or create the correct markdown file in your docs/ folder.
• Write the updates locally.

4. Review the changes in the Source Control view before committing!

⚙️ Configuration

Documentation Mapping (docomit.mapping)

Docomit tries to be smart, but you can force specific mappings in the Settings Tab.

The Logic:

• Empty: AI creates a docs/ folder and mirrors your source structure.
• Custom JSON: Map folders or specific files.

Example Mappings:

{
  // Mirror all source files to a 'wiki' folder
  "src/*": "wiki/",

  // Force a specific file to a specific doc
  "src/database/schema.ts": "docs/Architecture.md",

  // Group multiple files (Advanced AI context)
  "src/components/*": "docs/Components.md"
}

Custom Prompts

Want the AI to sound like a pirate? Or strict corporate speak? Edit the System Prompts in the Settings tab.

• Commit Prompt Variable: {{DIFF}}
• Doc Prompt Variables: {{SOURCE_CODE}}, {{EXISTING_DOCS}}, {{DIFF}}

🔐 Data & Privacy

We take your code privacy seriously.

• Local Processing: If you use your own API Key, your code is sent directly from VS Code to the Google Gemini API. It does not pass through our servers.
• Hosted Tier: If you use the free tier, your diffs are processed ephemerally by our proxy to attach our API key and then sent to Google. We do not store your code.

📝 Requirements

• VS Code: v1.80.0 or higher.
• Google Gemini API Key: Recommended for best performance and privacy. Get one here.

Enjoying Docomit? Please leave a ⭐⭐⭐⭐⭐ review!

Built with ❤️ using Bun, TypeScript, and the Vercel AI SDK.