ngpt 2.16.7__py3-none-any.whl → 3.0.1__py3-none-any.whl

ngpt/cli/args.py

@@ -90,9 +90,7 @@ def setup_argument_parser():
     
     # GitCommit message options
     gitcommsg_group = parser.add_argument_group('Git Commit Message Options')
-    gitcommsg_group.add_argument('-m', '--message-context', 
-                      help='Context to guide AI generation (e.g., file types, commit type)')
-    gitcommsg_group.add_argument('-r', '--recursive-chunk', action='store_true',
+    gitcommsg_group.add_argument('--rec-chunk', action='store_true',
                       help='Process large diffs in chunks with recursive analysis if needed')
     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.')
@@ -116,11 +114,11 @@ def setup_argument_parser():
                                       help='Generate code')
     mode_exclusive_group.add_argument('-t', '--text', action='store_true', 
                                       help='Enter multi-line text input (submit with Ctrl+D)')
-    mode_exclusive_group.add_argument('--stdin', action='store_true',
+    mode_exclusive_group.add_argument('-p', '--pipe', action='store_true',
                                       help='Read from stdin and use content with prompt. Use {} in prompt as placeholder for stdin content')
-    mode_exclusive_group.add_argument('--rewrite', action='store_true',
+    mode_exclusive_group.add_argument('-r', '--rewrite', action='store_true',
                                       help='Rewrite text from stdin to be more natural while preserving tone and meaning')
-    mode_exclusive_group.add_argument('--gitcommsg', action='store_true',
+    mode_exclusive_group.add_argument('-g', '--gitcommsg', action='store_true',
                                       help='Generate AI-powered git commit messages from staged changes or diff file')
     
     return parser
@@ -145,8 +143,8 @@ def validate_args(args):
         raise ValueError("--stream-prettify requires Rich to be installed. Install with: pip install \"ngpt[full]\" or pip install rich")
     
     # If stdin mode is used, check if input is available
-    if args.stdin and sys.stdin.isatty():
-        raise ValueError("--stdin was specified but no input is piped. Use echo 'content' | ngpt --stdin 'prompt with {}'")
+    if args.pipe and sys.stdin.isatty():
+        raise ValueError("--pipe was specified but no input is piped. Use echo 'content' | ngpt --pipe 'prompt with {}'")
     
     return args
 

ngpt/cli/main.py

@@ -550,11 +550,11 @@ def main():
             # Text mode (multiline input)
             text_mode(client, args, logger=logger)
         
-        elif args.stdin:
-            # Apply CLI config for stdin mode (similar to chat mode)
+        elif args.pipe:
+            # Apply CLI config for pipe mode (similar to chat mode)
             args = apply_cli_config(args, "all")
             
-            # Stdin mode (using the chat mode with stdin input)
+            # Pipe mode (using the chat mode with stdin input)
             chat_mode(client, args, logger=logger)
         
         elif args.rewrite:

ngpt/cli/modes/chat.py

@@ -12,8 +12,8 @@ def chat_mode(client, args, logger=None):
         args: The parsed command-line arguments
         logger: Optional logger instance
     """
-    # Handle stdin mode
-    if args.stdin:
+    # Handle pipe mode
+    if args.pipe:
         # Read input from stdin
         stdin_content = sys.stdin.read().strip()
         

ngpt/cli/modes/gitcommsg.py

@@ -70,11 +70,11 @@ def split_into_chunks(content, chunk_size=200):
         
     return chunks
 
-def create_technical_analysis_system_prompt(context=None):
-    """Create system prompt for technical analysis based on context data.
+def create_technical_analysis_system_prompt(preprompt=None):
+    """Create system prompt for technical analysis based on preprompt data.
     
     Args:
-        context: The raw context string from -m flag
+        preprompt: The raw preprompt string from --preprompt flag
         
     Returns:
         str: System prompt for the technical analysis stage
@@ -102,25 +102,25 @@ RULES:
 8. When analyzing multiple files, clearly separate each file's changes
 9. Include proper technical details (method names, component identifiers, etc.)"""
 
-    # If context is provided, append it with strong wording about absolute priority
-    if context:
-        context_prompt = f"""
+    # If preprompt is provided, prepend it to the base prompt with strong wording about absolute priority
+    if preprompt:
+        preprompt_section = f"""===CRITICAL USER PREPROMPT - ABSOLUTE HIGHEST PRIORITY===
+The following preprompt from the user OVERRIDES ALL OTHER INSTRUCTIONS and must be followed exactly:
 
-===CRITICAL USER CONTEXT - ABSOLUTE HIGHEST PRIORITY===
-The following context from the user OVERRIDES ALL OTHER INSTRUCTIONS and must be followed exactly:
+{preprompt}
 
-{context}
+THIS USER PREPROMPT HAS ABSOLUTE PRIORITY over any other instructions that follow. If it contradicts other instructions, the user preprompt MUST be followed. No exceptions.
 
-THIS USER CONTEXT HAS ABSOLUTE PRIORITY over any other instructions in this prompt. If it contradicts other instructions, the user context MUST be followed. No exceptions."""
-        base_prompt += context_prompt
+"""
+        return preprompt_section + base_prompt
     
     return base_prompt
 
-def create_system_prompt(context=None):
-    """Create system prompt for commit message generation based on context data.
+def create_system_prompt(preprompt=None):
+    """Create system prompt for commit message generation based on preprompt data.
     
     Args:
-        context: The raw context string from -m flag
+        preprompt: The raw preprompt string from --preprompt flag
         
     Returns:
         str: System prompt for the AI
@@ -188,11 +188,11 @@ refactor(core): simplify data processing pipeline
 - [test] Update tests for new pipeline structure (tests/pipeline.test.js)
 
 4. Multiple changes to the same file:
-refactor(core): simplify context handling for commit prompts
+refactor(core): simplify preprompt handling for commit prompts
 
-- [refactor] Remove process_context function (cli/modes/gitcommsg.py:69-124)
-- [refactor] Update all functions to accept raw context string (gitcommsg.py:create_system_prompt())
-- [refactor] Replace context_data usages with context (gitcommsg.py)
+- [refactor] Remove process_preprompt function (cli/modes/gitcommsg.py:69-124)
+- [refactor] Update all functions to accept raw preprompt string (gitcommsg.py:create_system_prompt())
+- [refactor] Replace preprompt_data usages with preprompt (gitcommsg.py)
 - [docs] Update library usage doc (docs/usage/library_usage.md:516,531-537)
 - [chore] Bump project version to 2.15.1 (pyproject.toml:3, uv.lock:137)
 
@@ -216,17 +216,17 @@ RULES:
 10. Include proper technical details (method names, component identifiers, etc.)
 11. When all changes are to the same file, mention it once in the summary"""
 
-    # If context is provided, append it with strong wording about absolute priority
-    if context:
-        context_prompt = f"""
+    # If preprompt is provided, prepend it with strong wording about absolute priority
+    if preprompt:
+        preprompt_section = f"""===CRITICAL USER PREPROMPT - ABSOLUTE HIGHEST PRIORITY===
+The following preprompt from the user OVERRIDES ALL OTHER INSTRUCTIONS and must be followed exactly:
 
-===CRITICAL USER CONTEXT - ABSOLUTE HIGHEST PRIORITY===
-The following context from the user OVERRIDES ALL OTHER INSTRUCTIONS and must be followed exactly:
+{preprompt}
 
-{context}
+THIS USER PREPROMPT HAS ABSOLUTE PRIORITY over any other instructions that follow. If it contradicts other instructions, the user preprompt MUST be followed. No exceptions.
 
-THIS USER CONTEXT HAS ABSOLUTE PRIORITY over any other instructions in this prompt. If it contradicts other instructions, the user context MUST be followed. No exceptions."""
-        base_prompt += context_prompt
+"""
+        return preprompt_section + base_prompt
     
     return base_prompt
 
@@ -346,11 +346,11 @@ refactor(core): simplify data processing pipeline
 - [test] Update tests for new pipeline structure (tests/pipeline.test.js)
 
 4. Multiple changes to the same file:
-refactor(core): simplify context handling for commit prompts
+refactor(core): simplify preprompt handling for commit prompts
 
-- [refactor] Remove process_context function (cli/modes/gitcommsg.py:69-124)
-- [refactor] Update all functions to accept raw context string (gitcommsg.py:create_system_prompt())
-- [refactor] Replace context_data usages with context (gitcommsg.py)
+- [refactor] Remove process_preprompt function (cli/modes/gitcommsg.py:69-124)
+- [refactor] Update all functions to accept raw preprompt string (gitcommsg.py:create_system_prompt())
+- [refactor] Replace preprompt_data usages with preprompt (gitcommsg.py)
 - [docs] Update library usage doc (docs/usage/library_usage.md:516,531-537)
 - [chore] Bump project version to 2.15.1 (pyproject.toml:3, uv.lock:137)
 
@@ -444,13 +444,13 @@ def handle_api_call(client, prompt, system_prompt=None, logger=None, max_retries
             # Exponential backoff
             wait_seconds *= 2
 
-def process_with_chunking(client, diff_content, context, chunk_size=200, recursive=False, logger=None, max_msg_lines=20, max_recursion_depth=3, analyses_chunk_size=None):
+def process_with_chunking(client, diff_content, preprompt, chunk_size=200, recursive=False, logger=None, max_msg_lines=20, max_recursion_depth=3, analyses_chunk_size=None):
     """Process diff with chunking to handle large diffs.
     
     Args:
         client: The NGPTClient instance
         diff_content: The diff content to process
-        context: The raw context string
+        preprompt: The raw preprompt string
         chunk_size: Maximum number of lines per chunk
         recursive: Whether to use recursive chunking
         logger: Optional logger instance
@@ -466,8 +466,8 @@ def process_with_chunking(client, diff_content, context, chunk_size=200, recursi
         analyses_chunk_size = chunk_size
         
     # Create different system prompts for different stages
-    technical_system_prompt = create_technical_analysis_system_prompt(context)
-    commit_system_prompt = create_system_prompt(context)
+    technical_system_prompt = create_technical_analysis_system_prompt(preprompt)
+    commit_system_prompt = create_system_prompt(preprompt)
     
     # Log initial diff content
     if logger:
@@ -547,7 +547,7 @@ def process_with_chunking(client, diff_content, context, chunk_size=200, recursi
         return recursive_chunk_analysis(
             client, 
             combined_analyses, 
-            context, 
+            preprompt, 
             analyses_chunk_size,
             logger,
             max_msg_lines,
@@ -601,13 +601,13 @@ def process_with_chunking(client, diff_content, context, chunk_size=200, recursi
                 logger.error(f"Error combining analyses: {str(e)}")
             return None
 
-def recursive_chunk_analysis(client, combined_analysis, context, chunk_size, logger=None, max_msg_lines=20, max_recursion_depth=3, current_depth=1):
+def recursive_chunk_analysis(client, combined_analysis, preprompt, chunk_size, logger=None, max_msg_lines=20, max_recursion_depth=3, current_depth=1):
     """Recursively chunk and process large analysis results until they're small enough.
     
     Args:
         client: The NGPTClient instance
         combined_analysis: The combined analysis to process
-        context: The raw context string
+        preprompt: The raw preprompt string
         chunk_size: Maximum number of lines per chunk
         logger: Optional logger instance
         max_msg_lines: Maximum number of lines in commit message before condensing
@@ -618,8 +618,8 @@ def recursive_chunk_analysis(client, combined_analysis, context, chunk_size, log
         str: Generated commit message
     """
     # Create different system prompts for different stages
-    technical_system_prompt = create_technical_analysis_system_prompt(context)
-    commit_system_prompt = create_system_prompt(context)
+    technical_system_prompt = create_technical_analysis_system_prompt(preprompt)
+    commit_system_prompt = create_system_prompt(preprompt)
     
     print(f"\n{COLORS['cyan']}Recursive analysis chunking level {current_depth}...{COLORS['reset']}")
     
@@ -767,7 +767,7 @@ SECTION OF ANALYSIS TO CONDENSE:
     return recursive_chunk_analysis(
         client,
         combined_condensed,
-        context,
+        preprompt,
         chunk_size,
         logger,
         max_msg_lines,
@@ -948,11 +948,11 @@ BULLET POINT FORMAT:
 - Not: "- feat: Add new login component" (incorrect)
 
 EXAMPLE OF PROPERLY FORMATTED COMMIT MESSAGE:
-refactor(core): simplify context handling for commit prompts
+refactor(core): simplify preprompt handling for commit prompts
 
-- [refactor] Remove process_context function (cli/modes/gitcommsg.py:69-124)
-- [refactor] Update all functions to accept raw context string (gitcommsg.py:create_system_prompt())
-- [refactor] Replace context_data usages with context (gitcommsg.py)
+- [refactor] Remove process_preprompt function (cli/modes/gitcommsg.py:69-124)
+- [refactor] Update all functions to accept raw preprompt string (gitcommsg.py:create_system_prompt())
+- [refactor] Replace preprompt_data usages with preprompt (gitcommsg.py)
 - [docs] Update library usage doc (docs/usage/library_usage.md:516,531-537)
 - [chore] Bump project version to 2.15.1 (pyproject.toml:3, uv.lock:137)
 
@@ -1025,17 +1025,17 @@ def gitcommsg_mode(client, args, logger=None):
         if active_logger:
             active_logger.log_diff("DEBUG", diff_content)
         
-        # Process context if provided
-        context = None
-        if args.message_context:
-            context = args.message_context
+        # Process preprompt if provided
+        preprompt = None
+        if args.preprompt:
+            preprompt = args.preprompt
             if active_logger:
-                active_logger.debug(f"Using raw context: {context}")
-                active_logger.log_content("DEBUG", "CONTEXT", context)
+                active_logger.debug(f"Using preprompt: {preprompt}")
+                active_logger.log_content("DEBUG", "PREPROMPT", preprompt)
         
         # Create system prompts for different stages
-        technical_system_prompt = create_technical_analysis_system_prompt(context)
-        commit_system_prompt = create_system_prompt(context)
+        technical_system_prompt = create_technical_analysis_system_prompt(preprompt)
+        commit_system_prompt = create_system_prompt(preprompt)
         
         # Log system prompts
         if active_logger:
@@ -1066,7 +1066,7 @@ def gitcommsg_mode(client, args, logger=None):
         if active_logger:
             active_logger.info(f"Analyses chunk size: {analyses_chunk_size}")
         
-        if args.recursive_chunk:
+        if args.rec_chunk:
             # Use chunking with recursive processing
             if active_logger:
                 active_logger.info(f"Using recursive chunking with max_recursion_depth: {max_recursion_depth}")
@@ -1074,7 +1074,7 @@ def gitcommsg_mode(client, args, logger=None):
             result = process_with_chunking(
                 client, 
                 diff_content, 
-                context, 
+                preprompt, 
                 chunk_size=args.chunk_size,
                 recursive=True,
                 logger=active_logger,
@@ -1087,6 +1087,7 @@ def gitcommsg_mode(client, args, logger=None):
             if active_logger:
                 active_logger.info("Processing without chunking")
             
+            # Pass preprompt to create_final_prompt
             prompt = create_final_prompt(diff_content)
             
             # Log final template

ngpt/utils/cli_config.py

@@ -20,8 +20,7 @@ CLI_CONFIG_OPTIONS = {
     "config-index": {"type": "int", "default": 0, "context": ["all"], "exclusive": ["provider"]},
     "web-search": {"type": "bool", "default": False, "context": ["all"]},
     # GitCommit message options
-    "message-context": {"type": "str", "default": None, "context": ["gitcommsg"]},
-    "recursive-chunk": {"type": "bool", "default": False, "context": ["gitcommsg"]},
+    "rec-chunk": {"type": "bool", "default": False, "context": ["gitcommsg"]},
     "diff": {"type": "str", "default": None, "context": ["gitcommsg"]},
     "chunk-size": {"type": "int", "default": 200, "context": ["gitcommsg"]},
     "analyses-chunk-size": {"type": "int", "default": 200, "context": ["gitcommsg"]},

{ngpt-2.16.7.dist-info → ngpt-3.0.1.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 2.16.7
-Summary: Swiss army knife for LLMs: powerful CLI, interactive chatbot, and flexible Python library. Works with OpenAI, Ollama, Groq, Claude, and any OpenAI-compatible API.
+Version: 3.0.1
+Summary: Swiss army knife for LLMs: powerful CLI, interactive chatbot, and flexible Python library. Works with OpenAI, Ollama, Groq, Claude, Gemini, and any OpenAI-compatible API.
 Project-URL: Homepage, https://github.com/nazdridoy/ngpt
 Project-URL: Repository, https://github.com/nazdridoy/ngpt
 Project-URL: Bug Tracker, https://github.com/nazdridoy/ngpt/issues
@@ -36,20 +36,52 @@ Description-Content-Type: text/markdown
 
 # nGPT
 
-🤖 nGPT: A Swiss army knife for LLMs: powerful CLI, interactive chatbot, and flexible library all in one package. Seamlessly work with OpenAI, Ollama, Groq, Claude, or any OpenAI-compatible API to generate code, craft git commits, rewrite text, and execute shell commands. Fast, lightweight, and designed for both casual users and developers.
+<p align="center">
+  <a href="https://pypi.org/project/ngpt/"><img src="https://img.shields.io/pypi/v/ngpt.svg" alt="PyPI version"></a>
+  <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
+  <a href="https://nazdridoy.github.io/ngpt/"><img src="https://img.shields.io/badge/docs-available-brightgreen.svg" alt="Documentation"></a>
+</p>
+
+<p align="center">
+  <a href="https://nazdridoy.github.io/ngpt/installation.html"><img src="https://img.shields.io/badge/Linux-support-blue?logo=linux" alt="Linux"></a>
+  <a href="https://nazdridoy.github.io/ngpt/installation.html"><img src="https://img.shields.io/badge/Windows-support-blue?logo=windows" alt="Windows"></a>
+  <a href="https://nazdridoy.github.io/ngpt/installation.html"><img src="https://img.shields.io/badge/macOS-support-blue?logo=apple" alt="macOS"></a>
+  <a href="https://nazdridoy.github.io/ngpt/installation.html"><img src="https://img.shields.io/badge/Android-Termux-blue?logo=android" alt="Android"></a>
+</p> 
+
+🤖 nGPT: A Swiss army knife for LLMs: powerful CLI, interactive chatbot, and flexible library all in one package. Seamlessly work with OpenAI, Ollama, Groq, Claude, Gemini, or any OpenAI-compatible API to generate code, craft git commits, rewrite text, and execute shell commands. Fast, lightweight, and designed for both casual users and developers.
 
-[![PyPI version](https://img.shields.io/pypi/v/ngpt.svg)](https://pypi.org/project/ngpt/)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-[![Documentation](https://img.shields.io/badge/docs-available-brightgreen.svg)](https://nazdridoy.github.io/ngpt/)
-[![Linux](https://img.shields.io/badge/Linux-support-blue?logo=linux)](https://nazdridoy.github.io/ngpt/installation.html)
-[![Windows](https://img.shields.io/badge/Windows-support-blue?logo=windows)](https://nazdridoy.github.io/ngpt/installation.html)
-[![macOS](https://img.shields.io/badge/macOS-support-blue?logo=apple)](https://nazdridoy.github.io/ngpt/installation.html)
-[![Android](https://img.shields.io/badge/Android-Termux-blue?logo=android)](https://nazdridoy.github.io/ngpt/installation.html)
-[![Python Versions](https://img.shields.io/pypi/pyversions/ngpt.svg)](https://pypi.org/project/ngpt/)
 
 ![2025-04-23_16-18-01](https://github.com/user-attachments/assets/b8e58926-5165-4352-b48b-9f4a982da86e)
 
 
+## Features
+
+- ✅ **Versatile**: Use as a CLI tool, Python library, or CLI framework for building custom tools
+- 🪶 **Lightweight**: Minimal dependencies with everything you need included
+- 🔄 **API Flexibility**: Works with OpenAI, Ollama, Groq, Claude, Gemini, and any compatible endpoint
+- 💬 **Interactive Chat**: Continuous conversation with memory in modern UI
+- 📊 **Streaming Responses**: Real-time output for better user experience
+- 🔍 **Web Search**: Integrated with compatible API endpoints
+- 📥 **Stdin Processing**: Process piped content by using `{}` placeholder in prompts
+- 🎨 **Markdown Rendering**: Beautiful formatting of markdown and code with syntax highlighting
+- ⚡ **Real-time Markdown**: Stream responses with live updating syntax highlighting and formatting
+- ⚙️ **Multiple Configurations**: Cross-platform config system supporting different profiles
+- 💻 **Shell Command Generation**: OS-aware command execution
+- 🧠 **Text Rewriting**: Improve text quality while maintaining original tone and meaning
+- 🧩 **Clean Code Generation**: Output code without markdown or explanations
+- 📝 **Rich Multiline Editor**: Interactive multiline text input with syntax highlighting and intuitive controls
+- 📑 **Git Commit Messages**: AI-powered generation of conventional, detailed commit messages from git diffs
+- 🎭 **System Prompts**: Customize model behavior with custom system prompts
+- 📃 **Conversation Logging**: Save your conversations to text files for later reference
+- 🧰 **CLI Components**: Reusable components for building custom AI-powered command-line tools
+- 🔌 **Modular Architecture**: Well-structured codebase with clean separation of concerns
+- 🔄 **Provider Switching**: Easily switch between different LLM providers with a single parameter
+- 🚀 **Performance Optimized**: Fast response times and minimal resource usage
+
+See the [Feature Overview](https://nazdridoy.github.io/ngpt/overview.html) for more details.
+
+
 ## Table of Contents
 - [Quick Start](#quick-start)
 - [Features](#features)
@@ -109,34 +141,34 @@ ngpt --code --stream-prettify "function to calculate the Fibonacci sequence"
 ngpt --shell "list all files in the current directory"
 
 # Read from stdin and use the content in your prompt
-echo "What is this text about?" | ngpt --stdin "Analyze the following text: {}"
+echo "What is this text about?" | ngpt -p "Analyze the following text: {}"
 
 # Rewrite text to improve quality while preserving tone and meaning
-echo "your text" | ngpt --rewrite
+echo "your text" | ngpt -r
 
 # Rewrite text from a command-line argument
-ngpt --rewrite "your text to rewrite"
+ngpt -r "your text to rewrite"
 
 # Rewrite text from a file
-cat file.txt | ngpt --rewrite
+cat file.txt | ngpt -r
 
 # Generate AI-powered git commit messages for staged changes
-ngpt --gitcommsg
+ngpt -g
 
-# Generate commit message with context
-ngpt --gitcommsg -m "type:feat"
+# Generate commit message from staged changes with a context directive
+ngpt -g --preprompt "type:feat"
 
 # Process large diffs in chunks with recursive analysis
-ngpt --gitcommsg -r
+ngpt -g --rec-chunk
 
 # Process a diff file instead of staged changes
-ngpt --gitcommsg --diff /path/to/changes.diff
+ngpt -g --diff /path/to/changes.diff
 
 # Generate a commit message with logging for debugging
-ngpt --gitcommsg --log commit_log.txt
+ngpt -g --log commit_log.txt
 
 # Use interactive multiline editor to enter text to rewrite
-ngpt --rewrite
+ngpt -r
 
 # Display markdown responses with beautiful formatting
 ngpt --prettify "Explain markdown syntax with examples"
@@ -160,7 +192,7 @@ ngpt --interactive --log conversation.log
 ngpt --log "Tell me about quantum computing"
 
 # Process text from stdin using the {} placeholder
-cat README.md | ngpt --stdin "Summarize this document: {}"
+cat README.md | ngpt -p "Summarize this document: {}"
 
 # Use different model providers by specifying the provider name
 ngpt --provider Groq "Explain quantum computing"
@@ -172,32 +204,6 @@ ngpt --provider Ollama "Explain quantum physics" > ollama_response.txt
 
 For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).
 
-## Features
-
-- ✅ **Versatile**: Use as a CLI tool, Python library, or CLI framework for building custom tools
-- 🪶 **Lightweight**: Minimal dependencies with everything you need included
-- 🔄 **API Flexibility**: Works with OpenAI, Ollama, Groq, Claude, and any compatible endpoint
-- 💬 **Interactive Chat**: Continuous conversation with memory in modern UI
-- 📊 **Streaming Responses**: Real-time output for better user experience
-- 🔍 **Web Search**: Integrated with compatible API endpoints
-- 📥 **Stdin Processing**: Process piped content by using `{}` placeholder in prompts
-- 🎨 **Markdown Rendering**: Beautiful formatting of markdown and code with syntax highlighting
-- ⚡ **Real-time Markdown**: Stream responses with live updating syntax highlighting and formatting
-- ⚙️ **Multiple Configurations**: Cross-platform config system supporting different profiles
-- 💻 **Shell Command Generation**: OS-aware command execution
-- 🧠 **Text Rewriting**: Improve text quality while maintaining original tone and meaning
-- 🧩 **Clean Code Generation**: Output code without markdown or explanations
-- 📝 **Rich Multiline Editor**: Interactive multiline text input with syntax highlighting and intuitive controls
-- 📑 **Git Commit Messages**: AI-powered generation of conventional, detailed commit messages from git diffs
-- 🎭 **System Prompts**: Customize model behavior with custom system prompts
-- 📃 **Conversation Logging**: Save your conversations to text files for later reference
-- 🧰 **CLI Components**: Reusable components for building custom AI-powered command-line tools
-- 🔌 **Modular Architecture**: Well-structured codebase with clean separation of concerns
-- 🔄 **Provider Switching**: Easily switch between different LLM providers with a single parameter
-- 🚀 **Performance Optimized**: Fast response times and minimal resource usage
-
-See the [Feature Overview](https://nazdridoy.github.io/ngpt/overview.html) for more details.
-
 ## Documentation
 
 Comprehensive documentation, including API reference, usage guides, and examples, is available at:
@@ -432,120 +438,160 @@ For detailed information about building CLI tools with nGPT, see the [CLI Framew
 
 ### Command Line Options
 
-You can configure nGPT using the following options:
-
-#### Mode Options (Mutually Exclusive)
-
-| Option | Description |
-|--------|-------------|
-| `-i, --interactive` | Start an interactive chat session with conversation memory and special commands |
-| `-s, --shell` | Generate and execute shell commands appropriate for your operating system |
-| `-c, --code` | Generate clean code without markdown formatting or explanations |
-| `-t, --text` | Open interactive multiline editor for complex prompts with syntax highlighting |
-| `--stdin` | Read from stdin and use content with prompt. Use {} in prompt as placeholder for stdin content |
-| `--rewrite` | Rewrite text to improve quality while preserving original tone and meaning |
-| `--gitcommsg` | Generate AI-powered git commit messages from staged changes or diff files |
-
-#### Global Options
-
-| Option | Description |
-|--------|-------------|
-| `--api-key KEY` | API key for the service |
-| `--base-url URL` | Base URL for the API |
-| `--model MODEL` | Model to use |
-| `--web-search` | Enable web search capability (if your API endpoint supports it) |
-| `--temperature VALUE` | Set temperature (controls randomness, default: 0.7) |
-| `--top_p VALUE` | Set top_p (controls diversity, default: 1.0) |
-| `--max_tokens NUMBER` | Set maximum response length in tokens |
-| `--preprompt TEXT` | Set custom system prompt to control AI behavior |
-| `--language LANG` | Programming language to generate code in (for code mode, default: python) |
-| `--no-stream` | Return the whole response without streaming |
-| `--prettify` | Render markdown responses and code with syntax highlighting and formatting |
-| `--stream-prettify` | Enable streaming with markdown rendering (automatically uses Rich renderer) |
-| `--renderer {auto,rich,glow}` | Select which markdown renderer to use with --prettify (default: auto) |
-| `--log [FILE]` | Set filepath to log conversation to, or create a temporary log file if no path provided |
-
-#### Configuration Options
-
-| Option | Description |
-|--------|-------------|
-| `--config [PATH]` | Path to a custom config file or, if no value provided, enter interactive configuration mode |
-| `--config-index INDEX` | Index of the configuration to use or edit (default: 0) |
-| `--provider NAME` | Provider name to identify the configuration to use |
-| `--remove` | Remove the configuration at the specified index (requires --config and --config-index or --provider) |
-| `--show-config` | Show the current configuration(s) and exit |
-| `--all` | Show details for all configurations (requires --show-config) |
-| `--list-models` | List all available models for the current configuration and exit |
-| `--list-renderers` | Show available markdown renderers for use with --prettify |
-| `--cli-config [COMMAND]` | Manage CLI configuration (set, get, unset, list, help) |
-| `-v, --version` | Show version information and exit |
+```console
+❯ ngpt -h
+usage: ngpt [-h] [-v] [--language LANGUAGE] [--config [CONFIG]] [--config-index CONFIG_INDEX] [--provider PROVIDER]
+            [--remove] [--show-config] [--all] [--list-models] [--list-renderers] [--cli-config [COMMAND ...]]
+            [--api-key API_KEY] [--base-url BASE_URL] [--model MODEL] [--web-search] [--temperature TEMPERATURE]
+            [--top_p TOP_P] [--max_tokens MAX_TOKENS] [--log [FILE]] [--preprompt PREPROMPT] [--no-stream] [--prettify]
+            [--stream-prettify] [--renderer {auto,rich,glow}] [--rec-chunk] [--diff [FILE]] [--chunk-size CHUNK_SIZE]
+            [--analyses-chunk-size ANALYSES_CHUNK_SIZE] [--max-msg-lines MAX_MSG_LINES]
+            [--max-recursion-depth MAX_RECURSION_DEPTH] [-i | -s | -c | -t | -p | -r | -g]
+            [prompt]
+
+nGPT - Interact with AI language models via OpenAI-compatible APIs
+
+positional arguments::
+
+[PROMPT]                            The prompt to send
+
+options::
+
+-h, --help                          show this help message and exit
+-v, --version                       Show version information and exit
+--language LANGUAGE                 Programming language to generate code in (for code mode)
+
+Configuration Options::
+
+--config [CONFIG]                   Path to a custom config file or, if no value provided, enter interactive
+                                    configuration mode to create a new config
+--config-index CONFIG_INDEX         Index of the configuration to use or edit (default: 0)
+--provider PROVIDER                 Provider name to identify the configuration to use
+--remove                            Remove the configuration at the specified index (requires --config and
+                                    --config-index or --provider)
+--show-config                       Show the current configuration(s) and exit
+--all                               Show details for all configurations (requires --show-config)
+--list-models                       List all available models for the current configuration and exit
+--list-renderers                    Show available markdown renderers for use with --prettify
+--cli-config [COMMAND ...]          Manage CLI configuration (set, get, unset, list, help)
+
+Global Options::
+
+--api-key API_KEY                   API key for the service
+--base-url BASE_URL                 Base URL for the API
+--model MODEL                       Model to use
+--web-search                        Enable web search capability (Note: Your API endpoint must support this
+                                    feature)
+--temperature TEMPERATURE           Set temperature (controls randomness, default: 0.7)
+--top_p TOP_P                       Set top_p (controls diversity, default: 1.0)
+--max_tokens MAX_TOKENS             Set max response length in tokens
+--log [FILE]                        Set filepath to log conversation to, or create a temporary log file if no path
+                                    provided
+--preprompt PREPROMPT               Set custom system prompt to control AI behavior
+--no-stream                         Return the whole response without streaming
+--prettify                          Render markdown responses and code with syntax highlighting and formatting
+--stream-prettify                   Enable streaming with markdown rendering (automatically uses Rich renderer)
+--renderer {auto,rich,glow}         Select which markdown renderer to use with --prettify (auto, rich, or glow)
+
+Git Commit Message Options::
+
+--rec-chunk                         Process large diffs in chunks with recursive analysis if needed
+--diff [FILE]                       Use diff from specified file instead of staged changes. If used without a path,
+                                    uses the path from CLI config.
+--chunk-size CHUNK_SIZE             Number of lines per chunk when chunking is enabled (default: 200)
+--analyses-chunk-size ANALYSES_CHUNK_SIZE
+                                    Number of lines per chunk when recursively chunking analyses (default: 200)
+--max-msg-lines MAX_MSG_LINES       Maximum number of lines in commit message before condensing (default: 20)
+--max-recursion-depth MAX_RECURSION_DEPTH
+                                    Maximum recursion depth for commit message condensing (default: 3)
+
+Modes (mutually exclusive)::
+
+-i, --interactive                   Start an interactive chat session
+-s, --shell                         Generate and execute shell commands
+-c, --code                          Generate code
+-t, --text                          Enter multi-line text input (submit with Ctrl+D)
+-p, --pipe                          Read from stdin and use content with prompt. Use {} in prompt as placeholder
+                                    for stdin content
+-r, --rewrite                       Rewrite text from stdin to be more natural while preserving tone and meaning
+-g, --gitcommsg                     Generate AI-powered git commit messages from staged changes or diff file
+```
+
+> **Note**: For better visualization of conventional commit messages on GitHub, you can use the [GitHub Commit Labels](https://greasyfork.org/en/scripts/526153-github-commit-labels) userscript, which adds colorful labels to your commits.
 
 For a complete reference of all available options, see the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).
 
 ### CLI Configuration
 
-NGPT offers a CLI configuration system that allows you to set default values for command-line options:
-
-```bash
-# Set default options
-ngpt --cli-config set language typescript
-ngpt --cli-config set temperature 0.9
-ngpt --cli-config set prettify true
-
-# View current settings
-ngpt --cli-config get
-
-# Get a specific setting
-ngpt --cli-config get language
-
-# Remove a setting
-ngpt --cli-config unset prettify
+NGPT offers a CLI configuration system that allows you to set default values for command-line options. This is especially useful when you:
+
+- Repeatedly use the same provider or model
+- Have preferred settings for specific tasks
+- Want to create different workflows based on context
+
+For example, setting your preferred language for code generation or temperature value means you won't have to specify these parameters each time:
+
+```console
+
+❯ ngpt --cli-config help
+
+CLI Configuration Help:
+  Command syntax:
+    ngpt --cli-config help                - Show this help message
+    ngpt --cli-config set OPTION VALUE    - Set a default value for OPTION
+    ngpt --cli-config get OPTION          - Get the current value of OPTION
+    ngpt --cli-config get                 - Show all CLI configuration settings
+    ngpt --cli-config unset OPTION        - Remove OPTION from configuration
+    ngpt --cli-config list                - List all available options
+
+  Available options:
+    General options (all modes):
+      config-index - int (default: 0) [exclusive with: provider]
+      log - str 
+      max_tokens - int 
+      no-stream - bool (default: False) [exclusive with: prettify, stream-prettify]
+      preprompt - str 
+      prettify - bool (default: False) [exclusive with: no-stream, stream-prettify]
+      provider - str  [exclusive with: config-index]
+      renderer - str (default: auto)
+      stream-prettify - bool (default: False) [exclusive with: no-stream, prettify]
+      temperature - float (default: 0.7)
+      top_p - float (default: 1.0)
+      web-search - bool (default: False)
+
+    Options for Code generation mode:
+      language - str (default: python)
+
+    Options for Git commit message mode:
+      analyses-chunk-size - int (default: 200)
+      chunk-size - int (default: 200)
+      diff - str 
+      max-msg-lines - int (default: 20)
+      max-recursion-depth - int (default: 3)
+      rec-chunk - bool (default: False)
+
+  Example usage:
+    ngpt --cli-config set language java        - Set default language to java for code generation
+    ngpt --cli-config set provider Gemini      - Set Gemini as your default provider
+    ngpt --cli-config set temperature 0.9      - Set default temperature to 0.9
+    ngpt --cli-config set no-stream true       - Disable streaming by default
+    ngpt --cli-config set recursive-chunk true - Enable recursive chunking for git commit messages
+    ngpt --cli-config set diff /path/to/file.diff - Set default diff file for git commit messages
+    ngpt --cli-config get temperature          - Check the current temperature setting
+    ngpt --cli-config get                      - Show all current CLI settings
+    ngpt --cli-config unset language           - Remove language setting
+
+  Notes:
+    - CLI configuration is stored in:
+      • Linux: ~/.config/ngpt/ngpt-cli.conf
+      • macOS: ~/Library/Application Support/ngpt/ngpt-cli.conf
+      • Windows: %APPDATA%\ngpt\ngpt-cli.conf
+    - Settings are applied based on context (e.g., language only applies to code generation mode)
+    - Command-line arguments always override CLI configuration
+    - Some options are mutually exclusive and will not be applied together
 
-# List all available options
-ngpt --cli-config list
-
-# Show help information
-ngpt --cli-config help
-```
-
-Key features of CLI configuration:
-- **Context-Aware**: Settings are applied based on the current command mode (e.g., `language` only applies in code generation mode `-c`).
-- **Priority**: When determining option values, NGPT uses the following priority order (highest to lowest):
-  1. Command-line arguments
-  2. Environment variables
-  3. CLI configuration (ngpt-cli.conf)
-  4. Main configuration file (ngpt.conf)
-  5. Default values
-- **Mutual Exclusivity**: For options like `no-stream`, `prettify`, and `stream-prettify`, setting one to `True` automatically sets the others to `False` in the configuration file, ensuring consistency.
-- **Smart Selection**: The `provider` setting is used to select which configuration profile to use, offering a persistent way to select your preferred API.
-
-Available options include:
-- General options (all modes): `provider`, `temperature`, `top_p`, `max_tokens`, `preprompt`, `renderer`, `config-index`, `web-search`
-- Mode-specific options: `language` (code mode only), `log` (interactive and text modes)
-- Mutually exclusive options: `no-stream`, `prettify`, `stream-prettify`
-
-#### Practical Examples
-
-```bash
-# Set Gemini as your default provider
-ngpt --cli-config set provider Gemini
-# Now you can run commands without specifying --provider
-ngpt "Explain quantum computing"
-
-# Configure code generation for TypeScript
-ngpt --cli-config set language typescript
-# Now in code mode, TypeScript will be used by default
-ngpt -c "Write a function to sort an array"
-
-# Set a higher temperature for more creative responses
-ngpt --cli-config set temperature 0.9
 ```
 
-The CLI configuration is stored in:
-- Linux: `~/.config/ngpt/ngpt-cli.conf`
-- macOS: `~/Library/Application Support/ngpt/ngpt-cli.conf`
-- Windows: `%APPDATA%\ngpt\ngpt-cli.conf`
-
 For more details, see the [CLI Configuration Guide](https://nazdridoy.github.io/ngpt/usage/cli_config.html).
 
 ### Interactive Configuration
@@ -642,4 +688,4 @@ Please check the [CONTRIBUTING.md](CONTRIBUTING.md) file for detailed guidelines
 
 ## License
 
-This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.

{ngpt-2.16.7.dist-info → ngpt-3.0.1.dist-info}/RECORD

@@ -2,26 +2,26 @@ ngpt/__init__.py,sha256=kpKhViLakwMdHZkuLht2vWcjt0uD_5gR33gvMhfXr6w,664
 ngpt/__main__.py,sha256=j3eFYPOtCCFBOGh7NK5IWEnADnTMMSEB9GLyIDoW724,66
 ngpt/client.py,sha256=rLgDPmJe8_yi13-XUiHJ45z54rJVrupxWmeb-fQZGF4,15129
 ngpt/cli/__init__.py,sha256=hebbDSMGiOd43YNnQP67uzr67Ue6rZPwm2czynr5iZY,43
-ngpt/cli/args.py,sha256=VJM6ySMnVrXgKaGb7Qb3AQPYxcQCv3FfCI4x8YkAsLQ,11534
+ngpt/cli/args.py,sha256=XQvofZs_WkbgUto3Dbx7Yw-AmPAQHh8kdHUe3uWy8w4,11382
 ngpt/cli/config_manager.py,sha256=NQQcWnjUppAAd0s0p9YAf8EyKS1ex5-0EB4DvKdB4dk,3662
 ngpt/cli/formatters.py,sha256=HBYGlx_7eoAKyzfy0Vq5L0yn8yVKjngqYBukMmXCcz0,9401
 ngpt/cli/interactive.py,sha256=oLflfYVSX_NdYb5D8BsEeYr2m_6yWw06Rw-BS5tLqkI,12923
-ngpt/cli/main.py,sha256=6GO4r9e9su7FFukj9JeVmJt1bJsqPOJBj6xo3iyMZXU,28911
+ngpt/cli/main.py,sha256=rIGbsr1wll4fJhAmPx8C9fCJYlhKijdHqal9e3NC2I8,28908
 ngpt/cli/renderers.py,sha256=yYt3b_cWUYckfgLQ1wkEiQCnq5v5m7hfn5PWxHJzR9Y,12422
 ngpt/cli/ui.py,sha256=m8qtd4cCSHBGHPUlHVdBEfun1G1Se4vLKTSgnS7QOKE,6775
 ngpt/cli/modes/__init__.py,sha256=R3aO662RIzWEOvr3moTrEI8Tpg0zDDyMGGh1-OxiRgM,285
-ngpt/cli/modes/chat.py,sha256=-g8hMHkn9Dv3iGFZvbXXFQwG8KsXEgngr6Si9AUdQXE,5701
+ngpt/cli/modes/chat.py,sha256=ULSIFach3Namb3FQBhgACxhHXME-fX7bLBDum9JQfks,5699
 ngpt/cli/modes/code.py,sha256=1EeiooyNe1jvTyNu6r0J9xY34QXb2uBQKPeNca-DrRI,5734
-ngpt/cli/modes/gitcommsg.py,sha256=Bhgg9UArrfRUwosgVlNLUB7i1B8j-1ngpkmCm5iZBkM,46786
+ngpt/cli/modes/gitcommsg.py,sha256=rsfMoeOupmNp-5p5fsMSPAf18BbzXWq-4PF2HjEz6SY,46991
 ngpt/cli/modes/rewrite.py,sha256=iEMn6i6cuaxOiKq886Lsh961riCmPj5K1mXVQeT2Z7k,10112
 ngpt/cli/modes/shell.py,sha256=QkprnOxMMTg2v5DIwcofDnnr3JPNfuk-YgSQaae5Xps,3311
 ngpt/cli/modes/text.py,sha256=z08xaW2r0XzyunUzBhwZKqnwPjyRol_CSazjLygmLRs,4514
 ngpt/utils/__init__.py,sha256=E46suk2-QgYBI0Qrs6WXOajOUOebF3ETAFY7ah8DTWs,942
-ngpt/utils/cli_config.py,sha256=tQxR3a2iXyc5TfRBPQHSUXPInO2dv_zTPGn04eWfmoo,11285
+ngpt/utils/cli_config.py,sha256=IlHnOEEGpLoGZInynM778wgpxLVcJ_STKWxg2Ypvir4,11196
 ngpt/utils/config.py,sha256=WYOk_b1eiYjo6hpV3pfXr2RjqhOnmKqwZwKid1T41I4,10363
 ngpt/utils/log.py,sha256=f1jg2iFo35PAmsarH8FVL_62plq4VXH0Mu2QiP6RJGw,15934
-ngpt-2.16.7.dist-info/METADATA,sha256=VWaC8qsuVQS5Qb4ZwDB5lo-7ToRmCBOCx_XYLMEdMrE,25460
-ngpt-2.16.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ngpt-2.16.7.dist-info/entry_points.txt,sha256=SqAAvLhMrsEpkIr4YFRdUeyuXQ9o0IBCeYgE6AVojoI,44
-ngpt-2.16.7.dist-info/licenses/LICENSE,sha256=mQkpWoADxbHqE0HRefYLJdm7OpdrXBr3vNv5bZ8w72M,1065
-ngpt-2.16.7.dist-info/RECORD,,
+ngpt-3.0.1.dist-info/METADATA,sha256=6YOossV8zjUDK_cEn0UEE05frHrzsz4F46-tJ_lGCWk,28821
+ngpt-3.0.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ngpt-3.0.1.dist-info/entry_points.txt,sha256=SqAAvLhMrsEpkIr4YFRdUeyuXQ9o0IBCeYgE6AVojoI,44
+ngpt-3.0.1.dist-info/licenses/LICENSE,sha256=mQkpWoADxbHqE0HRefYLJdm7OpdrXBr3vNv5bZ8w72M,1065
+ngpt-3.0.1.dist-info/RECORD,,