aicommit2 2.2.24 → 2.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +37 -8
  2. package/dist/cli.mjs +119 -102
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -366,7 +366,7 @@ _aicommit2_ offers flexible configuration options for all AI services, including
366
366
  To specify multiple models, use the `--[Model].model=model1,model2` format.
367
367
 
368
368
  ```sh
369
- aicommit2 --OPENAI.locale="jp" --GEMINI.temperature="0.5" --OPENAI.model="gpt-4o,gpt-3.5-turbo"
369
+ aicommit2 --OPENAI.locale="jp" --GEMINI.temperature="0.5" --OPENAI.model="gpt-4o-mini,gpt-3.5-turbo"
370
370
  ```
371
371
 
372
372
  2. **Configuration file**: Refer to [Configuration File Location](#configuration-file-location) or use the `set` command.
@@ -383,14 +383,14 @@ _aicommit2_ offers flexible configuration options for all AI services, including
383
383
  key="<your-api-key>"
384
384
  temperature=0.8
385
385
  generate=1
386
- model="gpt-4o,gpt-3.5-turbo"
386
+ model="gpt-4o-mini,gpt-3.5-turbo"
387
387
  systemPromptPath="<your-prompt-path>"
388
388
 
389
389
  [GEMINI]
390
390
  key="<your-api-key>"
391
391
  generate=5
392
392
  includeBody=true
393
- model="gemini-pro,gemini-flash"
393
+ model="gemini-2.0-flash,gemini-1.5-pro"
394
394
 
395
395
  [OLLAMA]
396
396
  temperature=0.7
@@ -662,9 +662,9 @@ aicommit2 config set \
662
662
  topP=0.8 \
663
663
  maxTokens=1024 \
664
664
  temperature=0.7 \
665
- OPENAI.key="sk-..." OPENAI.model="gpt-4o" OPENAI.temperature=0.5 \
666
- ANTHROPIC.key="sk-..." ANTHROPIC.model="claude-3-haiku" ANTHROPIC.maxTokens=2000 \
667
- MISTRAL.key="your-key" MISTRAL.model="codestral-latest" \
665
+ OPENAI.key="sk-..." OPENAI.model="gpt-4o-mini" OPENAI.temperature=0.5 \
666
+ ANTHROPIC.key="sk-..." ANTHROPIC.model="claude-3-5-haiku-20241022" ANTHROPIC.maxTokens=2000 \
667
+ MISTRAL.key="your-key" MISTRAL.model="mistral-small-latest" \
668
668
  OLLAMA.model="llama3.2" OLLAMA.numCtx=4096 OLLAMA.watchMode=true
669
669
  ```
670
670
 
@@ -719,14 +719,43 @@ The `logging` setting controls whether log files are generated. It can be config
719
719
  - **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.
720
720
  - **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.
721
721
 
722
- ### Removing All Logs
722
+ ### Log Management
723
723
 
724
- You can remove all generated log files (both application and AI logs) using the following command:
724
+ _aicommit2_ generates detailed logs for debugging and tracking AI requests. You can manage these log files using the built-in log commands:
725
+
726
+ #### View Log Files
727
+
728
+ ```sh
729
+ # List all log files with details
730
+ aicommit2 log list
731
+
732
+ # Show logs directory path
733
+ aicommit2 log path
734
+ ```
735
+
736
+ #### Open Log Directory
737
+
738
+ ```sh
739
+ # Open logs directory in your file manager
740
+ aicommit2 log open
741
+ ```
742
+
743
+ #### Clean Up Logs
725
744
 
726
745
  ```sh
746
+ # Remove all log files
727
747
  aicommit2 log removeAll
728
748
  ```
729
749
 
750
+ #### Log File Information
751
+
752
+ - **Location**: Logs are stored in your system's state directory (usually `~/.local/state/aicommit2/logs` on Linux/macOS)
753
+ - **Content**: Each log file contains the git diff, system prompt, AI response, and metadata
754
+ - **Naming**: Files are named with timestamp and hash for easy identification
755
+ - **Size**: File sizes are displayed in human-readable format (B, KB, MB, GB)
756
+
757
+
758
+
730
759
  ## Custom Prompt Template
731
760
 
732
761
  _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.