aicommits 2.0.0-develop.3 → 2.0.0-develop.30

package/README.md

@@ -1,6 +1,7 @@
 <div align="center">
   <div>
     <img src=".github/screenshot.png" alt="AI Commits"/>
+    <img src="./aic.png" width="50" alt="AI Commits"/>
     <h1 align="center">AI Commits</h1>
   </div>
   <p>A CLI that writes your git commit messages for you with AI. Never write a commit message again.</p>
@@ -17,11 +18,9 @@
 1. Install _aicommits_:
 
    ```sh
-   npm install -g aicommits@develop
+   npm install -g aicommits
    ```
 
-   > We need @develop since v2 is still not released as latest/main! Don't remove it to test v2!
-
 2. Run the setup command to choose your AI provider:
 
    ```sh
@@ -33,21 +32,25 @@ This will guide you through:
 - Selecting your AI provider (sets the `provider` config)
 - Configuring your API key
 - **Automatically fetching and selecting from available models** (when supported)
+- **Choosing your preferred commit message format** (plain, conventional, or gitmoji)
 
   Supported providers include:
 
   - **TogetherAI** (recommended) - Get your API key from [TogetherAI](https://api.together.ai/)
   - **OpenAI** - Get your API key from [OpenAI API Keys page](https://platform.openai.com/account/api-keys)
+  - **Groq** - Get your API key from [Groq Console](https://console.groq.com/keys)
+  - **xAI** - Get your API key from [xAI Console](https://console.x.ai/)
   - **OpenRouter** - Get your API key from [OpenRouter](https://openrouter.ai/keys)
   - **Ollama** (local) - Run AI models locally with [Ollama](https://ollama.ai)
+  - **LM Studio** (local) - No API key required. Runs on your computer via [LM Studio](https://lmstudio.ai/)
   - **Custom OpenAI-compatible endpoint** - Use any service that implements the OpenAI API
 
-  Alternatively, you can use environment variables (recommended for CI/CD):
+  **For CI/CD environments**, you can also set up configuration via the config file:
 
   ```bash
-  export OPENAI_API_KEY="your_api_key_here"
-  export OPENAI_BASE_URL="your_api_endpoint"  # Optional, for custom endpoints
-  export OPENAI_MODEL="your_model_choice"     # Optional, defaults to provider default
+  aicommits config set OPENAI_API_KEY="your_api_key_here"
+  aicommits config set OPENAI_BASE_URL="your_api_endpoint"  # Optional, for custom endpoints
+  aicommits config set OPENAI_MODEL="your_model_choice"     # Optional, defaults to provider default
   ```
 
   > **Note:** When using environment variables, ensure all related variables (e.g., `OPENAI_API_KEY` and `OPENAI_BASE_URL`) are set consistently to avoid configuration mismatches with the config file.
@@ -58,16 +61,22 @@ This will guide you through:
 
 Check the installed version with:
 
+```sh
+aicommits --version
 ```
 
-aicommits --version
+To update to the latest version, run:
 
+```sh
+aicommits update
 ```
 
-If it's not the [latest version](https://github.com/Nutlope/aicommits/releases/latest), run:
+This will automatically detect your package manager (npm, pnpm, yarn, or bun) and update using the correct command.
+
+Alternatively, you can manually update:
 
 ```sh
