ngpt 3.6.0__tar.gz → 3.8.0__tar.gz

{ngpt-3.6.0 → ngpt-3.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 3.6.0
+Version: 3.8.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
@@ -150,7 +150,19 @@ 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 -p "Analyze the following text: {}"
+echo "What is this text about?" | ngpt --pipe "Analyze the following text: {}"
+
+# Using here-string (<<<) for quick single-line input 
+ngpt --pipe {} <<< "What is the best way to learn shell redirects?"
+
+# Using standard input redirection to process file contents
+ngpt --pipe "summarise {}" < README.md
+
+# Using here-document (<<EOF) for multiline input
+ngpt --pipe {} << EOF                                              
+What is the best way to learn Golang?
+Provide simple hello world example.
+EOF
 
 # Rewrite text to improve quality while preserving tone and meaning
 echo "your text" | ngpt -r
@@ -173,6 +185,9 @@ ngpt -g --rec-chunk
 # Process a diff file instead of staged changes
 ngpt -g --diff /path/to/changes.diff
 
+# Use piped diff content for commit message generation
+git diff HEAD~1 | ngpt -g --pipe
+
 # Generate a commit message with logging for debugging
 ngpt -g --log commit_log.txt
 
@@ -201,7 +216,7 @@ ngpt --interactive --log conversation.log
 ngpt --log "Tell me about quantum computing"
 
 # Process text from stdin using the {} placeholder
-cat README.md | ngpt -p "Summarize this document: {}"
+cat README.md | ngpt --pipe "Summarize this document: {}"
 
 # Use different model providers by specifying the provider name
 ngpt --provider Groq "Explain quantum computing"
@@ -249,13 +264,14 @@ For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdri
 
 ```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]
+            [--api-key API_KEY] [--base-url BASE_URL] [--model MODEL] [--web-search] [--pipe]
+            [--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 | -r | -g]
             [prompt]
 
 nGPT - Interact with AI language models via OpenAI-compatible APIs
@@ -288,6 +304,7 @@ Global Options::
 --base-url BASE_URL                 Base URL for the API
 --model MODEL                       Model to use
 --web-search                        Enable web search capability using DuckDuckGo to enhance prompts with relevant information
+--pipe                              Read from stdin and use content with prompt. Use {} in prompt as placeholder for stdin content. Can be used with any mode option except --text and --interactive
 --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
@@ -308,7 +325,7 @@ Git Commit Message Options::
 --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)
+--max-recursion-depth MAX_RECURSION_DEPTH  Maximum recursion depth for commit message condensing (default: 3)
 
 Modes (mutually exclusive)::
 
@@ -316,9 +333,9 @@ 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
 -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.

{ngpt-3.6.0 → ngpt-3.8.0}/README.md

@@ -113,7 +113,19 @@ 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 -p "Analyze the following text: {}"
+echo "What is this text about?" | ngpt --pipe "Analyze the following text: {}"
+
+# Using here-string (<<<) for quick single-line input 
+ngpt --pipe {} <<< "What is the best way to learn shell redirects?"
+
+# Using standard input redirection to process file contents
+ngpt --pipe "summarise {}" < README.md
+
+# Using here-document (<<EOF) for multiline input
+ngpt --pipe {} << EOF                                              
+What is the best way to learn Golang?
+Provide simple hello world example.
+EOF
 
 # Rewrite text to improve quality while preserving tone and meaning
 echo "your text" | ngpt -r
@@ -136,6 +148,9 @@ ngpt -g --rec-chunk
 # Process a diff file instead of staged changes
 ngpt -g --diff /path/to/changes.diff
 
+# Use piped diff content for commit message generation
+git diff HEAD~1 | ngpt -g --pipe
+
 # Generate a commit message with logging for debugging
 ngpt -g --log commit_log.txt
 
@@ -164,7 +179,7 @@ ngpt --interactive --log conversation.log
 ngpt --log "Tell me about quantum computing"
 
 # Process text from stdin using the {} placeholder
-cat README.md | ngpt -p "Summarize this document: {}"
+cat README.md | ngpt --pipe "Summarize this document: {}"
 
 # Use different model providers by specifying the provider name
 ngpt --provider Groq "Explain quantum computing"
@@ -212,13 +227,14 @@ For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdri
 
 ```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]
