ngpt 3.4.4__tar.gz → 3.5.0__tar.gz

{ngpt-3.4.4/docs → ngpt-3.5.0}/CONTRIBUTING.md

@@ -1,8 +1,3 @@
----
-title: Contributing to NGPT
-description: Guidelines and instructions for contributing to the NGPT project
----
-
 # Contributing to NGPT
 
 Thank you for your interest in contributing to NGPT! This document provides guidelines and instructions for contributing to this project.
@@ -33,15 +28,15 @@ Thank you for your interest in contributing to NGPT! This document provides guid
     - `args.py` - Argument parsing setup
     - `config_manager.py` - CLI configuration handling
     - `formatters.py` - Output formatting logic
-    - `interactive.py` - Interactive mode implementation
     - `modes/` - Different operational modes
       - `__init__.py` - Modes initialization
       - `chat.py` - Chat mode functionality
       - `code.py` - Code generation mode
       - `gitcommsg.py` - Git commit message generation
+      - `interactive.py` - Interactive mode implementation
+      - `rewrite.py` - Text rewriting mode
       - `shell.py` - Shell command generation
       - `text.py` - Text generation mode
-      - `rewrite.py` - Text rewriting mode
     - `renderers.py` - Output rendering logic (e.g., markdown)
     - `ui.py` - User interface elements (e.g., prompts, spinners)
   - `utils/` - Utility modules
@@ -50,8 +45,7 @@ Thank you for your interest in contributing to NGPT! This document provides guid
     - `cli_config.py` - CLI-specific option configuration management
     - `log.py` - Logging setup and utilities
 - `docs/` - Documentation files
-  - `api/` - API reference documentation
-  - `examples/` - Example code and usage
+  - `examples/` - Example usage
   - `usage/` - Usage guides and tutorials
 - `.github/` - GitHub workflows and templates
 - `pyproject.toml` - Project configuration and dependencies
@@ -83,14 +77,22 @@ Before submitting a pull request, please make sure that:
 5. Push to your fork: `git push origin feature/your-feature-name`
 6. Open a Pull Request against the main repository
 
-## Testing
+## Testing Your Changes
 
 Before submitting your changes, please test:
 
-- Basic functionality
-- Any new features you've added
-- Any components you've modified
-- Ensure all tests pass if there's a test suite
+1. Basic CLI functionality
+2. Any new features you've added
+3. Any components you've modified
+4. Test on different platforms if possible (Windows, Linux, macOS)
+5. Try various prompts and inputs to ensure robustness
+
+Test your changes with:
+```bash
+# After installing with -e flag
+python -m ngpt --version
+python -m ngpt "Test prompt" 
+```
 
 ## Issue Reporting
 
@@ -115,6 +117,34 @@ Feature requests are welcome! To submit a feature request:
 
 For questions about the project that aren't bugs or feature requests, please use GitHub Discussions instead of opening an issue. This helps keep the issue tracker focused on bugs and features.
 
+## Common Tasks
+
+### Adding a New Mode
+
+If you're adding a new mode to nGPT, you should:
+
+1. Create a new file in `ngpt/cli/modes/` for your mode implementation
+2. Add your mode to the mode selection logic in `ngpt/cli/args.py`
+3. Update help documentation to include your mode
+4. Add tests for your new mode
+5. Update documentation in `docs/usage/` to describe your mode
+
+### Improving Renderers
+
+For improvements to the output rendering:
+
+1. Modify the renderer code in `ngpt/cli/renderers.py`
+2. Ensure backward compatibility if possible
+3. Test with various types of output (code, markdown, tables, etc.)
+
+### Updating Documentation
+
+When updating documentation:
+
+1. Ensure your changes are reflected in both the code docstrings and in the Markdown documentation
+2. Update examples if necessary
+3. Test that documentation renders correctly
+
 ## License
 
 By contributing to this project, you agree that your contributions will be licensed under the same [LICENSE](LICENSE) as the project.

