aicommits 2.0.0-develop.22 → 2.0.0-develop.24

package/README.md

@@ -39,6 +39,8 @@ This will guide you through:
 
   - **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/)
@@ -95,12 +97,13 @@ aicommits --all # or -a
 
 #### CLI Options
 
+- `--all` or `-a`: Automatically stage changes in tracked files for the commit (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
-- `--all` or `-a`: Automatically stage changes in tracked files for the commit (default: **false**)
 - `--type` or `-t`: Git commit message format (default: **plain**). Supports `plain`, `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**)
+- `--prompt` or `-p`: Custom prompt to guide the LLM behavior (e.g., specific language, style instructions)
+- `--yes` or `-y`: Skip confirmation when committing after message generation (default: **false**)
 
 #### Generate multiple recommendations
 
@@ -130,6 +133,24 @@ aicommits --type plain         # or -t plain (default)
 
 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
 
 You can also integrate _aicommits_ 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.
@@ -268,7 +289,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