ngpt 2.14.0__tar.gz → 2.14.1__tar.gz

{ngpt-2.14.0 → ngpt-2.14.1}/.gitignore

@@ -11,3 +11,5 @@ wheels/
 
 # Environment variables
 .env
+# Reference files
+ref-*

{ngpt-2.14.0 → ngpt-2.14.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 2.14.0
+Version: 2.14.1
 Summary: A lightweight Python CLI and library for interacting with OpenAI-compatible APIs, supporting both official and self-hosted LLM endpoints.
 Project-URL: Homepage, https://github.com/nazdridoy/ngpt
 Project-URL: Repository, https://github.com/nazdridoy/ngpt

{ngpt-2.14.0 → ngpt-2.14.1}/docs/usage/cli_config.md

@@ -66,9 +66,81 @@ These options are mutually exclusive:
 
 Some options only apply in specific modes:
 
+#### Code Mode Options
 - `language` - Programming language for code generation (only for code mode)
+
+#### Logging Options
 - `log` - Filepath to log conversation (for interactive and text modes)
 
+#### Git Commit Message Mode Options
+- `message-context` - Context to guide AI generation (e.g., file types, commit type directive)
+- `recursive-chunk` - Process large diffs in chunks with recursive analysis if needed (default: false)
+- `diff` - Path to diff file to use instead of staged git changes
+- `chunk-size` - Number of lines per chunk when chunking is enabled (default: 200)
+- `max-depth` - Maximum recursion depth for recursive chunking (default: 3)
+
+### Git Commit Message Options Details
+
+These options control the behavior of the `--gitcommsg` mode, which helps generate conventional commit messages from git diffs.
+
+#### message-context
+This option provides contextual information to guide the AI when generating commit messages. It accepts various directives:
+
+```bash
+# Set a default context for commit message generation
+ngpt --cli-config set message-context "type:feat focus on UI"
+```
+
+The context can include:
+- **Commit type directives**: `type:feat`, `type:fix`, `type:docs`, etc.
+- **File type filtering**: `javascript`, `python`, `css`, etc.
+- **Focus directives**: `focus on auth`, `focus on UI`, etc.
+- **Exclusion directives**: `ignore formatting`, `exclude tests`, etc.
+
+#### recursive-chunk
+When set to `true`, this enables recursive chunking for processing large diffs, which is helpful for large commits:
+
+```bash
+# Enable recursive chunking by default
+ngpt --cli-config set recursive-chunk true
+```
+
+With recursive chunking enabled, the system will:
+1. Split large diffs into chunks
+2. Process each chunk separately
+3. Further break down large intermediate results if needed
+4. Combine everything into a final commit message
+
+#### diff
+This specifies a default path to a diff file. When using the `--gitcommsg` command with `--diff` (without specifying a file), it will use this configured path:
+
+```bash
+# Set a default diff file path
+ngpt --cli-config set diff /path/to/changes.diff
+```
+
+**Important Note**: The diff file from CLI config is only used when you explicitly provide the `--diff` flag without a specific path. If you don't include the `--diff` flag, the system will always use git staged changes regardless of this setting.
+
+#### chunk-size
+Controls how many lines of diff are processed in each chunk when chunking is enabled:
+
+```bash
+# Set a larger chunk size (default is 200)
+ngpt --cli-config set chunk-size 300
+```
+
+Larger chunk sizes can provide more context but may hit token limits with some models. Smaller chunk sizes are better for very large commits but may lose some context between chunks.
+
+#### max-depth
+Sets the maximum recursion depth for recursive chunking:
+
+```bash
+# Increase max recursion depth (default is 3)
+ngpt --cli-config set max-depth 5
+```
+
+Higher values allow processing of extremely large diffs but may take longer.
+
 ### Context-Aware Application
 
 Each option configured via `--cli-config` is only applied if it's relevant to the current execution mode and if it wasn't already specified as a command-line argument.
@@ -140,6 +212,15 @@ ngpt --cli-config set prettify true
 
 # Set default provider to use
 ngpt --cli-config set provider Gemini
+
+# Enable recursive chunking for git commit messages by default
+ngpt --cli-config set recursive-chunk true
+
+# Set a default diff file path for git commit messages
+ngpt --cli-config set diff /path/to/changes.diff
+
+# Set a larger chunk size for git commit message processing
+ngpt --cli-config set chunk-size 300
 ```
 
 ### Using CLI Configuration

{ngpt-2.14.0 → ngpt-2.14.1}/docs/usage/gitcommsg.md

@@ -105,7 +105,7 @@ This is particularly useful for large pull requests or commits with many changes
 
 ## CLI Configuration
 
-You can set default values for gitcommsg options:
+You can set default values for gitcommsg options using the CLI configuration system:
 
 ```bash
 # Set default chunk size
@@ -113,8 +113,116 @@ ngpt --cli-config set chunk-size 150
 
 # Enable recursive chunking by default
 ngpt --cli-config set recursive-chunk true
+
+# Set a default diff file path (used with --diff flag)
+ngpt --cli-config set diff /path/to/your/changes.diff
+
+# Set maximum recursion depth
+ngpt --cli-config set max-depth 5
+
+# Set a context directive to always apply
+ngpt --cli-config set message-context "type:feat"
+```
+
+### Available CLI Configuration Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `recursive-chunk` | bool | false | Process large diffs in chunks with recursive analysis |
+| `diff` | string | null | Path to diff file to use instead of staged changes |
+| `chunk-size` | int | 200 | Number of lines per chunk when chunking is enabled |
+| `max-depth` | int | 3 | Maximum recursion depth for recursive chunking |
+| `message-context` | string | null | Context to guide AI generation |
+
+### Option Details
+
+#### recursive-chunk
+
+When enabled, this option automatically processes large diffs in chunks and then combines the results:
+
+```bash
+# Enable recursive chunking by default
+ngpt --cli-config set recursive-chunk true
+```
+
+This is particularly useful for large commits or codebases, as it helps:
+- Avoid token limits with large diffs
+- Handle rate limiting better by breaking requests into smaller pieces
+- Process very large changes that would otherwise fail
+
+#### chunk-size
+
+Controls how many lines of diff are processed in each chunk:
+
+```bash
+# Set a custom chunk size (smaller chunks for very large diffs)
+ngpt --cli-config set chunk-size 150
+
+# Or larger chunks for more context
+ngpt --cli-config set chunk-size 300
+```
+
+Smaller chunks (100-150 lines) work better for very large diffs or models with stricter token limits, while larger chunks (300-500 lines) provide more context but may hit token limits.
+
+#### max-depth
+
+Sets how many recursive analysis levels are allowed when using recursive chunking:
+
+```bash
+# Increase max recursion depth for extremely large diffs
+ngpt --cli-config set max-depth 5
+```
+
+Higher values allow processing larger diffs but may increase processing time.
+
+#### message-context
+
+Provides contextual guidance for the AI when generating commit messages:
+
+```bash
+# Always focus on a specific aspect
+ngpt --cli-config set message-context "focus on API changes"
+
+# Always use a specific commit type
+ngpt --cli-config set message-context "type:feat"
+
+# Combined directives
+ngpt --cli-config set message-context "type:fix exclude tests"
 ```
 
+This is useful when you consistently work on the same type of changes and want to standardize your commit messages.
+
+### Using the Diff File Option
+
+When you've set a default diff file using the CLI config:
+
+```bash
+# Set a default diff file
+ngpt --cli-config set diff /path/to/changes.diff
+```
+
+The diff file from CLI config is only used when you specifically request it with the `--diff` flag without providing a path. You have three ways to control which diff is used:
+
+1. **Use git staged changes** (ignore the CLI config diff):
+   ```bash
+   ngpt --gitcommsg
+   ```
+   This will always use git staged changes regardless of your CLI config.
+
+2. **Use the CLI config diff file**:
+   ```bash
+   ngpt --gitcommsg --diff
+   ```
+   This explicitly tells ngpt to use the diff file specified in your CLI config.
+
+3. **Use a specific diff file** (override CLI config):
+   ```bash
+   ngpt --gitcommsg --diff /path/to/another.diff
+   ```
+   This overrides both git staged changes and your CLI config to use the specified file.
+
+This approach gives you flexibility with a default diff file while maintaining explicit control over when it's used.
+
 ## Example Output
 
 ```

{ngpt-2.14.0 → ngpt-2.14.1}/ngpt/cli/args.py

@@ -94,8 +94,8 @@ def setup_argument_parser():
                       help='Context to guide AI generation (e.g., file types, commit type)')
     gitcommsg_group.add_argument('-r', '--recursive-chunk', action='store_true',
                       help='Process large diffs in chunks with recursive analysis if needed')
