aicommits 2.0.0-develop.2 → 2.0.0-develop.21

package/README.md

@@ -17,9 +17,11 @@
 1. Install _aicommits_:
 
    ```sh
-   npm install -g aicommits
+   npm install -g aicommits@develop
    ```
 
+   > We need @develop since v2 is still not released as latest/main!
+
 2. Run the setup command to choose your AI provider:
 
    ```sh
@@ -31,6 +33,7 @@ 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:
 
@@ -38,14 +41,15 @@ This will guide you through:
   - **OpenAI** - Get your API key from [OpenAI API Keys page](https://platform.openai.com/account/api-keys)
   - **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.
@@ -65,7 +69,7 @@ aicommits --version
 If it's not the [latest version](https://github.com/Nutlope/aicommits/releases/latest), run:
 
 ```sh
-npm update -g aicommits
+npm install -g aicommits@develop
 ```
 
 ## Usage
@@ -94,7 +98,7 @@ aicommits --all # or -a
 - `--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`
+- `--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**)
 
@@ -108,15 +112,23 @@ 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:
 
-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:
+- **plain** (default): Simple, unstructured commit messages
+- **conventional**: [Conventional Commits](https://conventionalcommits.org/) format with type and scope
+- **gitmoji**: Emoji-based commit messages
+
+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.
 
 ### Git hook
 
@@ -294,18 +306,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