Documentation

Everything you need to know about CommitMind's architecture, credit system, AI modes, and integration points.

Quick Start How it works Plans Credits AI Suggest Languages Limits CLI VS Code BYOK Subscription FAQ Fair Usage

⚡ Quick Start

Get started with CommitMind in VS Code within 30 seconds:

1

Install

Search for CommitMind in the VS Code Marketplace and install the extension.

2

Sign In

Click the CommitMind icon in the activity bar and sign in with your account (your 10 free credits are instantly activated).

3

Stage Changes

Go to the Source Control panel and stage your files.

4

Generate

Click the ✨ "Magic" button in the commit message box. Your commit message is ready!

1. How CommitMind Works

CommitMind analyzes your Git diff and generates structured, conventional commit messages automatically using AI. It's built on a credit-based architecture to ensure predictable usage and fair resource allocation for all users.

  • 1 generation = 1 credit
  • Pro users can generate commits in up to 4 languages simultaneously.
  • Your monthly credits are consumed first, followed by any purchased credits.

CommitMind is more than just an AI tool; it's a structured commit standardization platform designed to improve team collaboration and project history.

2. Plans & Features

Choose the plan that fits your workflow. All plans include access to the core AI engine.

Free Plan
  • 🔹 Basic AI commit generation
  • 🔹 English-only commits
  • 🔹 10 monthly credits
  • 🔹 Prompt generation fallback
  • 🔹 Standard daily limits
Pro Plan
  • ⭐ 200 monthly credits
  • ⭐ Multi-language commits (up to 4)
  • ⭐ Use purchased credits
  • ⭐ Bring Your Own Key (BYOK)
  • ⭐ Higher daily limits

3. Credit System

Every AI generation consumes one credit. This ensures we can provide a fast and reliable service for everyone.

# Example: 1 API call to generate a commit message = 1 credit

Monthly Credits

  • Free: 10 credits, resetting monthly.
  • Pro: 200 credits, resetting monthly.
  • Unused monthly credits expire at the end of the billing cycle.

Purchased Credits (Top-ups)

  • Purchased credits never expire.
  • They are used only after your monthly credits are depleted.
  • An active Pro subscription is required to use purchased credits.
Important: Purchased credits remain in your account permanently but are only accessible with an active Pro subscription. If you downgrade, they will be stored until you reactivate Pro.

4. AI Suggest Modes

You control when the AI is invoked. The "AI Suggest" toggle in the extension or CLI gives you this power.

AI Suggest: ON

  • The commit message is generated automatically when you open the commit panel.
  • Consumes 1 credit per generation.
  • If you're out of credits, the system gracefully falls back to prompt mode.

AI Suggest: OFF

  • No automatic generation occurs.
  • CommitMind produces a structured, AI-ready prompt based on your diff.
  • No credits are consumed. Pro users get a more detailed prompt structure.

5. Multi-Language Generation

While the default commit language is English, Pro users can expand their team's reach.

  • Select up to 3 additional languages (total of 4).
  • All commits are generated in a single AI request.
  • This consumes only 1 credit, regardless of the number of languages.

Example Output:

feat(auth): add OAuth2 login with Google feat(auth): OAuth2-Login mit Google hinzufügen feat(auth): Google ile OAuth2 girişi eklendi feat(auth): agregar inicio de sesión OAuth2 con Google

6. Daily Limits

To ensure fair usage and system stability, we enforce daily operation limits.

  • Free Plan: 20 operations per day.
  • Pro Plan: 200 operations per day.

Operations include both successful AI generations and prompt generations. Exceeding your daily limit will temporarily block new operations until the next UTC day.

7. CLI Usage

Integrate CommitMind directly into your terminal workflow.

$ commitmind generate > feat(api): add rate limiting to user endpoints

The CLI performs these steps:

  1. Reads the current `git diff`.
  2. Checks your credit balance.
  3. Requests generation from the CommitMind API.
  4. Outputs the structured message, ready for `git commit -m "..."`.

8. VS Code Extension

The CommitMind VS Code extension brings AI commits into your editor.

  • Dedicated commit panel in the Source Control view.
  • One-click AI Suggest toggle.
  • Multi-language selection dropdown.
  • Real-time credit status display.
  • Instant commit generation and insertion.

9. Bring Your Own Key (BYOK)

Pro users can connect their own AI provider API key and use CommitMind with their personal AI account.

  • Your API key is stored locally in the CommitMind VS Code extension.
  • The key is sent only with the request when generating commits.
  • CommitMind does not store or persist your API key in its database.
  • AI usage is billed directly by your chosen provider (OpenAI, Anthropic, etc.).
  • CommitMind credits are not consumed when using BYOK.
  • Daily operation limits and rate limits still apply.
Security Note: Your API key remains in your local extension environment and is never stored in CommitMind servers or databases.

10. Subscription Lifecycle

  • Activation: Pro features are available immediately after successful payment.
  • Expiration: Access to Pro features ends at the conclusion of your billing period.
  • Purchased Credits: These remain in your account even after expiration and are re-activated if you resubscribe.

❓ Frequently Asked Questions

Technical details that developers ask most often:

A: No. If you're using your own OpenAI or Anthropic key on the Pro plan, your CommitMind credits are not consumed. Your API key remains stored locally in the CommitMind extension and is never stored on CommitMind servers. Daily operation limits still apply.

A: CommitMind trims and optimizes large diffs to fit within the AI model's context window. If a diff is extremely large, the system focuses on the most relevant file changes to generate a meaningful commit summary.

A: No. Your Git diff is processed only during commit generation and is not stored in CommitMind databases. The data is discarded immediately after the AI response is generated.

A: You can turn off "AI Suggest" mode and switch to Prompt Mode. This mode doesn't consume any credits and gives you an optimized prompt that you can manually use. Prompt Mode generates a structured prompt that you can paste into any AI tool.

A: Select your target languages in the extension settings. With one click, translations of your commit message in other languages will be automatically appended. English is always generated as the primary commit language.

A: CommitMind follows the Conventional Commits specification to generate clean and structured commit messages.

A: No. CommitMind only generates commit messages. Developers always review and create the commit manually using Git.

11. Fair Usage Protection

CommitMind is built for developers, by developers. We employ several mechanisms to ensure the platform remains fast and reliable for everyone.

  • Credit-based consumption model.
  • Per-user daily operation limits.
  • Real-time usage monitoring.
  • Automated abuse detection (e.g., rapid-fire requests).

These protections help us maintain a high-quality, fair, and sustainable service for all users.

↑ Back to top