ngpt 2.2.0__py3-none-any.whl → 2.3.1__py3-none-any.whl

ngpt/cli.py

@@ -5,6 +5,246 @@ from .client import NGPTClient
 from .config import load_config, get_config_path, load_configs, add_config_entry, remove_config_entry
 from . import __version__
 
+# ANSI color codes for terminal output
+COLORS = {
+    "reset": "\033[0m",
+    "bold": "\033[1m",
+    "cyan": "\033[36m",
+    "green": "\033[32m", 
+    "yellow": "\033[33m",
+    "blue": "\033[34m",
+    "magenta": "\033[35m",
+    "gray": "\033[90m",
+    "bg_blue": "\033[44m",
+    "bg_cyan": "\033[46m"
+}
+
+# Check if ANSI colors are supported
+def supports_ansi_colors():
+    """Check if the current terminal supports ANSI colors."""
+    import os
+    import sys
+    
+    # If not a TTY, probably redirected, so no color
+    if not sys.stdout.isatty():
+        return False
+        
+    # Windows specific checks
+    if sys.platform == "win32":
+        try:
+            # Windows 10+ supports ANSI colors in cmd/PowerShell
+            import ctypes
+            kernel32 = ctypes.windll.kernel32
+            
+            # Try to enable ANSI color support
+            kernel32.SetConsoleMode(kernel32.GetStdHandle(-11), 7)
+            
+            # Check if TERM_PROGRAM is set (WSL/ConEmu/etc.)
+            if os.environ.get('TERM_PROGRAM') or os.environ.get('WT_SESSION'):
+                return True
+                
+            # Check Windows version - 10+ supports ANSI natively
+            winver = sys.getwindowsversion()
+            if winver.major >= 10:
+                return True
+                
+            return False
+        except Exception:
+            return False
+    
+    # Most UNIX systems support ANSI colors
+    return True
+
+# Initialize color support
+HAS_COLOR = supports_ansi_colors()
+
+# If we're on Windows, use brighter colors that work better in PowerShell
+if sys.platform == "win32" and HAS_COLOR:
+    COLORS["magenta"] = "\033[95m"  # Bright magenta for metavars
+    COLORS["cyan"] = "\033[96m"     # Bright cyan for options
+
+# If no color support, use empty color codes
+if not HAS_COLOR:
+    for key in COLORS:
+        COLORS[key] = ""
+
+# Custom help formatter with color support
+class ColoredHelpFormatter(argparse.HelpFormatter):
+    """Help formatter that properly handles ANSI color codes without breaking alignment."""
+    
+    def __init__(self, prog):
+        # Import modules needed for terminal size detection
+        import re
+        import textwrap
+        import shutil
+        
+        # Get terminal size for dynamic width adjustment
+        try:
+            self.term_width = shutil.get_terminal_size().columns
+        except:
+            self.term_width = 80  # Default if we can't detect terminal width
+        
+        # Calculate dynamic layout values based on terminal width
+        self.formatter_width = self.term_width - 2  # Leave some margin
+        
+        # For very wide terminals, limit the width to maintain readability
+        if self.formatter_width > 120:
+            self.formatter_width = 120
+            
+        # Calculate help position based on terminal width (roughly 1/3 of width)
+        self.help_position = min(max(20, int(self.term_width * 0.33)), 36)
+        
+        # Initialize the parent class with dynamic values
+        super().__init__(prog, max_help_position=self.help_position, width=self.formatter_width)
+        
+        # Calculate wrap width based on remaining space after help position
+        self.wrap_width = self.formatter_width - self.help_position - 5
+        
+        # Set up the text wrapper for help text
+        self.ansi_escape = re.compile(r'\x1B(?:[@-Z\\-_]|\[[0-?]*[ -/]*[@-~])')
+        self.wrapper = textwrap.TextWrapper(width=self.wrap_width)
+        
+    def _strip_ansi(self, s):
+        """Strip ANSI escape sequences for width calculations"""
+        return self.ansi_escape.sub('', s)
+        
+    def _colorize(self, text, color, bold=False):
+        """Helper to consistently apply color with optional bold"""
+        if bold:
+            return f"{COLORS['bold']}{COLORS[color]}{text}{COLORS['reset']}"
+        return f"{COLORS[color]}{text}{COLORS['reset']}"
+        
+    def _format_action_invocation(self, action):
+        if not action.option_strings:
+            # For positional arguments
+            metavar = self._format_args(action, action.dest.upper())
+            return self._colorize(metavar, 'cyan', bold=True)
+        else:
+            # For optional arguments with different color for metavar
+            if action.nargs != argparse.SUPPRESS:
+                default = self._get_default_metavar_for_optional(action)
+                args_string = self._format_args(action, default)
+                
+                # Color option name and metavar differently
+                option_part = ', '.join(action.option_strings)
+                colored_option = self._colorize(option_part, 'cyan', bold=True)
+                
+                if args_string:
+                    # Make metavars more visible with brackets and color
+                    # If HAS_COLOR is False, brackets will help in PowerShell
+                    if not HAS_COLOR:
+                        # Add brackets to make metavars stand out even without color
+                        formatted_args = f"<{args_string}>"
+                    else:
+                        # Use color for metavar
+                        formatted_args = self._colorize(args_string, 'magenta')
+                    
+                    return f"{colored_option} {formatted_args}"
+                else:
+                    return colored_option
+            else:
+                return self._colorize(', '.join(action.option_strings), 'cyan', bold=True)
+        
+    def _format_usage(self, usage, actions, groups, prefix):
+        usage_text = super()._format_usage(usage, actions, groups, prefix)
+        
+        # Replace "usage:" with colored version
+        colored_usage = self._colorize("usage:", 'green', bold=True)
+        usage_text = usage_text.replace("usage:", colored_usage)
+        
+        # We won't color metavars in usage text as it breaks the formatting
+        # Just return with the colored usage prefix
+        return usage_text
+    
+    def _join_parts(self, part_strings):
+        """Override to fix any potential formatting issues with section joins"""
+        return '\n'.join([part for part in part_strings if part])
+        
+    def start_section(self, heading):
+        # Remove the colon as we'll add it with color
+        if heading.endswith(':'):
+            heading = heading[:-1]
+        heading_text = f"{self._colorize(heading, 'yellow', bold=True)}:"
+        super().start_section(heading_text)
+            
+    def _get_help_string(self, action):
+        # Add color to help strings
+        help_text = action.help
+        if help_text:
+            return help_text.replace('(default:', f"{COLORS['gray']}(default:") + COLORS['reset']
+        return help_text
+        
+    def _wrap_help_text(self, text, initial_indent="", subsequent_indent="  "):
+        """Wrap long help text to prevent overflow"""
+        if not text:
+            return text
+            
+        # Strip ANSI codes for width calculation
+        clean_text = self._strip_ansi(text)
+        
+        # If the text is already short enough, return it as is
+        if len(clean_text) <= self.wrap_width:
+            return text
+            
+        # Handle any existing ANSI codes
+        has_ansi = text != clean_text
+        wrap_text = clean_text
+        
+        # Wrap the text
+        lines = self.wrapper.wrap(wrap_text)
+        
+        # Add indentation to all but the first line
+        wrapped = lines[0]
+        for line in lines[1:]:
+            wrapped += f"\n{subsequent_indent}{line}"
+            
+        # Re-add the ANSI codes if they were present
+        if has_ansi and text.endswith(COLORS['reset']):
+            wrapped += COLORS['reset']
+            
+        return wrapped
+        
+    def _format_action(self, action):
+        # For subparsers, just return the regular formatting
+        if isinstance(action, argparse._SubParsersAction):
+            return super()._format_action(action)
+            
+        # Get the action header with colored parts (both option names and metavars)
+        # The coloring is now done in _format_action_invocation
+        action_header = self._format_action_invocation(action)
+        
+        # Format help text
+        help_text = self._expand_help(action)
+        
+        # Get the raw lengths without ANSI codes for formatting
+        raw_header_len = len(self._strip_ansi(action_header))
+        
+        # Calculate the indent for the help text
+        help_position = min(self._action_max_length + 2, self._max_help_position)
+        help_indent = ' ' * help_position
+        
+        # If the action header is too long, put help on the next line
+        if raw_header_len > help_position:
+            # An action header that's too long gets a line break
+            # Wrap the help text with proper indentation
+            wrapped_help = self._wrap_help_text(help_text, subsequent_indent=help_indent)
+            line = f"{action_header}\n{help_indent}{wrapped_help}"
+        else:
+            # Standard formatting with proper spacing
+            padding = ' ' * (help_position - raw_header_len)
+            # Wrap the help text with proper indentation
+            wrapped_help = self._wrap_help_text(help_text, subsequent_indent=help_indent)
+            line = f"{action_header}{padding}{wrapped_help}"
+            
+        # Handle subactions
+        if action.help is argparse.SUPPRESS:
+            return line
+            
+        if not action.help:
+            return line
+            
+        return line
+
 # Optional imports for enhanced UI
 try:
     from prompt_toolkit import prompt as pt_prompt