-    gitcommsg_group.add_argument('--diff', metavar='FILE',
-                      help='Use diff from specified file instead of staged changes')
+    gitcommsg_group.add_argument('--diff', metavar='FILE', nargs='?', const=True,
+                      help='Use diff from specified file instead of staged changes. If used without a path, uses the path from CLI config.')
     gitcommsg_group.add_argument('--chunk-size', type=int, default=200,
                       help='Number of lines per chunk when chunking is enabled (default: 200)')
     gitcommsg_group.add_argument('--max-depth', type=int, default=3,

{ngpt-2.14.0 → ngpt-2.14.1}/ngpt/cli/main.py

@@ -46,7 +46,8 @@ def show_cli_config_help():
         "code": [],
         "interactive": [],
         "text": [],
-        "shell": []
+        "shell": [],
+        "gitcommsg": []  # Add gitcommsg context
     }
     
     for option, meta in CLI_CONFIG_OPTIONS.items():
@@ -71,7 +72,8 @@ def show_cli_config_help():
         ("code", "Code generation mode"),
         ("interactive", "Interactive mode"),
         ("text", "Text mode"),
-        ("shell", "Shell mode")
+        ("shell", "Shell mode"),
+        ("gitcommsg", "Git commit message mode")  # Add gitcommsg mode
     ]:
         if context_groups[mode]:
             print(f"\n    {COLORS['yellow']}Options for {options}:{COLORS['reset']}")
