aicommit2 2.2.23 → 2.3.0

package/README.md

@@ -195,6 +195,13 @@ aicommit2 --all # or -a
 - `--generate` or `-g`: Number of messages to generate (default: **1**)
   - **Warning**: This uses more tokens, meaning it costs more.
 - `--exclude` or `-x`: Files to exclude from AI analysis
+- `--include-body` or `-i`: Force include commit body in all generated messages (default: **false**)
+  - When enabled, all commit messages will include a detailed body section
+  - Useful for providing more context in commit messages
+- `--auto-select` or `-s`: Automatically select the commit message when only one AI model is configured (default: **false**)
+  - When enabled and only one AI provider is configured, the generated message is automatically selected
+  - Also skips the confirmation prompt for a seamless experience
+  - Has no effect when multiple AI providers are configured
 - `--hook-mode`: Run as a Git hook, typically used with prepare-commit-msg hook (default: **false**)
   - This mode is automatically enabled when running through the Git hook system
   - See [Git hook](#git-hook) section for more details
@@ -359,7 +366,7 @@ _aicommit2_ offers flexible configuration options for all AI services, including
    To specify multiple models, use the `--[Model].model=model1,model2` format.
 
    ```sh
-   aicommit2 --OPENAI.locale="jp" --GEMINI.temperature="0.5" --OPENAI.model="gpt-4o,gpt-3.5-turbo"
+   aicommit2 --OPENAI.locale="jp" --GEMINI.temperature="0.5" --OPENAI.model="gpt-4o-mini,gpt-3.5-turbo"
    ```
 
 2. **Configuration file**: Refer to [Configuration File Location](#configuration-file-location) or use the `set` command.
@@ -376,14 +383,14 @@ _aicommit2_ offers flexible configuration options for all AI services, including
    key="<your-api-key>"
    temperature=0.8
    generate=1
-   model="gpt-4o,gpt-3.5-turbo"
+   model="gpt-4o-mini,gpt-3.5-turbo"
    systemPromptPath="<your-prompt-path>"
 
    [GEMINI]
    key="<your-api-key>"
    generate=5
    includeBody=true
-   model="gemini-pro,gemini-flash"
+   model="gemini-2.0-flash,gemini-1.5-pro"
 
    [OLLAMA]
    temperature=0.7
@@ -655,9 +662,9 @@ aicommit2 config set \
   topP=0.8 \
   maxTokens=1024 \
   temperature=0.7 \
-  OPENAI.key="sk-..." OPENAI.model="gpt-4o" OPENAI.temperature=0.5 \
-  ANTHROPIC.key="sk-..." ANTHROPIC.model="claude-3-haiku" ANTHROPIC.maxTokens=2000 \
-  MISTRAL.key="your-key" MISTRAL.model="codestral-latest"  \
+  OPENAI.key="sk-..." OPENAI.model="gpt-4o-mini" OPENAI.temperature=0.5 \
+  ANTHROPIC.key="sk-..." ANTHROPIC.model="claude-3-5-haiku-20241022" ANTHROPIC.maxTokens=2000 \
+  MISTRAL.key="your-key" MISTRAL.model="mistral-small-latest"  \
   OLLAMA.model="llama3.2" OLLAMA.numCtx=4096 OLLAMA.watchMode=true
 ```
 
@@ -712,14 +719,43 @@ The `logging` setting controls whether log files are generated. It can be config
 - **Global `logging` setting**: When set in the general configuration, it controls the overall application logging (handled by Winston) and acts as a default for AI request/response logging.
 - **Service-specific `logging` setting**: You can override the global `logging` setting for a particular AI service. If `logging` is set to `false` for a specific service, AI request/response logs will not be generated for that service, regardless of the global setting.
 
-### Removing All Logs
+### Log Management
 
-You can remove all generated log files (both application and AI logs) using the following command:
+_aicommit2_ generates detailed logs for debugging and tracking AI requests. You can manage these log files using the built-in log commands:
+
+#### View Log Files
+
+```sh
+# List all log files with details
+aicommit2 log list
+
+# Show logs directory path
+aicommit2 log path
+```
+
+#### Open Log Directory
+
+```sh
+# Open logs directory in your file manager
+aicommit2 log open
+```
+
+#### Clean Up Logs
 
 ```sh
+# Remove all log files
 aicommit2 log removeAll
 ```
 
+#### Log File Information
+
+- **Location**: Logs are stored in your system's state directory (usually `~/.local/state/aicommit2/logs` on Linux/macOS)
+- **Content**: Each log file contains the git diff, system prompt, AI response, and metadata
+- **Naming**: Files are named with timestamp and hash for easy identification
+- **Size**: File sizes are displayed in human-readable format (B, KB, MB, GB)
+
+
+
 ## 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.