@@ -26,81 +266,67 @@ except ImportError:
 
 def show_config_help():
     """Display help information about configuration."""
-    print("\nConfiguration Help:")
-    print("  1. Create a config file at one of these locations:")
+    print(f"\n{COLORS['green']}{COLORS['bold']}Configuration Help:{COLORS['reset']}")
+    print(f"  1. {COLORS['cyan']}Create a config file at one of these locations:{COLORS['reset']}")
     if sys.platform == "win32":
-        print(f"     - %APPDATA%\\ngpt\\ngpt.conf")
+        print(f"     - {COLORS['yellow']}%APPDATA%\\ngpt\\ngpt.conf{COLORS['reset']}")
     elif sys.platform == "darwin":
-        print(f"     - ~/Library/Application Support/ngpt/ngpt.conf")
+        print(f"     - {COLORS['yellow']}~/Library/Application Support/ngpt/ngpt.conf{COLORS['reset']}")
     else:
-        print(f"     - ~/.config/ngpt/ngpt.conf")
+        print(f"     - {COLORS['yellow']}~/.config/ngpt/ngpt.conf{COLORS['reset']}")
     
-    print("  2. Format your config file as JSON:")
-    print("""     [
-       {
+    print(f"  2. {COLORS['cyan']}Format your config file as JSON:{COLORS['reset']}")
+    print(f"""{COLORS['yellow']}     [
+       {{
          "api_key": "your-api-key-here",
          "base_url": "https://api.openai.com/v1/",
          "provider": "OpenAI",
          "model": "gpt-3.5-turbo"
-       },
-       {
+       }},
+       {{
          "api_key": "your-second-api-key",
          "base_url": "http://localhost:1337/v1/",
          "provider": "Another Provider",
          "model": "different-model"
-       }
-     ]""")
-    
-    print("  3. Or set environment variables:")
-    print("     - OPENAI_API_KEY")
-    print("     - OPENAI_BASE_URL")
-    print("     - OPENAI_MODEL")
-    
-    print("  4. Or provide command line arguments:")
-    print("     ngpt --api-key your-key --base-url https://api.example.com --model your-model \"Your prompt\"")
-    
-    print("  5. Use --config-index to specify which configuration to use or edit:")
-    print("     ngpt --config-index 1 \"Your prompt\"")
-    
-    print("  6. Use --config without arguments to add a new configuration:")
-    print("     ngpt --config")
-    print("     Or specify an index to edit an existing configuration:")
-    print("     ngpt --config --config-index 1")
-    print("  7. Remove a configuration at a specific index:")
-    print("     ngpt --config --remove --config-index 1")
-    print("  8. List available models for the current configuration:")
-    print("     ngpt --list-models")
+       }}
+     ]{COLORS['reset']}""")
+    
+    print(f"  3. {COLORS['cyan']}Or set environment variables:{COLORS['reset']}")
+    print(f"     - {COLORS['yellow']}OPENAI_API_KEY{COLORS['reset']}")
+    print(f"     - {COLORS['yellow']}OPENAI_BASE_URL{COLORS['reset']}")
+    print(f"     - {COLORS['yellow']}OPENAI_MODEL{COLORS['reset']}")
+    
+    print(f"  4. {COLORS['cyan']}Or provide command line arguments:{COLORS['reset']}")
+    print(f"     {COLORS['yellow']}ngpt --api-key your-key --base-url https://api.example.com --model your-model \"Your prompt\"{COLORS['reset']}")
+    
+    print(f"  5. {COLORS['cyan']}Use --config-index to specify which configuration to use or edit:{COLORS['reset']}")
+    print(f"     {COLORS['yellow']}ngpt --config-index 1 \"Your prompt\"{COLORS['reset']}")
+    
+    print(f"  6. {COLORS['cyan']}Use --config without arguments to add a new configuration:{COLORS['reset']}")
+    print(f"     {COLORS['yellow']}ngpt --config{COLORS['reset']}")
+    print(f"     Or specify an index to edit an existing configuration:")
+    print(f"     {COLORS['yellow']}ngpt --config --config-index 1{COLORS['reset']}")
+    print(f"  7. {COLORS['cyan']}Remove a configuration at a specific index:{COLORS['reset']}")
+    print(f"     {COLORS['yellow']}ngpt --config --remove --config-index 1{COLORS['reset']}")
+    print(f"  8. {COLORS['cyan']}List available models for the current configuration:{COLORS['reset']}")
+    print(f"     {COLORS['yellow']}ngpt --list-models{COLORS['reset']}")
 
 def check_config(config):
     """Check config for common issues and provide guidance."""
     if not config.get("api_key"):
-        print("Error: API key is not set.")
+        print(f"{COLORS['yellow']}{COLORS['bold']}Error: API key is not set.{COLORS['reset']}")
         show_config_help()
         return False
         
     # Check for common URL mistakes
     base_url = config.get("base_url", "")
     if base_url and not (base_url.startswith("http://") or base_url.startswith("https://")):
-        print(f"Warning: Base URL '{base_url}' doesn't start with http:// or https://")
+        print(f"{COLORS['yellow']}Warning: Base URL '{base_url}' doesn't start with http:// or https://{COLORS['reset']}")
     
     return True
 
-def interactive_chat_session(client, web_search=False, no_stream=False, temperature=0.7, top_p=1.0, max_length=None, log_file=None):
+def interactive_chat_session(client, web_search=False, no_stream=False, temperature=0.7, top_p=1.0, max_length=None, log_file=None, preprompt=None):
     """Run an interactive chat session with conversation history."""
-    # Define ANSI color codes for terminal output
-    COLORS = {
-        "reset": "\033[0m",
-        "bold": "\033[1m",
-        "cyan": "\033[36m",
-        "green": "\033[32m", 
-        "yellow": "\033[33m",
-        "blue": "\033[34m",
-        "magenta": "\033[35m",
-        "gray": "\033[90m",
-        "bg_blue": "\033[44m",
-        "bg_cyan": "\033[46m"
-    }
-    
     # Get terminal width for better formatting
     try:
         term_width = shutil.get_terminal_size().columns
@@ -146,11 +372,16 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
         print(f"\n{separator}\n")
     
     # Initialize conversation history
-    system_prompt = "You are a helpful assistant."
+    system_prompt = preprompt if preprompt else "You are a helpful assistant."
     conversation = []
     system_message = {"role": "system", "content": system_prompt}
     conversation.append(system_message)
     
+    # Log system prompt if logging is enabled
+    if log_handle and preprompt:
+        log_handle.write(f"System: {system_prompt}\n\n")
+        log_handle.flush()
+    
     # Initialize prompt_toolkit history
     prompt_history = InMemoryHistory() if HAS_PROMPT_TOOLKIT else None
     
@@ -295,10 +526,25 @@ def interactive_chat_session(client, web_search=False, no_stream=False, temperat
             log_handle.close()
 
 def main():
-    parser = argparse.ArgumentParser(description="nGPT - A CLI tool for interacting with OpenAI-compatible APIs, supporting both official and self-hosted LLM endpoints")
+    # Colorize description - use a shorter description to avoid line wrapping issues
+    description = f"{COLORS['cyan']}{COLORS['bold']}nGPT{COLORS['reset']} - Interact with AI language models via OpenAI-compatible APIs"
+    parser = argparse.ArgumentParser(description=description, formatter_class=ColoredHelpFormatter)
+    
+    # Add custom error method with color
+    original_error = parser.error
+    def error_with_color(message):
+        parser.print_usage(sys.stderr)
+        parser.exit(2, f"{COLORS['bold']}{COLORS['yellow']}error: {COLORS['reset']}{message}\n")
+    parser.error = error_with_color
+    
+    # Custom version action with color
+    class ColoredVersionAction(argparse.Action):
+        def __call__(self, parser, namespace, values, option_string=None):
+            print(f"{COLORS['green']}{COLORS['bold']}nGPT{COLORS['reset']} version {COLORS['yellow']}{__version__}{COLORS['reset']}")
+            parser.exit()
     
     # Version flag
-    parser.add_argument('-v', '--version', action='version', version=f'nGPT {__version__}', help='Show version information and exit')
+    parser.add_argument('-v', '--version', action=ColoredVersionAction, nargs=0, help='Show version information and exit')
     
     # Config options
     config_group = parser.add_argument_group('Configuration Options')
@@ -326,6 +572,8 @@ def main():
                       help='Set max response length in tokens')
     global_group.add_argument('--log', metavar='FILE',
                       help='Set filepath to log conversation to (For interactive modes)')
+    global_group.add_argument('--preprompt', 
+                      help='Set preprompt')
     
     # Mode flags (mutually exclusive)
     mode_group = parser.add_argument_group('Modes (mutually exclusive)')
@@ -486,7 +734,7 @@ def main():
             # Interactive chat mode
             interactive_chat_session(client, web_search=args.web_search, no_stream=args.no_stream,
                                    temperature=args.temperature, top_p=args.top_p, 
-                                   max_length=args.max_length, log_file=args.log)
+                                   max_length=args.max_length, log_file=args.log, preprompt=args.preprompt)
         elif args.shell:
             if args.prompt is None:
                 try:
