Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tak-bro/aicommit2
A Reactive CLI that generates git commit messages with various AI
https://github.com/tak-bro/aicommit2
ai aicommit anthropic anthropic-claude chatgpt claude cli clovax command-line commit gemini gemini-pro huggingface mistral mistral-ai ollama openai
Last synced: about 17 hours ago
JSON representation
A Reactive CLI that generates git commit messages with various AI
- Host: GitHub
- URL: https://github.com/tak-bro/aicommit2
- Owner: tak-bro
- License: mit
- Created: 2024-01-30T14:13:47.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2024-04-13T08:38:40.000Z (5 months ago)
- Last Synced: 2024-04-14T04:33:48.917Z (5 months ago)
- Topics: ai, aicommit, anthropic, anthropic-claude, chatgpt, claude, cli, clovax, command-line, commit, gemini, gemini-pro, huggingface, mistral, mistral-ai, ollama, openai
- Language: TypeScript
- Homepage:
- Size: 8.77 MB
- Stars: 11
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
AICommit2
A Reactive CLI that generates git commit messages with Ollama, ChatGPT, Gemini, Claude, Mistral and other AI
[](https://github.com/tak-bro)
[](https://github.com/tak-bro/aicommit2/blob/main/LICENSE)
[](https://www.npmjs.com/package/aicommit2)
[](https://www.npmjs.com/package/aicommit2)
---
## Introduction
_aicommit2_ is a reactive CLI tool that automatically generates Git commit messages using various AI models. It supports simultaneous requests to multiple AI providers, allowing users to select the most suitable commit message. The core functionalities and architecture of this project are inspired by [AICommits](https://github.com/Nutlope/aicommits).
## Key Features
- **Multi-AI Support**: Integrates with OpenAI, Anthropic Claude, Google Gemini, Mistral AI, Cohere, Groq and more.
- **Local Model Support**: Use local AI models via Ollama.
- **Reactive CLI**: Enables simultaneous requests to multiple AIs and selection of the best commit message.
- **Git Hook Integration**: Can be used as a prepare-commit-msg hook.
- **Custom Prompt**: Supports user-defined system prompt templates.
## Supported Providers
### Remote
- [OpenAI](https://openai.com/)
- [Anthropic Claude](https://console.anthropic.com/)
- [Gemini](https://gemini.google.com/)
- [Mistral AI](https://mistral.ai/) (including [Codestral](https://mistral.ai/news/codestral/))
- [Cohere](https://cohere.com/)
- [Groq](https://groq.com/)
- [Perplexity](https://docs.perplexity.ai/)
- [DeepSeek](https://www.deepseek.com/)
- [Huggingface **(Unofficial)**](https://huggingface.co/chat/)
### Local
- [Ollama](https://ollama.com/)
## Setup
> The minimum supported version of Node.js is the v18. Check your Node.js version with `node --version`.
1. Install _aicommit2_:
```sh
npm install -g aicommit2
```
2. Set up API keys (**at least ONE key must be set**):
```sh
aicommit2 config set OPENAI.key=
aicommit2 config set ANTHROPIC.key=
# ... (similar commands for other providers)
```
3. Run _aicommit2_ with your staged files in git repository:
```shell
git add
aicommit2
```
> 👉 **Tip:** Use the `aic2` alias if `aicommit2` is too long for you.
## Using Locally
You can also use your model for free with [Ollama](https://ollama.com/) and it is available to use both Ollama and remote providers **simultaneously**.
1. Install Ollama from [https://ollama.com](https://ollama.com/)
2. Start it with your model
```shell
ollama run llama3.1 # model you want use. ex) codellama, deepseek-coder
```
3. Set the model and host
```sh
aicommit2 config set OLLAMA.model=
```
> If you want to use Ollama, you must set **OLLAMA.model**.
4. Run _aicommit2_ with your staged in git repository
```shell
git add
aicommit2
```
> 👉 **Tip:** Ollama can run LLMs **in parallel** from v0.1.33. Please see [this section](#loading-multiple-ollama-models).
## How it works
This CLI tool runs `git diff` to grab all your latest code changes, sends them to configured AI, then returns the AI generated commit message.
> If the diff becomes too large, AI will not function properly. If you encounter an error saying the message is too long or it's not a valid commit message, **try reducing the commit unit**.
## Usage
### CLI mode
You can call `aicommit2` directly to generate a commit message for your staged changes:
```sh
git add
aicommit2
```
`aicommit2` passes down unknown flags to `git commit`, so you can pass in [`commit` flags](https://git-scm.com/docs/git-commit).
For example, you can stage all changes in tracked files with as you commit:
```sh
aicommit2 --all # or -a
```
#### CLI Options
- `--locale` or `-l`: Locale to use for the generated commit messages (default: **en**)
- `--all` or `-a`: Automatically stage changes in tracked files for the commit (default: **false**)
- `--type` or `-t`: Git commit message format (default: **conventional**). It supports [`conventional`](https://conventionalcommits.org/) and [`gitmoji`](https://gitmoji.dev/)
- `--confirm` or `-y`: Skip confirmation when committing after message generation (default: **false**)
- `--clipboard` or `-c`: Copy the selected message to the clipboard (default: **false**).
- If you give this option, **_aicommit2_ will not commit**.
- `--generate` or `-g`: Number of messages to generate (default: **1**)
- **Warning**: This uses more tokens, meaning it costs more.
- `--exclude` or `-x`: Files to exclude from AI analysis
Example:
```sh
aicommit2 --locale "jp" --all --type "conventional" --generate 3 --clipboard --exclude "*.json" --exclude "*.ts"
```
### Git hook
You can also integrate _aicommit2_ with Git via the [`prepare-commit-msg`](https://git-scm.com/docs/githooks#_prepare_commit_msg) hook. This lets you use Git like you normally would, and edit the commit message before committing.
#### Install
In the Git repository you want to install the hook in:
```sh
aicommit2 hook install
```
#### Uninstall
In the Git repository you want to uninstall the hook from:
```sh
aicommit2 hook uninstall
```
### Configuration
#### Reading and Setting Configuration
- READ: `aicommit2 config get `
- SET: `aicommit2 config set =`
Example:
```sh
aicommit2 config get OPENAI
aicommit2 config get GEMINI.key
aicommit2 config set OPENAI.generate=3 GEMINI.temperature=0.5
```
#### How to Configure in detail
1. Command-line arguments: **use the format** `--[Model].[Key]=value`
```sh
aicommit2 --OPENAI.locale="jp" --GEMINI.temperatue="0.5"
```
2. Configuration file: **use INI format in the `~/.aicommit2` file or use `set` command**.
Example `~/.aicommit2`:
```ini
# General Settings
logging=true
generate=2
temperature=1.0
# Model-Specific Settings
[OPENAI]
key=""
temperature=0.8
generate=1
systemPromptPath=""
[GEMINI]
key=""
generate=5
includeBody=true
[OLLAMA]
temperature=0.7
model[]=llama3.1
model[]=codestral
```
> The priority of settings is: **Command-line Arguments > Model-Specific Settings > General Settings > Default Values**.
## General Settings
The following settings can be applied to most models, but support may vary.
Please check the documentation for each specific model to confirm which settings are supported.
| Setting | Description | Default |
|------------------------|---------------------------------------------------------------------|--------------|
| `systemPrompt` | System Prompt text | - |
| `systemPromptPath` | Path to system prompt file | - |
| `exclude` | Files to exclude from AI analysis | - |
| `type` | Type of commit message to generate | conventional |
| `locale` | Locale for the generated commit messages | en |
| `generate` | Number of commit messages to generate | 1 |
| `logging` | Enable logging | true |
| `includeBody` | Whether the commit message includes body | false |
| `maxLength` | Maximum character length of the Subject of generated commit message | 50 |
| `timeout` | Request timeout (milliseconds) | 10000 |
| `temperature` | Model's creativity (0.0 - 2.0) | 0.7 |
| `maxTokens` | Maximum number of tokens to generate | 1024 |
| `topP` | Nucleus sampling | 0.9 |
| `codeReview` | Whether to include an automated code review in the process | false |
| `codeReviewPromptPath` | Path to code review prompt file | - |
| `disabled` | Whether a specific model is enabled or disabled | false |
> 👉 **Tip:** To set the General Settings for each model, use the following command.
> ```shell
> aicommit2 config set OPENAI.locale="jp"
> aicommit2 config set CODESTRAL.type="gitmoji"
> aicommit2 config set GEMINI.includeBody=true
> ```
##### systemPrompt
- Allow users to specify a custom system prompt
```sh
aicommit2 config set systemPrompt="Generate git commit message."
```
> `systemPrompt` takes precedence over `systemPromptPath` and does not apply at the same time.
##### systemPromptPath
- Allow users to specify a custom file path for their own system prompt template
- Please see [Custom Prompt Template](#custom-prompt-template)
```sh
aicommit2 config set systemPromptPath="/path/to/user/prompt.txt"
```
##### exclude
- Files to exclude from AI analysis
- It is applied with the `--exclude` option of the CLI option. All files excluded through `--exclude` in CLI and `exclude` general setting.
```sh
aicommit2 config set exclude="*.ts"
aicommit2 config set exclude="*.ts,*.json"
```
> NOTE: `exclude` option does not support per model. It is **only** supported by General Settings.
##### type
Default: `conventional`
Supported: `conventional`, `gitmoji`
The type of commit message to generate. Set this to "conventional" to generate commit messages that follow the Conventional Commits specification:
```sh
aicommit2 config set type="conventional"
```
##### locale
Default: `en`
The locale to use for the generated commit messages. Consult the list of codes in: https://wikipedia.org/wiki/List_of_ISO_639_language_codes.
```sh
aicommit2 config set locale="jp"
```
##### generate
Default: `1`
The number of commit messages to generate to pick from.
Note, this will use more tokens as it generates more results.
```sh
aicommit2 config set generate=2
```
##### logging
Default: `true`
Option that allows users to decide whether to generate a log file capturing the responses.
The log files will be stored in the `~/.aicommit2_log` directory(user's home).
- You can remove all logs below comamnd.
```sh
aicommit2 log removeAll
```
##### includeBody
Default: `false`
This option determines whether the commit message includes body. If you want to include body in message, you can set it to `true`.
```sh
aicommit2 config set includeBody="true"
```
```sh
aicommit2 config set includeBody="false"
```
##### maxLength
The maximum character length of the Subject of generated commit message
Default: `50`
```sh
aicommit2 config set maxLength=100
```
##### timeout
The timeout for network requests in milliseconds.
Default: `10_000` (10 seconds)
```sh
aicommit2 config set timeout=20000 # 20s
```
##### temperature
The temperature (0.0-2.0) is used to control the randomness of the output
Default: `0.7`
```sh
aicommit2 config set temperature=0.3
```
##### maxTokens
The maximum number of tokens that the AI models can generate.
Default: `1024`
```sh
aicommit2 config set maxTokens=3000
```
##### topP
Default: `0.9`
Nucleus sampling, where the model considers the results of the tokens with top_p probability mass.
```sh
aicommit2 config set topP=0.2
```
##### disabled
Default: `false`
This option determines whether a specific model is enabled or disabled. If you want to disable a particular model, you can set this option to `true`.
To disable a model, use the following commands:
```sh
aicommit2 config set GEMINI.disabled="true"
aicommit2 config set GROQ.disabled="true"
```
##### codeReview
Default: `false`
The `codeReview` parameter determines whether to include an automated code review in the process.
```sh
aicommit2 config set codeReview=true
```
> NOTE: When enabled, aicommit2 will perform a code review before generating commit messages.
⚠️ **CAUTION**
- The `codeReview` feature is currently experimental.
- This feature performs a code review before generating commit messages.
- Using this feature will significantly increase the overall processing time.
- It may significantly impact performance and cost.
- **The code review process consumes a large number of tokens.**
##### codeReviewPromptPath
- Allow users to specify a custom file path for code review
```sh
aicommit2 config set codeReviewPromptPath="/path/to/user/prompt.txt"
```
## Available General Settings by Model
| | timeout | temperature | maxTokens | topP |
|:--------------------:|:-------:|:-----------:|:---------:|:------:|
| **OpenAI** | ✓ | ✓ | ✓ | ✓ |
| **Anthropic Claude** | | ✓ | ✓ | ✓ |
| **Gemini** | | ✓ | ✓ | ✓ |
| **Mistral AI** | ✓ | ✓ | ✓ | ✓ |
| **Codestral** | ✓ | ✓ | ✓ | ✓ |
| **Cohere** | | ✓ | ✓ | ✓ |
| **Groq** | ✓ | ✓ | ✓ | ✓ |
| **Perplexity** | ✓ | ✓ | ✓ | ✓ |
| **DeepSeek** | ✓ | ✓ | ✓ | ✓ |
| **Huggingface** | | | | |
| **Ollama** | ✓ | ✓ | | ✓ |
> All AI support the following options in General Settings.
> - systemPrompt, systemPromptPath, codeReview, codeReviewPromptPath, exclude, type, locale, generate, logging, includeBody, maxLength
## Model-Specific Settings
> Some models mentioned below are subject to change.
### OpenAI
| Setting | Description | Default |
|---------|--------------------|------------------------|
| `key` | API key | - |
| `model` | Model to use | `gpt-4o-mini` |
| `url` | API endpoint URL | https://api.openai.com |
| `path` | API path | /v1/chat/completions |
| `proxy` | Proxy settings | - |
##### OPENAI.key
The OpenAI API key. You can retrieve it from [OpenAI API Keys page](https://platform.openai.com/account/api-keys).
```sh
aicommit2 config set OPENAI.key="your api key"
```
##### OPENAI.model
Default: `gpt-4o-mini`
The Chat Completions (`/v1/chat/completions`) model to use. Consult the list of models available in the [OpenAI Documentation](https://platform.openai.com/docs/models/model-endpoint-compatibility).
```sh
aicommit2 config set OPENAI.model=gpt-4o
```
##### OPENAI.url
Default: `https://api.openai.com`
The OpenAI URL. Both https and http protocols supported. It allows to run local OpenAI-compatible server.
```sh
aicommit2 config set OPENAI.url=""
```
##### OPENAI.path
Default: `/v1/chat/completions`
The OpenAI Path.
##### OPENAI.topP
Default: `0.9`
The `top_p` parameter selects tokens whose combined probability meets a threshold. Please see [detail](https://platform.openai.com/docs/api-reference/chat/create#chat-create-top_p).
```sh
aicommit2 config set OPENAI.topP=0.2
```
> NOTE: If `topP` is less than 0, it does not deliver the `top_p` parameter to the request.
### Anthropic
| Setting | Description | Default |
|-------------|----------------|---------------------------|
| `key` | API key | - |
| `model` | Model to use | `claude-3-haiku-20240307` |
##### ANTHROPIC.key
The Anthropic API key. To get started with Anthropic Claude, request access to their API at [anthropic.com/earlyaccess](https://www.anthropic.com/earlyaccess).
##### ANTHROPIC.model
Default: `claude-3-haiku-20240307`
Supported:
- `claude-3-haiku-20240307`
- `claude-3-sonnet-20240229`
- `claude-3-opus-20240229`
- `claude-3-5-sonnet-20240620`
```sh
aicommit2 config set ANTHROPIC.model="claude-3-5-sonnet-20240620"
```
##### Unsupported Options
Anthropic does not support the following options in General Settings.
- timeout
### Gemini
| Setting | Description | Default |
|--------------------|------------------------|-------------------|
| `key` | API key | - |
| `model` | Model to use | `gemini-1.5-pro` |
##### GEMINI.key
The Gemini API key. If you don't have one, create a key in [Google AI Studio](https://aistudio.google.com/app/apikey).
```sh
aicommit2 config set GEMINI.key="your api key"
```
##### GEMINI.model
Default: `gemini-1.5-pro`
Supported:
- `gemini-1.5-pro`
- `gemini-1.5-flash`
- `gemini-1.5-pro-exp-0801`
```sh
aicommit2 config set GEMINI.model="gemini-1.5-pro-exp-0801"
```
##### Unsupported Options
Gemini does not support the following options in General Settings.
- timeout
### Mistral
| Setting | Description | Default |
|----------|------------------|----------------|
| `key` | API key | - |
| `model` | Model to use | `mistral-tiny` |
##### MISTRAL.key
The Mistral API key. If you don't have one, please sign up and subscribe in [Mistral Console](https://console.mistral.ai/).
##### MISTRAL.model
Default: `mistral-tiny`
Supported:
- `open-mistral-7b`
- `mistral-tiny-2312`
- `mistral-tiny`
- `open-mixtral-8x7b`
- `mistral-small-2312`
- `mistral-small`
- `mistral-small-2402`
- `mistral-small-latest`
- `mistral-medium-latest`
- `mistral-medium-2312`
- `mistral-medium`
- `mistral-large-latest`
- `mistral-large-2402`
- `mistral-embed`
### Codestral
| Setting | Description | Default |
|---------|------------------|--------------------|
| `key` | API key | - |
| `model` | Model to use | `codestral-latest` |
##### CODESTRAL.key
The Codestral API key. If you don't have one, please sign up and subscribe in [Mistral Console](https://console.mistral.ai/codestral).
##### CODESTRAL.model
Default: `codestral-latest`
Supported:
- `codestral-latest`
- `codestral-2405`
```sh
aicommit2 config set CODESTRAL.model="codestral-2405"
```
### Cohere
| Setting | Description | Default |
|--------------------|--------------|-------------|
| `key` | API key | - |
| `model` | Model to use | `command` |
##### COHERE.key
The Cohere API key. If you don't have one, please sign up and get the API key in [Cohere Dashboard](https://dashboard.cohere.com/).
##### COHERE.model
Default: `command`
Supported models:
- `command`
- `command-nightly`
- `command-light`
- `command-light-nightly`
```sh
aicommit2 config set COHERE.model="command-nightly"
```
##### Unsupported Options
Cohere does not support the following options in General Settings.
- timeout
### Groq
| Setting | Description | Default |
|--------------------|------------------------|----------------|
| `key` | API key | - |
| `model` | Model to use | `gemma2-9b-it` |
##### GROQ.key
The Groq API key. If you don't have one, please sign up and get the API key in [Groq Console](https://console.groq.com).
##### GROQ.model
Default: `gemma2-9b-it`
Supported:
- `gemma2-9b-it`
- `gemma-7b-it`
- `llama-3.1-70b-versatile`
- `llama-3.1-8b-instant`
- `llama3-70b-8192`
- `llama3-8b-8192`
- `llama3-groq-70b-8192-tool-use-preview`
- `llama3-groq-8b-8192-tool-use-preview`
- `llama-guard-3-8b`
- `mixtral-8x7b-32768`
```sh
aicommit2 config set GROQ.model="llama3-8b-8192"
```
### Perplexity
| Setting | Description | Default |
|----------|------------------|-----------------------------------|
| `key` | API key | - |
| `model` | Model to use | `llama-3.1-sonar-small-128k-chat` |
##### PERPLEXITY.key
The Perplexity API key. If you don't have one, please sign up and get the API key in [Perplexity](https://docs.perplexity.ai/)
##### PERPLEXITY.model
Default: `llama-3.1-sonar-small-128k-chat`
Supported:
- `llama-3.1-sonar-small-128k-chat`
- `llama-3.1-sonar-large-128k-chat`
- `llama-3.1-sonar-large-128k-online`
- `llama-3.1-sonar-small-128k-online`
- `llama-3.1-8b-instruct`
- `llama-3.1-70b-instruct`
- `llama-3.1-8b`
- `llama-3.1-70b`
> The models mentioned above are subject to change.
```sh
aicommit2 config set PERPLEXITY.model="llama-3.1-70b"
```
### DeepSeek
| Setting | Description | Default |
|---------|------------------|--------------------|
| `key` | API key | - |
| `model` | Model to use | `deepseek-coder` |
##### DEEPSEEK.key
The DeepSeek API key. If you don't have one, please sign up and subscribe in [DeepSeek Platform](https://platform.deepseek.com/).
##### DEEPSEEK.model
Default: `deepseek-coder`
Supported:
- `deepseek-coder`
- `deepseek-chat`
```sh
aicommit2 config set DEEPSEEK.model="deepseek-chat"
```
### HuggingFace
| Setting | Description | Default |
|--------------------|----------------------------|----------------------------------------|
| `cookie` | Authentication cookie | - |
| `model` | Model to use | `CohereForAI/c4ai-command-r-plus` |
##### HUGGINGFACE.cookie
The [Huggingface Chat](https://huggingface.co/chat/) Cookie. Please check [how to get cookie](https://github.com/tak-bro/aicommit2?tab=readme-ov-file#how-to-get-cookieunofficial-api)
```sh
# Please be cautious of Escape characters(\", \') in browser cookie string
aicommit2 config set HUGGINGFACE.cookie="your-cooke"
```
##### HUGGINGFACE.model
Default: `CohereForAI/c4ai-command-r-plus`
Supported:
- `CohereForAI/c4ai-command-r-plus`
- `meta-llama/Meta-Llama-3-70B-Instruct`
- `HuggingFaceH4/zephyr-orpo-141b-A35b-v0.1`
- `mistralai/Mixtral-8x7B-Instruct-v0.1`
- `NousResearch/Nous-Hermes-2-Mixtral-8x7B-DPO`
- `01-ai/Yi-1.5-34B-Chat`
- `mistralai/Mistral-7B-Instruct-v0.2`
- `microsoft/Phi-3-mini-4k-instruct`
```sh
aicommit2 config set HUGGINGFACE.model="mistralai/Mistral-7B-Instruct-v0.2"
```
##### Unsupported Options
Huggingface does not support the following options in General Settings.
- maxTokens
- timeout
- temperature
- topP
### Ollama
| Setting | Description | Default |
|--------------------|----------------------------------------------|------------------------|
| `model` | Model(s) to use (comma-separated list) | - |
| `host` | Ollama host URL | http://localhost:11434 |
| `timeout` | Request timeout (milliseconds) | 100_000 (100sec) |
##### OLLAMA.model
The Ollama Model. Please see [a list of models available](https://ollama.com/library)
```sh
aicommit2 config set OLLAMA.model="llama3.1"
aicommit2 config set OLLAMA.model="llama3,codellama" # for multiple models
aicommit2 config add OLLAMA.model="gemma2" # Only Ollama.model can be added.
```
> OLLAMA.model is **string array** type to support multiple Ollama. Please see [this section](#loading-multiple-ollama-models).
##### OLLAMA.host
Default: `http://localhost:11434`
The Ollama host
```sh
aicommit2 config set OLLAMA.host=
```
##### OLLAMA.timeout
Default: `100_000` (100 seconds)
Request timeout for the Ollama.
```sh
aicommit2 config set OLLAMA.timeout=
```
##### Unsupported Options
Ollama does not support the following options in General Settings.
- maxTokens
## Upgrading
Check the installed version with:
```
aicommit2 --version
```
If it's not the [latest version](https://github.com/tak-bro/aicommit2/releases/latest), run:
```sh
npm update -g aicommit2
```
## Custom Prompt Template
_aicommit2_ supports custom prompt templates through the `systemPromptPath` option. This feature allows you to define your own prompt structure, giving you more control over the commit message generation process.
### Using the systemPromptPath Option
To use a custom prompt template, specify the path to your template file when running the tool:
```
aicommit2 config set systemPromptPath="/path/to/user/prompt.txt"
aicommit2 config set OPENAI.systemPromptPath="/path/to/another-prompt.txt"
```
For the above command, OpenAI uses the prompt in the `another-prompt.txt` file, and the rest of the model uses `prompt.txt`.
> **NOTE**: For the `systemPromptPath` option, set the **template path**, not the template content
### Template Format
Your custom template can include placeholders for various commit options.
Use curly braces `{}` to denote these placeholders for options. The following placeholders are supported:
- [{locale}](#locale): The language for the commit message (**string**)
- [{maxLength}](#max-length): The maximum length for the commit message (**number**)
- [{type}](#type): The type of the commit message (**conventional** or **gitmoji**)
- [{generate}](#generate): The number of commit messages to generate (**number**)
#### Example Template
Here's an example of how your custom template might look:
```
Generate a {type} commit message in {locale}.
The message should not exceed {maxLength} characters.
Please provide {generate} messages.
Remember to follow these guidelines:
1. Use the imperative mood
2. Be concise and clear
3. Explain the 'why' behind the change
```
#### **Appended Text**
Please note that the following text will **ALWAYS** be appended to the end of your custom prompt:
```
Lastly, Provide your response as a JSON array containing exactly {generate} object, each with the following keys:
- "subject": The main commit message using the {type} style. It should be a concise summary of the changes.
- "body": An optional detailed explanation of the changes. If not needed, use an empty string.
- "footer": An optional footer for metadata like BREAKING CHANGES. If not needed, use an empty string.
The array must always contain {generate} element, no more and no less.
Example response format:
[
{
"subject": "fix: fix bug in user authentication process",
"body": "- Update login function to handle edge cases\n- Add additional error logging for debugging",
"footer": ""
}
]
Ensure you generate exactly {generate} commit message, even if it requires creating slightly varied versions for similar changes.
The response should be valid JSON that can be parsed without errors.
```
This ensures that the output is consistently formatted as a JSON array, regardless of the custom template used.
## Loading Multiple Ollama Models
You can load and make simultaneous requests to multiple models using Ollama's experimental feature, the `OLLAMA_MAX_LOADED_MODELS` option.
- `OLLAMA_MAX_LOADED_MODELS`: Load multiple models simultaneously
#### Setup Guide
Follow these steps to set up and utilize multiple models simultaneously:
##### 1. Running Ollama Server
First, launch the Ollama server with the `OLLAMA_MAX_LOADED_MODELS` environment variable set. This variable specifies the maximum number of models to be loaded simultaneously.
For example, to load up to 3 models, use the following command:
```shell
OLLAMA_MAX_LOADED_MODELS=3 ollama serve
```
> Refer to [configuration](https://github.com/ollama/ollama/blob/main/docs/faq.md#how-do-i-configure-ollama-server) for detailed instructions.
##### 2. Configuring _aicommit2_
Next, set up _aicommit2_ to specify multiple models. You can assign a list of models, separated by **commas(`,`)**, to the OLLAMA.model environment variable. Here's how you do it:
```shell
aicommit2 config set OLLAMA.model="mistral,dolphin-llama3"
```
With this command, _aicommit2_ is instructed to utilize both the "mistral" and "dolphin-llama3" models when making requests to the Ollama server.
##### 3. Run _aicommit2_
```shell
aicommit2
```
> Note that this feature is available starting from Ollama version [**0.1.33**](https://github.com/ollama/ollama/releases/tag/v0.1.33) and _aicommit2_ version [**1.9.5**](https://www.npmjs.com/package/aicommit2/v/1.9.5).
## How to get Cookie(**Unofficial API**)
* Login to the site you want
* You can get cookie from the browser's developer tools network tab
* See for any requests check out the Cookie, **Copy whole value**
* Check below image for the format of cookie
> When setting cookies with long string values, ensure to **escape characters** like ", ', and others properly.
> - For double quotes ("), use \\"
> - For single quotes ('), use \\'
## Disclaimer and Risks
This project uses functionalities from external APIs but is not officially affiliated with or endorsed by their providers. Users are responsible for complying with API terms, rate limits, and policies.
## Contributing
For bug fixes or feature implementations, please check the [Contribution Guide](CONTRIBUTING.md).
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@eltociear
📖
@ubranch
💻
@bhodrolok
💻
@ryicoh
💻
@noamsto
💻
---
If this project has been helpful, please consider giving it a Star ⭐️!
Maintainer: [@tak-bro](https://env-tak.github.io/)