-npm update -g aicommits
+npm install -g aicommits
 ```
 
 ## Usage
@@ -93,12 +102,14 @@ aicommits --all # or -a
 
 #### CLI Options
 
-- `--generate` or `-g`: Number of messages to generate (default: **1**)
-- `--exclude` or `-x`: Files to exclude from AI analysis
 - `--all` or `-a`: Automatically stage changes in tracked files for the commit (default: **false**)
-- `--type` or `-t`: Git commit message format (default: **conventional**). Supports `conventional` and `gitmoji`
-- `--confirm` or `-y`: Skip confirmation when committing after message generation (default: **false**)
 - `--clipboard` or `-c`: Copy the selected message to the clipboard instead of committing (default: **false**)
+- `--generate` or `-g`: Number of messages to generate (default: **1**)
+- `--exclude` or `-x`: Files to exclude from AI analysis
+- `--type` or `-t`: Git commit message format (default: **plain**). Supports `plain`, `conventional`, and `gitmoji`
+- `--prompt` or `-p`: Custom prompt to guide the LLM behavior (e.g., specific language, style instructions)
+- `--no-verify` or `-n`: Bypass pre-commit hooks while committing (default: **false**)
+- `--yes` or `-y`: Skip confirmation when committing after message generation (default: **false**)
 
 #### Generate multiple recommendations
 
@@ -110,15 +121,41 @@ aicommits --generate <i> # or -g <i>
 
 > Warning: this uses more tokens, meaning it costs more.
 
-#### Generating Conventional Commits
+#### Commit Message Formats
+
+You can choose from three different commit message formats:
+
+- **plain** (default): Simple, unstructured commit messages
+- **conventional**: [Conventional Commits](https://conventionalcommits.org/) format with type and scope
+- **gitmoji**: Emoji-based commit messages
 
-If you'd like to generate [Conventional Commits](https://conventionalcommits.org/), you can use the `--type` flag followed by `conventional`. This will prompt `aicommits` to format the commit message according to the Conventional Commits specification:
+Use the `--type` flag to specify the format:
 
 ```sh
 aicommits --type conventional # or -t conventional
+aicommits --type gitmoji       # or -t gitmoji
+aicommits --type plain         # or -t plain (default)
 ```
 
-This feature can be useful if your project follows the Conventional Commits standard or if you're using tools that rely on this commit format.
+This feature is useful if your project follows a specific commit message standard or if you're using tools that rely on these commit formats.
+
+#### Custom Prompts
+
+You can customize the LLM's behavior with the `--prompt` flag to guide commit message generation:
+
+```sh
+# Write commit messages in a specific language
+aicommits -p "Write commit messages in Italian"
+
+# Focus on specific aspects of the changes
+aicommits -p "Focus on performance implications of changes"
+
+# Use a specific style or tone
+aicommits -p "Use technical jargon suitable for senior developers"
+
+# Include specific details in the message
+aicommits -p "Always mention the specific function names and file paths changed"
+```
 
 ### Git hook
 
@@ -202,6 +239,21 @@ This will:
 - Let you select from available models or enter a custom model name
 - Update your configuration automatically
 
+### Updating aicommits
+
+To update to the latest version, run:
+
+```sh
+aicommits update
+```
+
+This will:
+
+- Check for the latest version on npm
+- Detect your package manager (npm, pnpm, yarn, or bun)
+- Update using the appropriate command
+- Show progress and confirm when complete
+
 ### Reading a configuration value
 
 To retrieve a configuration option, use the command:
@@ -258,7 +310,7 @@ Model to use for OpenAI-compatible providers.
 
 #### provider
 
-The selected AI provider. Set automatically during `aicommits setup`. Valid values: `openai`, `togetherai`, `ollama`, `custom`.
+The selected AI provider. Set automatically during `aicommits setup`. Valid values: `openai`, `togetherai`, `groq`, `xai`, `openrouter`, `ollama`, `lmstudio`, `custom`.
 
 #### locale
 
@@ -296,18 +348,20 @@ aicommits config set max-length=100
 
 #### type
 
-Default: `""` (Empty string)
+Default: `plain`
 
-The type of commit message to generate. Set this to "conventional" to generate commit messages that follow the Conventional Commits specification:
+The type of commit message to generate. Available options:
 
-```sh
-aicommits config set type=conventional
-```
+- `plain`: Simple, unstructured commit messages
+- `conventional`: Conventional Commits format with type and scope
+- `gitmoji`: Emoji-based commit messages
 
-You can clear this option by setting it to an empty string:
+Examples:
 
 ```sh
-aicommits config set type=
+aicommits config set type=conventional
+aicommits config set type=gitmoji
+aicommits config set type=plain
 ```
 
 ## How it works