@@ -543,7 +791,6 @@ def main():
                 print(f"\nGenerated code:\n{generated_code}")
             
         elif args.text:
-            # Multi-line text input mode
             if args.prompt is not None:
                 prompt = args.prompt
             else:
@@ -651,9 +898,18 @@ def main():
                     sys.exit(130)
             
             print("\nSubmission successful. Waiting for response...")
+            
+            # Create messages array with preprompt if available
+            messages = None
+            if args.preprompt:
+                messages = [
+                    {"role": "system", "content": args.preprompt},
+                    {"role": "user", "content": prompt}
+                ]
+                
             response = client.chat(prompt, stream=not args.no_stream, web_search=args.web_search,
                                temperature=args.temperature, top_p=args.top_p,
-                               max_tokens=args.max_length)
+                               max_tokens=args.max_length, messages=messages)
             if args.no_stream and response:
                 print(response)
             
@@ -668,9 +924,18 @@ def main():
                     sys.exit(130)
             else:
                 prompt = args.prompt
+                
+            # Create messages array with preprompt if available
+            messages = None
+            if args.preprompt:
+                messages = [
+                    {"role": "system", "content": args.preprompt},
+                    {"role": "user", "content": prompt}
+                ]
+                
             response = client.chat(prompt, stream=not args.no_stream, web_search=args.web_search,
                                temperature=args.temperature, top_p=args.top_p,
-                               max_tokens=args.max_length)
+                               max_tokens=args.max_length, messages=messages)
             if args.no_stream and response:
                 print(response)
     