+            [--api-key API_KEY] [--base-url BASE_URL] [--model MODEL] [--web-search] [--pipe]
+            [--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 | -r | -g]
             [prompt]
 
 nGPT - Interact with AI language models via OpenAI-compatible APIs
@@ -251,6 +267,7 @@ Global Options::
 --base-url BASE_URL                 Base URL for the API
 --model MODEL                       Model to use
 --web-search                        Enable web search capability using DuckDuckGo to enhance prompts with relevant information
+--pipe                              Read from stdin and use content with prompt. Use {} in prompt as placeholder for stdin content. Can be used with any mode option except --text and --interactive
 --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
@@ -271,7 +288,7 @@ Git Commit Message Options::
 --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)
+--max-recursion-depth MAX_RECURSION_DEPTH  Maximum recursion depth for commit message condensing (default: 3)
 
 Modes (mutually exclusive)::
 
@@ -279,9 +296,9 @@ 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
 -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.

{ngpt-3.6.0 → ngpt-3.8.0}/docs/configuration.md

@@ -145,13 +145,13 @@ The interactive configuration will prompt you for values and guide you through t
 You can set configuration options directly via command-line arguments:
 
 ```
-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]
+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] [--pipe]
+            [--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 | -r | -g]
             [prompt]
 ```
 
