aicommit2 2.4.13 → 2.4.14

package/README.md

@@ -15,16 +15,21 @@
 [![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)
+[![Homebrew](https://img.shields.io/badge/Homebrew-FBB040?logo=homebrew&logoColor=000)](https://formulae.brew.sh/formula/aicommit2)
 
 </div>
 
 ______________________________________________________________________
 
-## 🚀 Quick Start
+## Quick start
 
 ```bash
-# Install globally
+# Install via Homebrew (macOS/Linux)
+brew install aicommit2
+
+# Or install via npm
 npm install -g aicommit2
+
 # Set up at least one AI provider
 aicommit2 config set OPENAI.key=<your-key>
 
@@ -36,11 +41,11 @@ aicommit2
 aicommit2
 ```
 
-## 📖 Introduction
+## Introduction
 
-AICommit2 automatically generates commit messages using AI. It primarily supports [Git](https://git-scm.com/) and also works with [Jujutsu](https://github.com/jj-vcs/jj)(jj) repositories. The core functionalities and architecture of this project are inspired by [AICommits](https://github.com/Nutlope/aicommits).
+AICommit2 automatically generates commit messages using AI. It primarily supports [Git](https://git-scm.com/) and also works with [Jujutsu](https://github.com/jj-vcs/jj)(jj) repositories. [AICommits](https://github.com/Nutlope/aicommits) inspired the core functionalities and architecture of this project.
 
-## ✨ Key Features
+## Key features
 
 - **[VCS Support](#version-control-systems)**: Works with both Git and Jujutsu repositories
 - **[Multi-AI Support](#cloud-ai-services)**: Integrates with OpenAI, Anthropic Claude, Google Gemini, Mistral AI, Cohere, Groq, Ollama and more
@@ -49,7 +54,7 @@ AICommit2 automatically generates commit messages using AI. It primarily support
 - **[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
+## Supported providers
 
 ### Cloud AI Services
 
@@ -70,14 +75,20 @@ AICommit2 automatically generates commit messages using AI. It primarily support
 
 ## Setup
 
-> ⚠️ The minimum supported version of Node.js is the v18. Check your Node.js version with `node --version`.
-
 1. Install _aicommit2_:
 
+**Via Homebrew (recommended for macOS/Linux):**
+```sh
+brew install aicommit2
+```
+
+**Via npm:**
 ```sh
 npm install -g aicommit2
 ```
 
+> ⚠️ For npm installation, the minimum supported version of Node.js is v18. Check your Node.js version with `node --version`.
+
 2. Set up API keys (**at least ONE key must be set**):
 
 ```sh
@@ -281,6 +292,10 @@ 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
+- `--verbose` or `-v`: Enable verbose logging for enhanced debugging output (default: **false**)
+  - When enabled, shows detailed log messages including readline errors and other diagnostic information
+  - Useful for troubleshooting issues or understanding the tool's internal operations
+  - Can also be set via config: `aicommit2 config set logLevel=verbose`
 
 Examples:
 
@@ -290,6 +305,9 @@ aicommit2 --locale "jp" --all --type "conventional" --generate 3 --clipboard --e
 
 # Generate and edit a commit message
 aicommit2 --edit --type conventional # or gitmoji
+
+# Enable verbose logging for debugging
+aicommit2 --verbose # or -v
 ```
 
 ### Git hook
@@ -1021,6 +1039,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://github.com/mdeweerd"><img src="https://avatars.githubusercontent.com/mdeweerd" width="100px;" alt=""/><br /><sub><b>@mdeweerd</b></sub></a><br /><a href="https://github.com/tak-bro/aicommit2/commits?author=mdeweerd" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/DivitMittal"><img src="https://avatars.githubusercontent.com/DivitMittal" width="100px;" alt=""/><br /><sub><b>@DivitMittal</b></sub></a><br /><a href="https://github.com/tak-bro/aicommit2/commits?author=DivitMittal" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/aaccioly"><img src="https://avatars.githubusercontent.com/aaccioly" width="100px;" alt=""/><br /><sub><b>@aaccioly</b></sub></a><br /><a href="https://github.com/tak-bro/aicommit2/commits?author=aaccioly" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/forivall"><img src="https://avatars.githubusercontent.com/forivall" width="100px;" alt=""/><br /><sub><b>@forivall</b></sub></a><br /><a href="https://github.com/tak-bro/aicommit2/commits?author=forivall" title="Documentation">📖</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/jaytaylor"><img src="https://avatars.githubusercontent.com/jaytaylor" width="100px;" alt=""/><br /><sub><b>@jaytaylor</b></sub></a><br /><a href="https://github.com/tak-bro/aicommit2/commits?author=jaytaylor" title="Code">💻</a></td>
   </tr>
 </table>
 <!-- markdownlint-restore -->