{ngpt-2.2.0.dist-info → ngpt-2.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 2.2.0
+Version: 2.3.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
@@ -81,8 +81,16 @@ ngpt --shell "list all files in the current directory"
 
 # Use multiline editor for complex prompts
 ngpt --text
+
+# Use custom system prompt
+ngpt --preprompt "You are a Linux expert" "How do I find large files?"
+
+# Log your conversation to a file
+ngpt --interactive --log conversation.log
 ```
 
+For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).
+
 ## Features
 
 - ✅ **Dual Mode**: Use as a CLI tool or import as a Python library
@@ -95,6 +103,10 @@ ngpt --text
 - 💻 **Shell Command Generation**: OS-aware command execution
 - 🧩 **Clean Code Generation**: Output code without markdown or explanations
 - 📝 **Rich Multiline Editor**: Interactive multiline text input with syntax highlighting and intuitive controls
+- 🎭 **System Prompts**: Customize model behavior with custom system prompts
+- 📃 **Conversation Logging**: Save your conversations to text files for later reference
+
+See the [Feature Overview](https://nazdridoy.github.io/ngpt/overview.html) for more details.
 
 ## Documentation
 
@@ -102,6 +114,13 @@ Comprehensive documentation, including API reference, usage guides, and examples
 
 **[https://nazdridoy.github.io/ngpt/](https://nazdridoy.github.io/ngpt/)**
 
+Key documentation sections:
+- [Installation Guide](https://nazdridoy.github.io/ngpt/installation.html)
+- [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html)
+- [Library Usage Guide](https://nazdridoy.github.io/ngpt/usage/library_usage.html)
+- [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration.html)
+- [Examples & Tutorials](https://nazdridoy.github.io/ngpt/examples/basic.html)
+
 ## Installation
 
 ```bash
@@ -110,6 +129,8 @@ pip install ngpt
 
 Requires Python 3.8 or newer.
 
+For detailed installation instructions, see the [Installation Guide](https://nazdridoy.github.io/ngpt/installation.html).
+
 ## Usage
 
 ### As a CLI Tool
@@ -121,6 +142,12 @@ ngpt "Hello, how are you?"
 # Interactive chat session with conversation history
 ngpt -i
 
+# Log conversation to a file
+ngpt --interactive --log conversation.log
+
+# Use custom system prompt to guide AI behavior
+ngpt --preprompt "You are a Python programming tutor" "Explain decorators"
+
 # Show version information
 ngpt -v
 
@@ -157,6 +184,8 @@ ngpt -c "create a python function that calculates fibonacci numbers"
 ngpt -t
 ```
 
+For more CLI examples and detailed usage information, see the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).
+
 ### As a Library
 
 ```python
@@ -189,6 +218,8 @@ command = client.generate_shell_command("list all files")
 code = client.generate_code("create a python function that calculates fibonacci numbers")
 ```
 
+For more library examples and advanced usage, see the [Library Usage Guide](https://nazdridoy.github.io/ngpt/usage/library_usage.html).
+
 #### Advanced Library Usage
 
 ```python
@@ -215,6 +246,8 @@ code = client.generate_code("function that converts Celsius to Fahrenheit")
 print(code)
 ```
 
+For advanced usage patterns and integrations, check out the [Advanced Examples](https://nazdridoy.github.io/ngpt/examples/advanced.html).
+
 ## Configuration
 
 ### Command Line Options
@@ -232,6 +265,8 @@ You can configure the client using the following options:
 | `--temperature` | Set temperature (controls randomness, default: 0.7) |
 | `--top_p` | Set top_p (controls diversity, default: 1.0) |
 | `--max_length` | Set maximum response length in tokens |
+| `--preprompt` | Set custom system prompt to control AI behavior |
+| `--log` | Set filepath to log conversation to (for interactive modes) |
 | `--config` | Path to a custom configuration file or, when used without a value, enters interactive configuration mode |
 | `--config-index` | Index of the configuration to use (default: 0) |
 | `--remove` | Remove the configuration at the specified index (requires --config and --config-index) |
@@ -243,6 +278,8 @@ You can configure the client using the following options:
 | `-t, --text` | Open interactive multiline editor for complex prompts |
 | `-v, --version` | Show version information |
 
+For a complete reference of all available options, see the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).
+
 ### Interactive Configuration
 
 The `--config` option without arguments enters interactive configuration mode, allowing you to add or edit configurations:
@@ -264,6 +301,8 @@ In interactive mode:
 - For security, your API key is not displayed when editing configurations
 - When removing a configuration, you'll be asked to confirm before deletion
 
+For more details on configuring nGPT, see the [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration.html).
+
 ### Configuration File
 
 nGPT uses a configuration file stored in the standard user config directory for your operating system:
@@ -298,6 +337,8 @@ The configuration file uses a JSON list format, allowing you to store multiple c
 ]
 ```
 
+For details on the configuration file format and structure, see the [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration.html).
+
 ### Configuration Priority
 
 nGPT determines configuration values in the following order (highest priority first):

ngpt-2.3.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+ngpt/__init__.py,sha256=ehInP9w0MZlS1vZ1g6Cm4YE1ftmgF72CnEddQ3Le9n4,368
+ngpt/cli.py,sha256=y3LzVYJnlAt570dFniUchPa3oUuD4MaDbGl6fGfH_ac,43255
+ngpt/client.py,sha256=75xmzO7e9wQ7y_LzZCacg3mkZdheewcBxB6moPftqYw,13067
+ngpt/config.py,sha256=BF0G3QeiPma8l7EQyc37bR7LWZog7FHJQNe7uj9cr4w,6896
+ngpt-2.3.1.dist-info/METADATA,sha256=M7YPXzIzpSJRfHI8QKt4VvDmgoDaT2WY3P6tk_DRrtg,13535
+ngpt-2.3.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ngpt-2.3.1.dist-info/entry_points.txt,sha256=1cnAMujyy34DlOahrJg19lePSnb08bLbkUs_kVerqdk,39
+ngpt-2.3.1.dist-info/licenses/LICENSE,sha256=mQkpWoADxbHqE0HRefYLJdm7OpdrXBr3vNv5bZ8w72M,1065
+ngpt-2.3.1.dist-info/RECORD,,

ngpt-2.2.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-ngpt/__init__.py,sha256=ehInP9w0MZlS1vZ1g6Cm4YE1ftmgF72CnEddQ3Le9n4,368
-ngpt/cli.py,sha256=H_EIwZr-mSpw5JdlSD-CT6zWGWLldCJ4G-BKyWGIoOE,31536
-ngpt/client.py,sha256=75xmzO7e9wQ7y_LzZCacg3mkZdheewcBxB6moPftqYw,13067
-ngpt/config.py,sha256=BF0G3QeiPma8l7EQyc37bR7LWZog7FHJQNe7uj9cr4w,6896
-ngpt-2.2.0.dist-info/METADATA,sha256=seHeG-0SZyJcCN_SXpfpzI3jfwLBs9XrPkcdXt1mMhI,11278
-ngpt-2.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ngpt-2.2.0.dist-info/entry_points.txt,sha256=1cnAMujyy34DlOahrJg19lePSnb08bLbkUs_kVerqdk,39
-ngpt-2.2.0.dist-info/licenses/LICENSE,sha256=mQkpWoADxbHqE0HRefYLJdm7OpdrXBr3vNv5bZ8w72M,1065
-ngpt-2.2.0.dist-info/RECORD,,