@@ -211,7 +211,7 @@ usage: ngpt [-h] [-v] [--language LANGUAGE] [--config [CONFIG]] [--config-index
 - `-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
+- `--pipe`: Read from stdin and use content with prompt. Use {} in prompt as placeholder for stdin content. Can be used with any mode option except --text and --interactive.
 - `-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
 
@@ -240,7 +240,7 @@ ngpt --interactive --log conversation.log
 ngpt --log "Tell me about quantum computing"
 
 # Process text from stdin using the {} placeholder
-echo "What is this text about?" | ngpt -p "Analyze the following text: {}"
+echo "What is this text about?" | ngpt --pipe "Analyze the following text: {}"
 
 # Generate git commit message from staged changes
 ngpt -g

{ngpt-3.6.0 → ngpt-3.8.0}/docs/examples/advanced.md

@@ -45,7 +45,7 @@ Use detailed, structured system prompts to create specific behaviors:
 
 ```bash
 # Create a detailed prompt from a file
-cat structured_prompt.txt | ngpt -i --pipe "--preprompt {}"
+cat structured_prompt.txt | ngpt --pipe "--preprompt {}"
 
 # Technical review prompt
 ngpt --preprompt "Act as a senior software engineer reviewing my code. 
@@ -192,6 +192,128 @@ cat api_docs.txt | ngpt --pipe "Enhance this API documentation with better expla
 cat product_descriptions.txt | ngpt --pipe "Improve these product descriptions by adding more vivid language, highlighting unique features, and addressing common customer pain points: {}"
 ```
 
+## Advanced Pipe Processing Workflows
+
+The `--pipe` flag enables sophisticated data processing pipelines when combined with other tools and modes. Here are advanced workflows that leverage piped content:
+
+### Shell Redirection with Pipe
+
+nGPT works seamlessly with various shell redirection techniques for flexible input handling:
+
+```bash
+# Using here-string (<<<) for quick single-line input 
+ngpt --pipe {} <<< "What is the best way to learn shell redirects?"
+
+# Using standard input redirection to process file contents
+ngpt --pipe "summarise {}" < README.md
+
+# Using here-document (<<EOF) for multiline input
+ngpt --pipe {} << EOF                                              
+What is the best way to learn Golang?
+Provide simple hello world example.
+EOF
+```
+
+### Multi-Stage Processing Pipelines
+
+Create complex processing chains that transform data through multiple steps:
+
+```bash
+# Multi-stage code transformation
+# Extract functions, optimize them, then add tests
+grep -r "function" src/ | 
+  ngpt --pipe "Extract all JavaScript function definitions from this code: {}" | 
+  ngpt --code --pipe "Optimize these functions for performance: {}" | 
+  ngpt --code --pipe "Write comprehensive unit tests for these optimized functions: {}" > test_suite.js
+
+# Log analysis workflow
+# Extract errors, analyze patterns, then generate fix suggestions
+grep -i "error" system.log | 
+  ngpt --pipe "Extract and categorize all errors by type: {}" | 
+  ngpt --pipe "Analyze these error categories and identify common patterns: {}" | 
+  ngpt --pipe "Recommend fixes for the most common error patterns: {}" > error_remediation.md
+```
+
+### Mode-Specific Advanced Techniques
+
+#### Advanced Code Mode with Pipe
+
+```bash
+# API Integration
+# Generate wrapper code for a REST API described in documentation
+curl -s https://api.example.com/docs | 
+  ngpt --pipe "Extract all API endpoints, parameters and response formats from this documentation: {}" | 
+  ngpt --code --language typescript --pipe "Create TypeScript interface definitions for these API resources: {}" > api-types.ts
+
+# Code transformation with context
+# Refactor legacy code to modern standards with context
+cat legacy-component.js | 
+  ngpt --code --language javascript --preprompt "You are refactoring legacy React class components to modern functional components with hooks" --pipe "Refactor this legacy component, preserving all functionality: {}" > modern-component.js
+```
+
+#### Advanced Shell Mode with Pipe
+
+```bash
+# Complex data processing command generation
+# Generate a command to process a complex data structure
+jq -r '.items[] | .metadata' complex_data.json | 
+  ngpt --shell --pipe "Generate a command to extract all unique values of the 'region' field, count occurrences of each, sort by count in descending order, and save to regions.csv with headers 'Region,Count': {}"
+
+# Dynamic script generation
+# Generate a data cleanup script based on analysis
+cat messy_data.csv | 
+  ngpt --pipe "Analyze this CSV data and identify all data quality issues: {}" | 
+  ngpt --shell --pipe "Create a bash script that cleans up all these data quality issues: {}" > cleanup_data.sh
+```
+
+#### Advanced Rewrite Mode with Pipe
+
+```bash
+# Targeted content update
+# Extract, update, and replace specific sections of a document
+grep -A20 "## Installation" README.md | 
+  ngpt --rewrite --pipe "Update this installation guide to include Docker setup instructions while maintaining the existing style: {}" | 
+  sed -i '/## Installation/,+20c\' README.md
+
+# Feedback-based improvement
+# Incorporate reviewer feedback into documentation
+cat reviewer_comments.txt | 
+  ngpt --pipe "Extract all actionable feedback points: {}" | 
+  cat docs.md - | 
+  ngpt --rewrite --pipe "Update this documentation to address all the feedback points listed at the end: {}" > improved_docs.md
+```
+
+### Working with Structured Data
+
+Process and transform structured data through pipe workflows:
+
+```bash
+# JSON transformation and enhancement
+cat data.json | 
+  jq '.items' | 
+  ngpt --pipe "Convert this JSON data to a markdown table with headers from the field names: {}" > data_table.md
+
+# Log data extraction and analysis
+cat server_logs.txt | 
+  grep -i "error" | 
+  ngpt --pipe "Extract timestamp, error code, and message from each line and format as a CSV: {}" | 
+  ngpt --pipe "Analyze this error data and identify trends by time of day and error type: {}" > error_analysis.md
+```
+
+### Git-Specific Pipe Workflows
+
+Leverage git command output with pipe processing:
+
+```bash
+# Commit history analysis
+git log --author="username" --since="1 month ago" --pretty=format:"%h %s" | 
+  ngpt --pipe "Analyze this commit history and summarize this developer's work focus and productivity patterns: {}" > developer_report.md
+
+# PR summary generation
+git diff origin/main..HEAD | 
+  ngpt --pipe "Summarize the key changes in this PR, focusing on functional changes rather than styling: {}" > pr_summary.md
+```
+
 ## Advanced Git Commit Message Generation
 
 ### Working with Large Codebases

{ngpt-3.6.0 → ngpt-3.8.0}/docs/examples/basic.md

@@ -165,6 +165,22 @@ cat script.py | ngpt --pipe "Explain what this code does and suggest improvement
 cat emails.txt | ngpt --pipe "Extract all company domains from these email addresses: {}"
 ```
 
+### Shell Redirection Examples
+
+```bash
+# Using here-string (<<<) for quick single-line input 
+ngpt --pipe {} <<< "What is the best way to learn shell redirects?"
+
+# Using standard input redirection to process file contents
+ngpt --pipe "summarise {}" < README.md
+
+# Using here-document (<<EOF) for multiline input
+ngpt --pipe {} << EOF                                              
+What is the best way to learn Golang?
+Provide simple hello world example.
+EOF
+```
+
 ### Content Transformation
 
 ```bash
@@ -178,6 +194,48 @@ cat spanish.txt | ngpt --pipe "Translate this Spanish text to English: {}"
 cat technical.txt | ngpt --pipe "Rewrite this technical content for a non-technical audience: {}"
 ```
 
+## Pipe Usage With Different Modes
+
+The pipe flag can be used with several different modes for powerful combinations:
+
+### With Standard Mode (Default)
+
+```bash
+# Summarize document content
+cat README.md | ngpt --pipe "Summarize this document: {}"
+```
+
+### With Code Mode
+
+```bash
+# Generate optimized version of code
+cat slow_function.py | ngpt --code --pipe "Optimize this function for performance: {}"
+
+# Add tests to existing code
+cat module.js | ngpt --code --language javascript --pipe "Write unit tests for this code: {}"
+```
+
+### With Shell Mode
+
+```bash
+# Generate command to process file content
+cat error_logs.txt | ngpt --shell --pipe "Generate a command to count occurrences of each error type in these logs: {}"
+```
+
+### With Rewrite Mode
+
+```bash
+# Improve email drafts
+cat draft_email.txt | ngpt --rewrite --pipe "Make this email more professional while maintaining the core message: {}"
+```
+
+### With Git Commit Message Mode
+
+```bash
+# Generate message from specific diff
+git diff HEAD~1 | ngpt --gitcommsg --pipe
+```
+
 ## Git Commit Message Examples
 
 ### Basic Usage
@@ -321,4 +379,4 @@ For more advanced examples and detailed explanations of specific features, see:
 - [Advanced Examples](advanced.md)
 - [CLI Usage Guide](../usage/cli_usage.md)
 - [CLI Configuration Guide](../usage/cli_config.md)
-- [Git Commit Message Guide](../usage/gitcommsg.md) 
+- [Git Commit Message Guide](../usage/gitcommsg.md)

{ngpt-3.6.0 → ngpt-3.8.0}/docs/overview.md

@@ -89,10 +89,22 @@ ngpt -t
 ```
 
 ### Stdin Processing Mode
-Process piped content using a placeholder:
+Process piped content using a placeholder (compatible with standard, code, shell, rewrite, and gitcommsg modes):
 ```bash
+# Standard mode
 cat README.md | ngpt --pipe "Summarize this document: {}"
-cat README.md | ngpt -p "Summarize this document: {}"
+
+# Code mode
+cat algorithm.py | ngpt --code --pipe "Optimize this algorithm: {}"
+
+# Shell mode
+cat logs.txt | ngpt --shell --pipe "Generate a command to analyze these logs: {}"
+
+# Rewrite mode 
+cat email.txt | ngpt --rewrite --pipe "Make this more professional: {}"
+
+# Git commit message mode
+git diff HEAD~1 | ngpt --gitcommsg --pipe
 ```
 
 ## Architecture

{ngpt-3.6.0 → ngpt-3.8.0}/docs/usage/cli_usage.md

@@ -37,13 +37,13 @@ Where:
 You can set configuration options directly via command-line arguments:
 
 ```
-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]
+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] [--pipe]
+            [--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 | -r | -g]
             [prompt]
 ```
 
@@ -103,7 +103,7 @@ usage: ngpt [-h] [-v] [--language LANGUAGE] [--config [CONFIG]] [--config-index
 - `-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
+- `--pipe`: Read from stdin and use content with prompt. Use {} in prompt as placeholder for stdin content. Can be used with any mode option except --text and --interactive.
 - `-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
 
@@ -282,6 +282,9 @@ ngpt --gitcommsg --rec-chunk
 # Use a diff file instead of staged changes
 ngpt --gitcommsg --diff path/to/diff_file
 
+# Use piped diff content from stdin
+git diff HEAD~1 | ngpt --gitcommsg --pipe
+
 # With custom context
 ngpt --gitcommsg --preprompt "type:feat"
 ```
@@ -323,10 +326,52 @@ cat script.py | ngpt --pipe "Explain what this code does and suggest improvement
 
 # Review text
 cat essay.txt | ngpt --pipe "Provide feedback on this essay: {}"
+
+# Using here-string (<<<) for quick single-line input 
+ngpt --pipe {} <<< "What is the best way to learn shell redirects?"
+
+# Using standard input redirection to process file contents
+ngpt --pipe "summarise {}" < README.md
+
+# Using here-document (<<EOF) for multiline input
+ngpt --pipe {} << EOF                                              
+What is the best way to learn Golang?
+Provide simple hello world example.
+EOF
 ```
 
 This is powerful for integrating nGPT into shell scripts and automation workflows.
 
+### Pipe Usage With Different Modes
+
+The `--pipe` flag can be combined with several modes (except `--text` and `--interactive`) for powerful workflows:
+
+```bash
+# Standard chat mode with pipe
+cat README.md | ngpt --pipe "Summarize this document in bullet points: {}"
+
+# Code generation mode with pipe
+cat algorithm.py | ngpt --code --pipe "Optimize this algorithm and add comments: {}"
+
+# Shell command generation with pipe
+cat server_logs.txt | ngpt --shell --pipe "Generate a command to extract all error messages from these logs: {}"
+
+# Rewrite mode with pipe (explicit placeholder)
+cat draft_email.txt | ngpt --rewrite --pipe "Make this email more professional while keeping key points: {}"
+
+# Rewrite mode with pipe (implicit - will use entire content)
+cat draft_email.txt | ngpt --rewrite
+
+# Git commit message generation from piped diff
+git diff HEAD~1 | ngpt --gitcommsg --pipe
+```
+
+Each mode handles piped content appropriately for that context:
+- In code mode: Uses piped code as a starting point for modification
+- In shell mode: Generates commands that process the piped content
+- In rewrite mode: Treats the piped content as the text to be rewritten
+- In gitcommsg mode: Uses piped content as the diff to analyze
+
 ## Formatting Options
 
 ### No Streaming
@@ -507,7 +552,19 @@ nGPT works well with Unix pipes and redirection:
 ngpt "Write a short story about AI" > story.txt
 
 # Process file content
-cat data.csv | ngpt -p "Analyze this CSV data and provide insights: {}" > analysis.txt
+cat data.csv | ngpt --pipe "Analyze this CSV data and provide insights: {}" > analysis.txt
+
+# Using here-string (<<<) for quick single-line input 
+ngpt --pipe {} <<< "What is the best way to learn shell redirects?"
+
+# Using standard input redirection to process file contents
+ngpt --pipe "summarise {}" < README.md
+
+# Using here-document (<<EOF) for multiline input
+ngpt --pipe {} << EOF                                              
+What is the best way to learn Golang?
+Provide simple hello world example.
+EOF
 
 # Chain commands
 ngpt --code "function to parse CSV" | grep -v "#" > parse_csv.py

{ngpt-3.6.0 → ngpt-3.8.0}/docs/usage/gitcommsg.md

@@ -114,6 +114,99 @@ This is useful for:
 - Sharing change analysis across machines
 - Creating template-based workflows
 
+## Using Piped Diff Content
+
+You can also pipe git diff output directly to nGPT for immediate commit message generation:
+
+```bash
+# Generate message from current unstaged changes
+git diff | ngpt --gitcommsg --pipe
+
+# Generate message from staged changes
+git diff --staged | ngpt --gitcommsg --pipe
+
+# Generate message from specific commit
+git diff HEAD~1 HEAD | ngpt --gitcommsg --pipe
+
+# Generate message from branch comparison
+git diff main..feature-branch | ngpt --gitcommsg --pipe
+
+# Generate message from specific files
+git diff -- src/components/ | ngpt --gitcommsg --pipe
+```
+
+This approach offers several advantages:
+
+1. **Flexibility**: Generate messages for any diff without creating temporary files
+2. **Workflow Integration**: Easily incorporate into shell scripts and CI/CD pipelines
+3. **Quick Previews**: Preview commit messages before staging changes
+4. **Selective Analysis**: Focus on specific files or directories
+5. **Branch Comparisons**: Generate messages based on differences between branches
+
+### Advanced Piped Diff Examples
+
+You can apply additional git options to customize the diff content:
+
+```bash
+# Ignore whitespace changes
+git diff -w | ngpt --gitcommsg --pipe
+
+# Include function context
+git diff -W | ngpt --gitcommsg --pipe
+
+# Compare with specific revision
+git diff v1.0.0..HEAD | ngpt --gitcommsg --pipe
+
+# Filter by file type
+git diff -- "*.js" "*.jsx" | ngpt --gitcommsg --pipe
+```
+
+### Combining with Other Tools
+
+You can combine piped diff content with other Unix tools:
+
+```bash
+# Filter the diff first with grep
+git diff | grep -v "package-lock.json" | ngpt --gitcommsg --pipe
+
+# Process large diffs with head/tail
+git diff | head -n 1000 | ngpt --gitcommsg --pipe
+
+# Save the diff and the message
+git diff | tee changes.diff | ngpt --gitcommsg --pipe | tee commit_msg.txt
+```
+
+### Using with Preprompt
+
+You can combine piped diff content with preprompt directives:
+
+```bash
+# Provide type and scope
+git diff | ngpt --gitcommsg --pipe --preprompt "type:feat scope:auth"
+
+# Add context about the changes
+git diff | ngpt --gitcommsg --pipe --preprompt "This implements the user authentication flow using OAuth2"
+```
+
+### Pipe Processing in Automated Workflows
+
+You can use piped diff content in scripts and automated workflows:
+
+```bash
+#!/bin/bash
+# Example script that analyzes all pending changes
+# and suggests commit messages for each file
+
+# Get list of changed files
+changed_files=$(git status -s | awk '{print $2}')
+
+for file in $changed_files; do
+  echo "Analyzing changes in $file..."
+  git diff -- "$file" | ngpt --gitcommsg --pipe > "$file.commit_msg"
+  echo "Suggested commit message saved to $file.commit_msg"
+done
+```
+
 ## Guiding Message Generation
 
 You can use the `--preprompt` option to provide context or directives for the message generation: