Documentation
Everything you need to get started with Smart Commit.
Installation
- Open your IntelliJ-based IDE (IntelliJ IDEA, WebStorm, PyCharm, etc.)
- Go to Settings → Plugins → Marketplace
- Search for "Smart Commit"
- Click Install and restart your IDE
Or install directly from the JetBrains Marketplace.
Generator Modes
Smart Commit supports four generation modes. Choose the one that fits your workflow.
Cloud AI — no API key, no setup. Works instantly out of the box.
Free: 30/month. Starter ($1/mo): 300. Pro ($5/mo): 3,000. Diffs are never stored.
To use Cloud AI, sign in to your Smart Commit account via the "Connect IDE" flow in plugin settings.
Usage
There are three ways to generate a commit message:
- Click the lightning bolt button in the commit dialog toolbar
- Use the menu: Tools → Smart Commit → Generate Commit Message
- Use the keyboard shortcut (configurable in Keymap settings)
The plugin analyzes your staged changes, generates a message, and inserts it into the commit message field. Review, edit if needed, and commit.
Keyboard Shortcuts
| Action | Default Shortcut |
|---|---|
| Generate Commit Message | Configurable |
| Show Commit History | Alt+H |
| Open Smart Commit Settings | Via Settings dialog |
Configuration
All settings are accessible via Settings → Tools → Smart Commit.
AI Provider
Choose between Cloud AI, OpenAI, Ollama, or Template generator.
Commit Convention
Conventional Commits, Gitmoji, or Free-form style.
Commit Style
One-line (subject only) or Detailed (subject + body).
Language
Generate messages in any of 12 supported languages.
Custom Prompt
Override the default AI prompt with your own instructions.
OpenAI Settings
API key, model selection, and endpoint configuration.
Ollama Settings
Endpoint URL and model name for local generation.
Max Diff Length
Control how much of the diff is sent to the AI for analysis.
Connect IDE (Cloud AI)
To use Cloud AI, connect your IDE to your Smart Commit account:
- In plugin settings, click "Connect IDE"
- A browser window opens with a device code
- Sign in (or create an account) and approve the connection
- Your IDE is now connected — Cloud AI is ready to use
You can manage connected devices in your account dashboard.
Commit History
Smart Commit keeps a history of generated messages. Press Alt+H in the commit dialog to open the history popup.
Select any previous message to re-use it. History is stored locally per project.
Support
Need help? Reach us at support@websouf.com or open an issue on GitHub.