{ngpt-3.4.4 → ngpt-3.5.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 3.4.4
-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.
+Version: 3.5.0
+Summary: Swiss army knife for LLMs: powerful CLI and interactive chatbot 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.
 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
@@ -28,12 +28,12 @@ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Utilities
 Requires-Python: >=3.8
+Requires-Dist: beautifulsoup4>=4.12.0
 Requires-Dist: duckduckgo-search>=3.0.0
 Requires-Dist: prompt-toolkit>=3.0.0
 Requires-Dist: pyperclip>=1.8.0
 Requires-Dist: requests>=2.31.0
 Requires-Dist: rich>=10.0.0
-Requires-Dist: trafilatura>=1.6.0
 Description-Content-Type: text/markdown
 
 # nGPT
@@ -46,13 +46,13 @@ Description-Content-Type: text/markdown
 </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>
+  <a href="https://nazdridoy.github.io/ngpt/installation/"><img src="https://img.shields.io/badge/Linux-support-blue?logo=linux" alt="Linux"></a>
+  <a href="https://nazdridoy.github.io/ngpt/installation/"><img src="https://img.shields.io/badge/Windows-support-blue?logo=windows" alt="Windows"></a>
+  <a href="https://nazdridoy.github.io/ngpt/installation/"><img src="https://img.shields.io/badge/macOS-support-blue?logo=apple" alt="macOS"></a>
+  <a href="https://nazdridoy.github.io/ngpt/installation/"><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.
+🤖 nGPT: A Swiss army knife for LLMs: powerful CLI and interactive chatbot 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.
 
 
 ![2025-04-23_16-18-01](https://github.com/user-attachments/assets/b8e58926-5165-4352-b48b-9f4a982da86e)
@@ -60,12 +60,12 @@ Description-Content-Type: text/markdown
 
 ## Features
 
-- ✅ **Versatile**: Use as a CLI tool, Python library, or CLI framework for building custom tools
+- ✅ **Versatile**: Powerful and easy-to-use CLI tool for various AI tasks
 - 🪶 **Lightweight**: Minimal dependencies with everything you need included
-- 🔄 **API Flexibility**: Works with OpenAI, Ollama, Groq, Claude, Gemini, and any compatible endpoint
+- 🔄 **API Flexibility**: Works with OpenAI, Ollama, Groq, Claude, Gemini, and any OpenAI-compatible endpoint
 - 💬 **Interactive Chat**: Continuous conversation with memory in modern UI
 - 📊 **Streaming Responses**: Real-time output for better user experience
-- 🔍 **Web Search**: Enhance any model with contextual information from the web
+- 🔍 **Web Search**: Enhance any model with contextual information from the web, using advanced content extraction to identify the most relevant information from web pages
 - 📥 **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
@@ -77,48 +77,55 @@ Description-Content-Type: text/markdown
 - 📑 **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.
+See the [Feature Overview](https://nazdridoy.github.io/ngpt/overview/) for more details.
 
 
 ## Table of Contents
-- [Quick Start](#quick-start)
 - [Features](#features)
-- [Documentation](#documentation)
 - [Installation](#installation)
+- [Quick Start](#quick-start)
 - [Usage](#usage)
+  - [Command Line Options](#command-line-options)
   - [Documentation](https://nazdridoy.github.io/ngpt/)
-  - [CLI Tool](#as-a-cli-tool)
-  - [Python Library](#as-a-library)
-  - [CLI Framework](#as-a-cli-framework)
+- [Documentation](#documentation)
 - [Configuration](#configuration)
-  - [Command Line Options](#command-line-options)
+  - [API Key Setup](#api-key-setup)
+  - [OpenAI API Key](#openai-api-key)
+  - [Google Gemini API Key](#google-gemini-api-key)
   - [CLI Configuration](#cli-configuration)
   - [Interactive Configuration](#interactive-configuration)
   - [Configuration File](#configuration-file)
   - [Configuration Priority](#configuration-priority)
-  - [API Key Setup](#api-key-setup)
-  - [OpenAI API Key](#openai-api-key)
-  - [Google Gemini API Key](#google-gemini-api-key)
 - [Contributing](#contributing)
 - [License](#license)
 
-## Quick Start
+## Installation
 
 ```bash
-# Install with pip
+# Installation with pip
 pip install ngpt
 
-# Or install with uv (faster)
+# Or install with uv (faster installation)
 uv pip install ngpt
 
-# Or install globally as a CLI tool (recommended)
+# Or install globally as a CLI tool (recommended for command-line usage)
 uv tool install ngpt
 
+# Arch Linux: install from AUR
+paru -S ngpt
+```
+
+Requires Python 3.8 or newer.
+
+For detailed installation instructions, see the [Installation Guide](https://nazdridoy.github.io/ngpt/installation/).
+
+## Quick Start
+
+```bash
 # Chat with default settings
 ngpt "Tell me about quantum computing"
 
@@ -203,60 +210,6 @@ ngpt --provider Groq "Explain quantum computing"
 # Compare outputs from different providers
 ngpt --provider OpenAI "Explain quantum physics" > openai_response.txt
 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).
-
-## Documentation
-
-Comprehensive documentation, including API reference, usage guides, and examples, is available at:
-
-**[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)
-- [CLI Framework Guide](https://nazdridoy.github.io/ngpt/usage/cli_framework.html)
-- [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration.html)
-- [Examples & Tutorials](https://nazdridoy.github.io/ngpt/examples/basic.html)
-
-## Installation
-
-```bash
-# Installation with pip
-pip install ngpt
-
-# Or install with uv (faster installation)
-uv pip install ngpt
-
-# Or install globally as a CLI tool (recommended for command-line usage)
-uv tool install ngpt
-
-# Arch Linux: install from AUR
-paru -S 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
-
-```bash
-# Basic chat (default mode)
-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 all API configurations
 ngpt --show-config --all
@@ -282,165 +235,16 @@ ngpt -s "list all files in current directory"
 # On Windows generates: dir
 # On Linux/macOS generates: ls -la
 
-# Generate clean code (using -c or --code flag)
-# Returns only code without markdown formatting or explanations
+# Generate code (using -c or --code flag)
 ngpt -c "create a python function that calculates fibonacci numbers"
 
 # Use multiline text editor for complex prompts (using -t or --text flag)
-# Opens an interactive editor with syntax highlighting and intuitive controls
 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
-from ngpt import NGPTClient
-from ngpt.utils.config import load_config
-
-# Load the first configuration (index 0) from config file
-config = load_config(config_index=0)
-
-# Initialize the client with config
-client = NGPTClient(**config)
-
-# Or initialize with custom parameters
-client = NGPTClient(
-    api_key="your-key",
-    base_url="http://your-endpoint",
-    provider="openai",
-    model="o3-mini"
-)
-
-# Chat
-response = client.chat("Hello, how are you?")
-
-# Chat with web search (if your API endpoint supports it)
-response = client.chat("What's the latest news about AI?", web_search=True)
-
-# Generate shell command
-command = client.generate_shell_command("list all files")
-
-# Generate code
-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
-# Stream responses
-for chunk in client.chat("Write a poem about Python", stream=True):
-    print(chunk, end="", flush=True)
-
-# Customize system prompt
-response = client.chat(
-    "Explain quantum computing",
-    system_prompt="You are a quantum physics professor. Explain complex concepts simply."
-)
-
-# OS-aware shell commands
-# Automatically generates appropriate commands for the current OS
-command = client.generate_shell_command("find large files")
-import subprocess
-result = subprocess.run(command, shell=True, capture_output=True, text=True)
-print(result.stdout)
-
-# Clean code generation
-# Returns only code without markdown or explanations
-code = client.generate_code("function that converts Celsius to Fahrenheit")
-print(code)
-
-# Compare responses from different providers
-openai_config = load_config(config_index=0)  # OpenAI
-groq_config = load_config(config_index=1)    # Groq
-
-openai_client = NGPTClient(**openai_config)
-groq_client = NGPTClient(**groq_config)
-
-openai_response = openai_client.chat("Explain quantum computing")
-groq_response = groq_client.chat("Explain quantum computing")
-```
-
-For advanced usage patterns and integrations, check out the [Advanced Examples](https://nazdridoy.github.io/ngpt/examples/advanced.html).
-
-### As a CLI Framework
-
-nGPT can also be used as a framework to build your own AI-powered command-line tools. You can leverage nGPT's pre-built CLI components to quickly develop sophisticated CLI applications.
-
-```python
-from ngpt import NGPTClient
-from ngpt.utils.config import load_config
-from ngpt.cli.interactive import interactive_chat_session
-from ngpt.cli.renderers import prettify_markdown
-from ngpt.cli.args import setup_argument_parser
-import sys
-
-# Create a custom CLI tool with colorized help
-parser = setup_argument_parser()
-parser.description = "Specialized Code Assistant"
-parser.add_argument("prompt", nargs="?", help="Code description")
-parser.add_argument("--language", "-l", default="python", help="Programming language")
-parser.add_argument("--interactive", "-i", action="store_true", help="Start interactive mode")
-args = parser.parse_args()
-
-# Initialize client
-client = NGPTClient(**load_config())
-
-# Use interactive session for conversation
-if args.interactive:
-    system_prompt = f"You are an expert {args.language} developer. Provide clear, detailed answers."
-    interactive_chat_session(client=client, preprompt=system_prompt, prettify=True)
-elif args.prompt:
-    # Generate and prettify code
-    code = client.generate_code(args.prompt, language=args.language)
-    print(prettify_markdown(f"```{args.language}\n{code}\n```"))
-else:
-    parser.print_help()
-    sys.exit(1)
-```
+For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage/).
 
-This allows you to build specialized AI tools like:
-- Code generators for specific languages or frameworks
-- Domain-specific assistants (SQL, legal, finance, etc.)
-- Documentation generators
-- Translation tools
-- And much more
-
-For detailed information about building CLI tools with nGPT, see the [CLI Framework Guide](https://nazdridoy.github.io/ngpt/usage/cli_framework.html) and explore the [CLI Component Examples](https://nazdridoy.github.io/ngpt/examples/cli_components.html).
-
-## Configuration
-
-### API Key Setup
-
-#### OpenAI API Key
-1. Create an account at [OpenAI](https://platform.openai.com/)
-2. Navigate to API keys: https://platform.openai.com/api-keys
-3. Click "Create new secret key" and copy your API key
-4. Configure nGPT with your key:
-   ```bash
-   ngpt --config
-   # Enter provider: OpenAI
-   # Enter API key: your-openai-api-key
-   # Enter base URL: https://api.openai.com/v1/
-   # Enter model: gpt-3.5-turbo (or other model)
-   ```
-
-#### Google Gemini API Key
-1. Create or use an existing Google account
-2. Go to [Google AI Studio](https://aistudio.google.com/)
-3. Navigate to API keys in the left sidebar (or visit https://aistudio.google.com/app/apikey)
-4. Create an API key and copy it
-5. Configure nGPT with your key:
-   ```bash
-   ngpt --config
-   # Enter provider: Gemini
-   # Enter API key: your-gemini-api-key
-   # Enter base URL: https://generativelanguage.googleapis.com/v1beta/openai
-   # Enter model: gemini-2.0-flash
-   ```
+## Usage
 
 ### Command Line Options
 
@@ -449,8 +253,8 @@ For detailed information about building CLI tools with nGPT, see the [CLI Framew
 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]
+            [--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]
@@ -469,12 +273,10 @@ options::
 
 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 [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)
+--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
@@ -486,30 +288,28 @@ 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)
+--web-search                        Enable web search capability using DuckDuckGo to enhance prompts with relevant information
 --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
+--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)
+--renderer {auto,rich,glow}         Select which markdown renderer to use with --prettify or --stream-prettify (auto, rich, or glow)
+
+Output Display Options (mutually exclusive)::
+
+--no-stream                         Return the whole response without streaming or formatting
+--prettify                          Render complete response with markdown and code formatting (non-streaming)
+--stream-prettify                   Stream response with real-time markdown rendering (default)
 
 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.
+--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)
+--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)
+--max-recursion-depth MAX_RECURSION_DEPTH Maximum recursion depth for commit message condensing (default: 3)
 
 Modes (mutually exclusive)::
 
@@ -517,15 +317,62 @@ Modes (mutually exclusive)::
 -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
+-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).
+For a complete reference of all available options, detailed CLI examples and usage information, see the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage/).
+
+
+## Documentation
+
+Comprehensive documentation, including usage guides and examples, is available at:
+
+**[https://nazdridoy.github.io/ngpt/](https://nazdridoy.github.io/ngpt/)**
+
+Key documentation sections:
+- [Installation Guide](https://nazdridoy.github.io/ngpt/installation/)
+- [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage/)
+- [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration/)
+- [Examples & Tutorials](https://nazdridoy.github.io/ngpt/examples/basic/)
+- [Git Commit Message Guide](https://nazdridoy.github.io/ngpt/usage/gitcommsg/)
+
+
+## Configuration
+
+### API Key Setup
+
+#### OpenAI API Key
+1. Create an account at [OpenAI](https://platform.openai.com/)
+2. Navigate to API keys: https://platform.openai.com/api-keys
+3. Click "Create new secret key" and copy your API key
+4. Configure nGPT with your key:
+   ```bash
+   ngpt --config
+   # Enter provider: OpenAI
+   # Enter API key: your-openai-api-key
+   # Enter base URL: https://api.openai.com/v1/
+   # Enter model: gpt-3.5-turbo (or other model)
+   ```
+
+#### Google Gemini API Key
+1. Create or use an existing Google account
+2. Go to [Google AI Studio](https://aistudio.google.com/)
+3. Navigate to API keys in the left sidebar (or visit https://aistudio.google.com/app/apikey)
+4. Create an API key and copy it
+5. Configure nGPT with your key:
+   ```bash
+   ngpt --config
+   # Enter provider: Gemini
+   # Enter API key: your-gemini-api-key
+   # Enter base URL: https://generativelanguage.googleapis.com/v1beta/openai
+   # Enter model: gemini-2.0-flash
+   ```
+
+For more detailed information, refer to the [API Key Setup documentation](https://nazdridoy.github.io/ngpt/configuration/#api-key-setup).
 
 ### CLI Configuration
 
@@ -598,7 +445,7 @@ CLI Configuration Help:
 
 ```
 
-For more details, see the [CLI Configuration Guide](https://nazdridoy.github.io/ngpt/usage/cli_config.html).
+For more details, see the [CLI Configuration Guide](https://nazdridoy.github.io/ngpt/usage/cli_config/).
 
 ### Interactive Configuration
 
@@ -630,7 +477,7 @@ 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).
+For more details on configuring nGPT, see the [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration/).
 
 ### Configuration File
 
@@ -666,7 +513,7 @@ 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).
+For details on the configuration file format and structure, see the [Configuration Guide](https://nazdridoy.github.io/ngpt/configuration/).
 
 ### Configuration Priority
 

{ngpt-3.4.4 → ngpt-3.5.0}/PKGBUILD

@@ -2,7 +2,7 @@
 pkgname=ngpt
 pkgver=0.0.0  # Automatically updated by CI on release
 pkgrel=1
-pkgdesc="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."
+pkgdesc="Swiss army knife for LLMs: powerful CLI and interactive chatbot 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."
 arch=('any')
 url="https://github.com/nazdridoy/ngpt"
 license=('MIT')