@@ -88,6 +90,8 @@ def show_cli_config_help():
     print(f"    {COLORS['yellow']}ngpt --cli-config set language java{COLORS['reset']}        - Set default language to java for code generation")
     print(f"    {COLORS['yellow']}ngpt --cli-config set temperature 0.9{COLORS['reset']}      - Set default temperature to 0.9")
     print(f"    {COLORS['yellow']}ngpt --cli-config set no-stream true{COLORS['reset']}       - Disable streaming by default")
+    print(f"    {COLORS['yellow']}ngpt --cli-config set recursive-chunk true{COLORS['reset']} - Enable recursive chunking for git commit messages")
+    print(f"    {COLORS['yellow']}ngpt --cli-config set diff /path/to/file.diff{COLORS['reset']} - Set default diff file for git commit messages")
     print(f"    {COLORS['yellow']}ngpt --cli-config get temperature{COLORS['reset']}          - Check the current temperature setting")
     print(f"    {COLORS['yellow']}ngpt --cli-config get{COLORS['reset']}                      - Show all current CLI settings")
     print(f"    {COLORS['yellow']}ngpt --cli-config unset language{COLORS['reset']}           - Remove language setting")
@@ -562,7 +566,7 @@ def main():
         
         elif args.gitcommsg:
             # Apply CLI config for gitcommsg mode
-            args = apply_cli_config(args, "all")
+            args = apply_cli_config(args, "gitcommsg")
             
             # Git commit message generation mode
             gitcommsg_mode(client, args, logger=logger)

{ngpt-2.14.0 → ngpt-2.14.1}/ngpt/cli/modes/gitcommsg.py

@@ -8,6 +8,7 @@ from datetime import datetime
 import logging
 from ..formatters import COLORS
 from ...utils.log import create_gitcommsg_logger
+from ...utils.cli_config import get_cli_config_option
 
 def get_diff_content(diff_file=None):
     """Get git diff content from file or git staged changes.
@@ -638,8 +639,35 @@ def gitcommsg_mode(client, args, logger=None):
         active_logger.debug(f"Args: {args}")
     
     try:
+        # Check if --diff was explicitly passed on the command line
+        diff_option_provided = '--diff' in sys.argv
+        diff_path_provided = diff_option_provided and args.diff is not None and args.diff is not True
+        
+        # If --diff wasn't explicitly provided on the command line, don't use the config value
+        if not diff_option_provided:
+            # Even if diff is in CLI config, don't use it unless --diff flag is provided
+            diff_file = None
+            if active_logger:
+                active_logger.info("Not using diff file from CLI config because --diff flag was not provided")
+        else:
+            # --diff flag was provided on command line
+            if args.diff is True:
+                # --diff flag was used without a path, use the value from CLI config
+                success, config_diff = get_cli_config_option("diff")
+                diff_file = config_diff if success and config_diff else None
+                if active_logger:
+                    if diff_file:
+                        active_logger.info(f"Using diff file from CLI config: {diff_file}")
+                    else:
+                        active_logger.info("No diff file found in CLI config")
+            else:
+                # --diff flag was used with an explicit path
+                diff_file = args.diff
+                if active_logger:
+                    active_logger.info(f"Using explicitly provided diff file: {diff_file}")
+        
         # Get diff content
-        diff_content = get_diff_content(args.diff)
+        diff_content = get_diff_content(diff_file)
         
         if not diff_content:
             print(f"{COLORS['red']}No diff content available. Exiting.{COLORS['reset']}")

{ngpt-2.14.0 → ngpt-2.14.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ngpt"
-version = "2.14.0"
+version = "2.14.1"
 description = "A lightweight Python CLI and library for interacting with OpenAI-compatible APIs, supporting both official and self-hosted LLM endpoints."
 authors = [
     {name = "nazDridoy", email = "nazdridoy399@gmail.com"},

{ngpt-2.14.0 → ngpt-2.14.1}/uv.lock

@@ -134,7 +134,7 @@ wheels = [
 
 [[package]]
 name = "ngpt"
-version = "2.14.0"
+version = "2.14.1"
 source = { editable = "." }
 dependencies = [
     { name = "prompt-toolkit" },