aicommit2 2.2.14 → 2.2.16

package/README.md

@@ -14,10 +14,11 @@
 [![license](https://img.shields.io/badge/license-MIT-211A4C.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHN0cm9rZT0iI0ZGRiIgdmlld0JveD0iMCAwIDI0IDI0Ij48cGF0aCBzdHJva2UtbGluZWNhcD0icm91bmQiIHN0cm9rZS1saW5lam9pbj0icm91bmQiIHN0cm9rZS13aWR0aD0iMiIgZD0ibTMgNiAzIDFtMCAwLTMgOWE1IDUgMCAwIDAgNi4wMDEgME02IDdsMyA5TTYgN2w2LTJtNiAyIDMtMW0tMyAxLTMgOWE1IDUgMCAwIDAgNi4wMDEgME0xOCA3bDMgOW0tMy05LTYtMm0wLTJ2Mm0wIDE2VjVtMCAxNkg5bTMgMGgzIi8+PC9zdmc+)](https://github.com/tak-bro/aicommit2/blob/main/LICENSE)
 [![version](https://img.shields.io/npm/v/aicommit2?logo=semanticrelease&label=release&color=A51C2D)](https://www.npmjs.com/package/aicommit2)
 [![downloads](https://img.shields.io/npm/dt/aicommit2?color=F33535&logo=npm)](https://www.npmjs.com/package/aicommit2)
+[![Nix](https://img.shields.io/badge/Nix-5277C3?logo=nixos&logoColor=fff)](#nix-installation)
 
 </div>
 
----
+______________________________________________________________________
 
 ## 🚀 Quick Start
 
@@ -37,24 +38,29 @@ _aicommit2_ is a reactive CLI tool that automatically generates Git commit messa
 
 ## ✨ Key Features
 
-- **Multi-AI Support**: Integrates with OpenAI, Anthropic Claude, Google Gemini, Mistral AI, Cohere, Groq, Ollama and more.
-- **OpenAI API Compatibility**: Support for any service that implements the OpenAI API specification.
-- **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.
+- **[Multi-AI Support](#cloud-ai-services)**: Integrates with OpenAI, Anthropic Claude, Google Gemini, Mistral AI, Cohere, Groq, Ollama and more.
+- **[OpenAI API Compatibility](docs/providers/compatible.md)**: Support for any service that implements the OpenAI API specification.
+- **[Reactive CLI](#usage)**: Enables simultaneous requests to multiple AIs and selection of the best commit message.
+- **[Git Hook Integration](#git-hook)**: Can be used as a prepare-commit-msg hook.
+- **[Custom Prompt](#custom-prompt-template)**: Supports user-defined system prompt templates.
 
 ## 🤖 Supported Providers
 
-- [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/)
-- [Ollama](https://ollama.com/)
-- [OpenAI API Compatibility](#openai-api-compatible-services)
+### Cloud AI Services
+
+- [OpenAI](docs/providers/openai.md)
+- [Anthropic Claude](docs/providers/anthropic.md)
+- [Gemini](docs/providers/gemini.md)
+- [Mistral & Codestral](docs/providers/mistral.md)
+- [Cohere](docs/providers/cohere.md)
+- [Groq](docs/providers/groq.md)
+- [Perplexity](docs/providers/perplexity.md)
+- [DeepSeek](docs/providers/deepseek.md)
+- [OpenAI API Compatibility](docs/providers/compatible.md)
+
+### Local AI Services
+
+- [Ollama](docs/providers/ollama.md)
 
 ## Setup
 
@@ -62,19 +68,10 @@ _aicommit2_ is a reactive CLI tool that automatically generates Git commit messa
 
 1. Install _aicommit2_:
 
-**Directly from npm**:
 ```sh
 npm install -g aicommit2
 ```
 
-**Alternatively, from source**:
-```sh
-git clone https://github.com/tak-bro/aicommit2.git
-cd aicommit2
-npm run build
-npm install -g .
-```
-
 2. Set up API keys (**at least ONE key must be set**):
 
 ```sh
@@ -84,6 +81,7 @@ aicommit2 config set ANTHROPIC.key=<your key>
 ```
 
 3. Run _aicommit2_ with your staged files in git repository:
+
 ```shell
 git add <files...>
 aicommit2
@@ -91,33 +89,75 @@ aicommit2
 
 > 👉 **Tip:** Use the `aic2` alias if `aicommit2` is too long for you.
 
-## Using Locally
+### Alternative Installation Methods
 
-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**.
+#### Nix Installation
 
-1. Install Ollama from [https://ollama.com](https://ollama.com/)
+If you use the Nix package manager, aicommit2 can be installed directly using the provided flake:
 
-2. Start it with your model
-```shell
-ollama run llama3.2 # model you want use. ex) codellama, deepseek-coder
+```sh
+# Install temporarily in your current shell
+nix run github:tak-bro/aicommit2
+
+# Install permanently to your profile
+nix profile install github:tak-bro/aicommit2
+
+# Use the shorter alias
+nix run github:tak-bro/aic2 -- --help
 ```
 
-3. Set the host, model and numCtx. (The default numCtx value in Ollama is 2048. It is recommended to set it to `4096` or higher.)
+##### Using in a Flake-based Project
+
+Add aicommit2 to your flake inputs:
+
+```nix
+{
+  # flake.nix configuration file
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    aicommit2.url = "github:tak-bro/aicommit2";
+  };
+  # Rest of your flake.nix file
+}
+
+  # Somewhere where you define your packages
+  {pkgs, inputs, ...}:{
+
+  environment.systemPackages = [inputs.aicommit2.packages.x86_64-linux.default];
+  # Or home packages
+  home.packages = [inputs.aicommit2.packages.x86_64-linux.default];
+  }
+```
+
+##### Development Environment
+
+To enter a development shell with all dependencies:
+
 ```sh
-aicommit2 config set OLLAMA.host=<your host>
-aicommit2 config set OLLAMA.model=<your model>
-aicommit2 config set OLLAMA.numCtx=4096
+nix develop github:tak-bro/aicommit2
 ```
 
-> If you want to use Ollama, you must set **OLLAMA.model**.
+After setting up with Nix, you'll still need to configure API keys as described in the [Setup](#setup) section.
 
-4. Run _aicommit2_ with your staged in git repository
-```shell
-git add <files...>
-aicommit2
+#### From Source
+
+```sh
+git clone https://github.com/tak-bro/aicommit2.git
+cd aicommit2
+npm run build
+npm install -g .
 ```
 
-> 👉 **Tip:** Ollama can run LLMs **in parallel** from v0.1.33. Please see [this section](#loading-multiple-ollama-models).
+#### Via VSCode Devcontainer
+
+Add [feature](https://github.com/kvokka/features/tree/main/src/aicommit2) to
+your `devcontainer.json` file:
+
+```json
+"features": {
+    "ghcr.io/kvokka/features/aicommit2:1": {}
+}
+```
 
 ## How it works
 
@@ -161,8 +201,9 @@ aicommit2 --all # or -a
 - `--pre-commit`: Run in [pre-commit](https://pre-commit.com/) framework mode (default: **false**)
   - This option is specifically for use with the pre-commit framework
   - See [Integration with pre-commit framework](#integration-with-pre-commit-framework) section for setup instructions
-   
+
 Example:
+
 ```sh
 aicommit2 --locale "jp" --all --type "conventional" --generate 3 --clipboard --exclude "*.json" --exclude "*.ts"
 ```
@@ -187,7 +228,7 @@ if you prefer to set up the hook manually, create or edit the `.git/hooks/prepar
 #!/bin/sh
 # your-other-hook "$@"
 aicommit2 --hook-mode "$@"
- ```
+```
 
 Make the hook executable:
 
@@ -195,6 +236,30 @@ Make the hook executable:
 chmod +x .git/hooks/prepare-commit-msg
 ```
 
+#### Integration with pre-commit Framework
+
+If you're using the [pre-commit](https://pre-commit.com/) framework, you can add _aicommit2_ to your `.pre-commit-config.yaml`:
+
+```yaml
+repos:
+    - repo: local
+      hooks:
+          - id: aicommit2
+            name: AI Commit Message Generator
+            entry: aicommit2 --pre-commit
+            language: node
+            stages: [prepare-commit-msg]
+            always_run: true
+```
+
+Make sure you have:
+
+1. Installed pre-commit: `brew install pre-commit`
+2. Installed aicommit2 globally: `npm install -g aicommit2`
+3. Run `pre-commit install --hook-type prepare-commit-msg` to set up the hook
+
+> **Note** : The `--pre-commit` flag is specifically designed for use with the pre-commit framework and ensures proper integration with other pre-commit hooks.
+
 #### Uninstall
 
 In the Git repository you want to uninstall the hook from:
@@ -209,14 +274,27 @@ Or manually delete the `.git/hooks/prepare-commit-msg` file.
 
 #### Reading and Setting Configuration
 
-- READ: `aicommit2 config get <key>`
+- READ: `aicommit2 config get [<key> [<key> ...]]`
 - SET: `aicommit2 config set <key>=<value>`
+- DELETE: `aicommit2 config del <config-name>`
 
 Example:
+
 ```sh
+# Get all configurations
+aicommit2 config get
+
+# Get specific configuration
 aicommit2 config get OPENAI
 aicommit2 config get GEMINI.key
+
+# Set configurations
 aicommit2 config set OPENAI.generate=3 GEMINI.temperature=0.5
+
+# Delete a configuration setting or section
+aicommit2 config del OPENAI.key
+aicommit2 config del GEMINI
+aicommit2 config del timeout
 ```
 
 #### Environment Variables
@@ -246,17 +324,19 @@ Usage Example:
 OPENAI_API_KEY="your-openai-key" ANTHROPIC_API_KEY="your-anthropic-key" aicommit2
 ```
 
-> **Note**: Environment variables take precedence over configuration file settings. 
+> **Note**: Environment variables take precedence over configuration file settings.
 
 #### 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
@@ -289,7 +369,7 @@ 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                                   | -            |
@@ -307,7 +387,8 @@ Please check the documentation for each specific model to confirm which settings
 | `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.
+> 👉 **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"
@@ -315,6 +396,7 @@ Please check the documentation for each specific model to confirm which settings
 > ```
 
 ##### systemPrompt
+
 - Allow users to specify a custom system prompt
 
 ```sh
@@ -324,6 +406,7 @@ 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)
 
@@ -386,7 +469,7 @@ The log files will be stored in the `~/.aicommit2_log` directory(user's home).
 
 ![log-path](https://github.com/tak-bro/aicommit2/blob/main/img/log_path.png?raw=true)
 
-- You can remove all logs below comamnd.
+- You can remove all logs below command.
 
 ```sh
 aicommit2 log removeAll
@@ -404,7 +487,6 @@ aicommit2 config set includeBody="true"
 
 ![ignore_body_false](https://github.com/tak-bro/aicommit2/blob/main/img/demo_body_min.gif?raw=true)
 
-
 ```sh
 aicommit2 config set includeBody="false"
 ```
@@ -499,6 +581,7 @@ aicommit2 config set codeReview=true
 - **The code review process consumes a large number of tokens.**
 
 ##### codeReviewPromptPath
+
 - Allow users to specify a custom file path for code review
 
 ```sh
@@ -506,486 +589,58 @@ 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**         |    ✓    |      ✓      |     ✓     |   ✓    |
-|         **Ollama**          |    ✓    |      ✓      |           |   ✓    |
-| **OpenAI API-Compatible**   |    ✓    |      ✓      |     ✓     |   ✓    |
+
+|                           | timeout | temperature | maxTokens | topP |
+| :-----------------------: | :-----: | :---------: | :-------: | :--: |
+|        **OpenAI**         |    ✓    |      ✓      |     ✓     |  ✓   |
+|   **Anthropic Claude**    |    ✓    |      ✓      |     ✓     |  ✓   |
+|        **Gemini**         |         |      ✓      |     ✓     |  ✓   |
+|      **Mistral AI**       |    ✓    |      ✓      |     ✓     |  ✓   |
+|       **Codestral**       |    ✓    |      ✓      |     ✓     |  ✓   |
+|        **Cohere**         |    ✓    |      ✓      |     ✓     |  ✓   |
+|         **Groq**          |    ✓    |      ✓      |     ✓     |  ✓   |
+|      **Perplexity**       |    ✓    |      ✓      |     ✓     |  ✓   |
+|       **DeepSeek**        |    ✓    |      ✓      |     ✓     |  ✓   |
+|        **Ollama**         |    ✓    |      ✓      |           |  ✓   |
+| **OpenAI API-Compatible** |    ✓    |      ✓      |     ✓     |  ✓   |
 
 > 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="<your-host>"
-```
-
-##### 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-5-haiku-20241022` |
-
-##### 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-5-haiku-20241022`
-
-Supported:
-- `claude-3-7-sonnet-20250219`
-- `claude-3-5-sonnet-20241022`
-- `claude-3-5-haiku-20241022`
-- `claude-3-opus-20240229`
-- `claude-3-sonnet-20240229`
-- `claude-3-haiku-20240307`
-
-```sh
-aicommit2 config set ANTHROPIC.model="claude-3-5-sonnet-20240620"
-```
-
-### Gemini
-
-| Setting            | Description            | Default                |
-|--------------------|------------------------|------------------------|
-| `key`              | API key                | -                      |
-| `model`            | Model to use           | `gemini-2.0-flash`     |
-
-##### 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-2.0-flash`
-
-Supported:
-- `gemini-2.0-flash`
-- `gemini-2.0-flash-lite`
-- `gemini-2.0-pro-exp-02-05`
-- `gemini-2.0-flash-thinking-exp-01-21`
-- `gemini-2.0-flash-exp`
-- `gemini-1.5-flash`
-- `gemini-1.5-flash-8b`
-- `gemini-1.5-pro`
-
-```sh
-aicommit2 config set GEMINI.model="gemini-2.0-flash"
-```
-
-##### Unsupported Options
-
-Gemini does not support the following options in General Settings.
-
-- timeout
-
-### Mistral
-
-| Setting  | Description      | Default            |
-|----------|------------------|--------------------|
-| `key`    | API key          | -                  |
-| `model`  | Model to use     | `pixtral-12b-2409` |
-
-##### 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: `pixtral-12b-2409`
-
-Supported:
-- `codestral-latest`
-- `mistral-large-latest`
-- `pixtral-large-latest`
-- `ministral-8b-latest`
-- `mistral-small-latest`
-- `mistral-embed`
-- `mistral-moderation-latest`
-
-### 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-2501`
-
-```sh
-aicommit2 config set CODESTRAL.model="codestral-2501"
-```
-
-### 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-r7b-12-2024`
-- `command-r-plus-08-2024`
-- `command-r-plus-04-2024`
-- `command-r-plus`
-- `command-r-08-2024`
-- `command-r-03-2024`
-- `command-r`
-- `command`
-- `command-nightly`
-- `command-light`
-- `command-light-nightly`
-- `c4ai-aya-expanse-8b`
-- `c4ai-aya-expanse-32b`
-
-```sh
-aicommit2 config set COHERE.model="command-nightly"
-```
-
-### Groq
-
-| Setting            | Description            | Default                         |
-|--------------------|------------------------|---------------------------------|
-| `key`              | API key                | -                               |
-| `model`            | Model to use           | `deepseek-r1-distill-llama-70b` |
-
-##### 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: `deepseek-r1-distill-llama-70b`
-
-Supported:
-- `qwen-2.5-32b`
-- `qwen-2.5-coder-32b`
-- `deepseek-r1-distill-qwen-32b`
-- `deepseek-r1-distill-llama-70b`
-- `distil-whisper-large-v3-en`
-- `gemma2-9b-it`
-- `llama-3.3-70b-versatile`
-- `llama-3.1-8b-instant`
-- `llama-guard-3-8b`
-- `llama3-70b-8192`
-- `llama3-8b-8192`
-- `mixtral-8x7b-32768`
-- `whisper-large-v3`
-- `whisper-large-v3-turbo`
-- `llama-3.3-70b-specdec`
-- `llama-3.2-1b-preview`
-- `llama-3.2-3b-preview`
-- `llama-3.2-11b-vision-preview`
-- `llama-3.2-90b-vision-preview`
-
-
-```sh
-aicommit2 config set GROQ.model="deepseek-r1-distill-llama-70b"
-```
-
-### Perplexity
-
-| Setting  | Description      | Default  |
-|----------|------------------|----------|
-| `key`    | API key          | -        |
-| `model`  | Model to use     | `sonar`  |
-
-##### 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: `sonar`
-
-Supported:
-- `sonar-pro`
-- `sonar`
-- `llama-3.1-sonar-small-128k-online`
-- `llama-3.1-sonar-large-128k-online`
-- `llama-3.1-sonar-huge-128k-online`
-
-> The models mentioned above are subject to change.
-
-```sh
-aicommit2 config set PERPLEXITY.model="sonar-pro"
-```
-
-### DeepSeek
-
-| Setting | Description      | Default            |
-|---------|------------------|--------------------|
-| `key`   | API key          | -                  |
-| `model` | Model to use     | `deepseek-chat`    |
-
-##### 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-chat`
-
-Supported:
-- `deepseek-chat`
-- `deepseek-reasoner`
-
-```sh
-aicommit2 config set DEEPSEEK.model="deepseek-reasoner"
-```
-
-### Ollama
-
-| Setting    | Description                                                 | Default                |
-|------------|-------------------------------------------------------------|------------------------|
-| `model`    | Model(s) to use (comma-separated list)                      | -                      |
-| `host`     | Ollama host URL                                             | http://localhost:11434 |
-| `auth`     | Authentication type                                         | Bearer                 |
-| `key`      | Authentication key                                          | -                      |
-| `numCtx`   | The maximum number of tokens the model can process at once  | 2048                   |
-
-##### 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=<host>
-```
-
-##### OLLAMA.auth
-
-Not required. Use when your Ollama server requires authentication. Please see [this issue](https://github.com/tak-bro/aicommit2/issues/90).
-
-```sh
-aicommit2 config set OLLAMA.auth=<auth>
-```
-
-##### OLLAMA.key
-
-Not required. Use when your Ollama server requires authentication. Please see [this issue](https://github.com/tak-bro/aicommit2/issues/90).
-
-```sh
-aicommit2 config set OLLAMA.key=<key>
-```
-
-Few examples of authentication methods:
-
-| **Authentication Method** | **OLLAMA.auth**              | **OLLAMA.key**                        |
-|---------------------------|------------------------------|---------------------------------------|
-| Bearer                    | `Bearer`                     | `<API key>`                           |
-| Basic                     | `Basic`                      | `<Base64 Encoded username:password>`  |
-| JWT                       | `Bearer`                     | `<JWT Token>`                         |
-| OAuth 2.0                 | `Bearer`                     | `<Access Token>`                      |
-| HMAC-SHA256               | `HMAC`                       | `<Base64 Encoded clientId:signature>` |
-
-##### OLLAMA.numCtx
-
-The maximum number of tokens the model can process at once, determining its context length and memory usage.
-It is recommended to set it to 4096 or higher.
-
-```sh
-aicommit2 config set OLLAMA.numCtx=4096
-```
-
-##### Unsupported Options
-
-Ollama does not support the following options in General Settings.
-
-- maxTokens
-
-### OpenAI API-Compatible Services
-
-You can configure any OpenAI API-compatible service by adding a configuration section with the `compatible=true` option. This allows you to use services that implement the OpenAI API specification.
-
-```sh
-# together
-aicommit2 config set TOGETHER.compatible=true
-aicommit2 config set TOGETHER.url=https://api.together.xyz
-aicommit2 config set TOGETHER.path=/v1
-aicommit2 config set TOGETHER.model=meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo
-aicommit2 config set TOGETHER.key="your-api-key"
-```
-
-| Setting      | Description                            | Required             | Default |
-|--------------|----------------------------------------|----------------------|---------|
-| `compatible` | Enable OpenAI API compatibility mode   | ✓ (**must be true**) | false   |
-| `url`        | Base URL of the API endpoint           | ✓                    | -       |
-| `path`       | API path for chat completions          |                      | -       |
-| `key`        | API key for authentication             | ✓                    | -       |
-| `model`      | Model identifier to use                | ✓                    | -       |
-
-Example configuration:
-```ini
-[TOGETHER]
-compatible=true
-key=<your-api-key>
-url=https://api.together.xyz/v1
-model=meta-llama/Meta-Llama-3.1-8B-Instruct-Turbo
-
-[GEMINI_COMPATIBILITY]
-compatible=true
-key=<your-api-key>
-url=https://generativelanguage.googleapis.com
-path=/v1beta/openai/
-model=gemini-1.5-flash
-
-[OLLAMA_COMPATIBILITY]
-compatible=true
-key=ollama
-url=http://localhost:11434/v1
-model=llama3.2
-```
-
-## Watch Commit Mode
-
-![watch-commit-gif](https://github.com/tak-bro/aicommit2/blob/main/img/watch-commit-min.gif?raw=true)
-
-Watch Commit mode allows you to monitor Git commits in real-time and automatically perform AI code reviews using the `--watch-commit` flag.
-
-```sh
-aicommit2 --watch-commit
-```
-
-This feature only works within Git repository directories and automatically triggers whenever a commit event occurs. When a new commit is detected, it automatically:
-1. Analyzes commit changes
-2. Performs AI code review
-3. Displays results in real-time
-
-> For detailed configuration of the code review feature, please refer to the [codeReview](#codereview) section. The settings in that section are shared with this feature.
-
-⚠️ **CAUTION**
-
-- The Watch Commit feature is currently **experimental**
-- This feature performs AI analysis for each commit, which **consumes a significant number of API tokens**
-- API costs can increase substantially if there are many commits
-- It is recommended to **carefully monitor your token usage** when using this feature
-- To use this feature, you must enable watch mode for at least one AI model:
-  ```sh
-  aicommit2 config set [MODEL].watchMode="true"
-  ```
-
-## 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
-```
+## Configuration Examples
+
+```
+aicommit2 config set \
+  generate=2 \
+  topP=0.8 \
+  maxTokens=1024 \
+  temperature=0.7 \
+  OPENAI.key="sk-..." OPENAI.model="gpt-4o" OPENAI.temperature=0.5 \
+  ANTHROPIC.key="sk-..." ANTHROPIC.model="claude-3-haiku" ANTHROPIC.maxTokens=2000 \
+  MISTRAL.key="your-key" MISTRAL.model="codestral-latest"  \
+  OLLAMA.model="llama3.2" OLLAMA.numCtx=4096 OLLAMA.watchMode=true
+```
+
+> 🔍 **Detailed Support Info**: Check each provider's documentation for specific limits and behaviors:
+>
+> - [OpenAI](docs/providers/openai.md)
+> - [Anthropic Claude](docs/providers/anthropic.md)
+> - [Gemini](docs/providers/gemini.md)
+> - [Mistral & Codestral](docs/providers/mistral.md)
+> - [Cohere](docs/providers/cohere.md)
+> - [Groq](docs/providers/groq.md)
+> - [Perplexity](docs/providers/perplexity.md)
+> - [DeepSeek](docs/providers/deepseek.md)
+> - [OpenAI API Compatibility](docs/providers/compatible.md)
+> - [Ollama](docs/providers/ollama.md)
 
 ## 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:
 
 ```
@@ -1046,69 +701,50 @@ 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.
 
-## Integration with pre-commit framework
-
-If you're using the [pre-commit](https://pre-commit.com/) framework, you can add _aicommit2_ to your `.pre-commit-config.yaml`:
-
-```yaml
-repos:
-  - repo: local
-    hooks:
-      - id: aicommit2
-        name: AI Commit Message Generator
-        entry: aicommit2 --pre-commit
-        language: node
-        stages: [prepare-commit-msg]
-        always_run: true
-```
-
-Make sure you have:
-
-1. Installed pre-commit: `brew install pre-commit`
-2. Installed aicommit2 globally: `npm install -g aicommit2`
-3. Run `pre-commit install --hook-type prepare-commit-msg` to set up the hook
+## Watch Commit Mode
 
-> **Note** : The `--pre-commit` flag is specifically designed for use with the pre-commit framework and ensures proper integration with other pre-commit hooks.
+![watch-commit-gif](https://github.com/tak-bro/aicommit2/blob/main/img/watch-commit-min.gif?raw=true)
 
-## Loading Multiple Ollama Models
+Watch Commit mode allows you to monitor Git commits in real-time and automatically perform AI code reviews using the `--watch-commit` flag.
 
-<img src="https://github.com/tak-bro/aicommit2/blob/main/img/ollama_parallel.gif?raw=true" alt="OLLAMA_PARALLEL" />
+```sh
+aicommit2 --watch-commit
+```
 
-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
+This feature only works within Git repository directories and automatically triggers whenever a commit event occurs. When a new commit is detected, it automatically:
 
-#### Setup Guide
+1. Analyzes commit changes
+2. Performs AI code review
+3. Displays results in real-time
 
-Follow these steps to set up and utilize multiple models simultaneously:
+> For detailed configuration of the code review feature, please refer to the [codeReview](#codereview) section. The settings in that section are shared with this feature.
 
-##### 1. Running Ollama Server
+⚠️ **CAUTION**
 
-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:
+- The Watch Commit feature is currently **experimental**
+- This feature performs AI analysis for each commit, which **consumes a significant number of API tokens**
+- API costs can increase substantially if there are many commits
+- It is recommended to **carefully monitor your token usage** when using this feature
+- To use this feature, you must enable watch mode for at least one AI model:
 
-```shell
-OLLAMA_MAX_LOADED_MODELS=3 ollama serve
+```sh
+aicommit2 config set [MODEL].watchMode="true"
 ```
-> 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_
+## Upgrading
 
-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:
+Check the installed version with:
 
-```shell
-aicommit2 config set OLLAMA.model="mistral,dolphin-llama3"
+```
+aicommit2 --version
 ```
 
-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_
+If it's not the [latest version](https://github.com/tak-bro/aicommit2/releases/latest), run:
 
-```shell
-aicommit2
+```sh
+npm update -g 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).
-
 ## 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.
@@ -1122,8 +758,11 @@ For bug fixes or feature implementations, please check the [Contribution Guide](
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
 
 <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+
 <!-- prettier-ignore-start -->
+
 <!-- markdownlint-disable -->
+
 <table>
   <tr>
     <td align="center"><a href="https://github.com/eltociear"><img src="https://avatars.githubusercontent.com/eltociear" width="100px;" alt=""/><br /><sub><b>@eltociear</b></sub></a><br /><a href="https://github.com/tak-bro/aicommit2/commits?author=eltociear" title="Documentation">📖</a></td>
@@ -1137,13 +776,14 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
   <tr>
     <td align="center"><a href="https://github.com/devxpain"><img src="https://avatars.githubusercontent.com/devxpain" width="100px;" alt=""/><br /><sub><b>@devxpain</b></sub></a><br /><a href="https://github.com/tak-bro/aicommit2/commits?author=devxpain" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/delenzhang"><img src="https://avatars.githubusercontent.com/delenzhang" width="100px;" alt=""/><br /><sub><b>@delenzhang</b></sub></a><br /><a href="https://github.com/tak-bro/aicommit2/commits?author=delenzhang" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/kvokka"><img src="https://avatars.githubusercontent.com/kvokka" width="100px;" alt=""/><br /><sub><b>@kvokka</b></sub></a><br /><a href="https://github.com/tak-bro/aicommit2/commits?author=kvokka" title="Documentation">📖</a></td>
   </tr>
 </table>
 <!-- markdownlint-restore -->
 <!-- prettier-ignore-end -->
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
----
+______________________________________________________________________
 
 If this project has been helpful, please consider giving it a Star ⭐️!