aicommit2 2.2.15 → 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
 
@@ -59,7 +60,7 @@ _aicommit2_ is a reactive CLI tool that automatically generates Git commit messa
 
 ### Local AI Services
 
-- [Ollama](docs/providers/ollama.md) 
+- [Ollama](docs/providers/ollama.md)
 
 ## Setup
 
@@ -80,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
@@ -89,6 +91,54 @@ aicommit2
 
 ### Alternative Installation Methods
 
+#### Nix Installation
+
+If you use the Nix package manager, aicommit2 can be installed directly using the provided flake:
+
+```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
+```
+
+##### 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
+nix develop github:tak-bro/aicommit2
+```
+
+After setting up with Nix, you'll still need to configure API keys as described in the [Setup](#setup) section.
+
 #### From Source
 
 ```sh
@@ -151,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"
 ```
@@ -177,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:
 
@@ -191,14 +242,14 @@ If you're using the [pre-commit](https://pre-commit.com/) framework, you can add
 
 ```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
+    - 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:
@@ -209,7 +260,6 @@ Make sure you have:
 
 > **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:
@@ -224,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
@@ -261,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
@@ -304,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                                   | -            |
@@ -322,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"
@@ -330,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
@@ -339,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)
 
@@ -401,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
@@ -419,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"
 ```
@@ -514,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
@@ -521,24 +589,25 @@ 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
 
-
 ## Configuration Examples
 
 ```
@@ -554,6 +623,7 @@ aicommit2 config set \
 ```
 
 > 🔍 **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)
@@ -563,13 +633,14 @@ aicommit2 config set \
 > - [Perplexity](docs/providers/perplexity.md)
 > - [DeepSeek](docs/providers/deepseek.md)
 > - [OpenAI API Compatibility](docs/providers/compatible.md)
-> - [Ollama](docs/providers/ollama.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:
 
 ```
@@ -630,7 +701,6 @@ 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.
 
-
 ## Watch Commit Mode
 
 ![watch-commit-gif](https://github.com/tak-bro/aicommit2/blob/main/img/watch-commit-min.gif?raw=true)
@@ -642,6 +712,7 @@ 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
@@ -655,9 +726,10 @@ This feature only works within Git repository directories and automatically trig
 - 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"
-  ```
+
+```sh
+aicommit2 config set [MODEL].watchMode="true"
+```
 
 ## Upgrading
 
@@ -686,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>
@@ -708,7 +783,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- prettier-ignore-end -->
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
----
+______________________________________________________________________
 
 If this project has been helpful, please consider giving it a Star ⭐️!