ngpt 2.12.0__py3-none-any.whl → 2.14.0__py3-none-any.whl

{ngpt-2.12.0.dist-info → ngpt-2.14.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ngpt
-Version: 2.12.0
+Version: 2.14.0
 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
@@ -29,6 +29,7 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Utilities
 Requires-Python: >=3.8
 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
 Description-Content-Type: text/markdown
@@ -103,6 +104,33 @@ 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: {}"
 
+# Rewrite text to improve quality while preserving tone and meaning
+echo "your text" | ngpt --rewrite
+
+# Rewrite text from a command-line argument
+ngpt --rewrite "your text to rewrite"
+
+# Rewrite text from a file
+cat file.txt | ngpt --rewrite
+
+# Generate AI-powered git commit messages for staged changes
+ngpt --gitcommsg
+
+# Generate commit message with context
+ngpt --gitcommsg -m "type:feat"
+
+# Process large diffs in chunks with recursive analysis
+ngpt --gitcommsg -r
+
+# Process a diff file instead of staged changes
+ngpt --gitcommsg --diff /path/to/changes.diff
+
+# Generate a commit message with logging for debugging
+ngpt --gitcommsg --log commit_log.txt
+
+# Use interactive multiline editor to enter text to rewrite
+ngpt --rewrite
+
 # Display markdown responses with beautiful formatting
 ngpt --prettify "Explain markdown syntax with examples"
 
@@ -138,12 +166,15 @@ For more examples and detailed usage, visit the [CLI Usage Guide](https://nazdri
 - 💬 **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
@@ -349,38 +380,52 @@ For detailed information about building CLI tools with nGPT, see the [CLI Framew
 
 ### Command Line Options
 
-You can configure the client using the following options:
+You can configure nGPT using the following options:
+
+#### Mode Options (Mutually Exclusive)
 
 | Option | Description |
 |--------|-------------|
-| `--api-key` | API key for the service |
-| `--base-url` | Base URL for the API |
-| `--model` | Model to use |
-| `--list-models` | List all available models for the selected configuration (can be combined with --config-index) |
-| `--web-search` | Enable web search capability |
+| `-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 |
+
+#### 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 |
-| `--temperature` | Set temperature (controls randomness, default: 0.7) |
-| `--top_p` | Set top_p (controls diversity, default: 1.0) |
-| `--max_tokens` | Set maximum response length in tokens |
-| `--preprompt` | Set custom system prompt to control AI behavior |
-| `--log` | Enable logging: use `--log` to create a temporary log file, or `--log PATH` for a specific location |
-| `--prettify` | Render markdown responses and code with syntax highlighting |
-| `--stream-prettify` | Enable real-time markdown rendering with syntax highlighting while streaming |
-| `--renderer` | Select which markdown renderer to use with --prettify (auto, rich, or glow) |
-| `--list-renderers` | Show available markdown renderers for use with --prettify |
-| `--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) |
-| `--provider` | Provider name to identify the configuration to use (alternative to --config-index) |
+| `--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 configuration details and exit |
-| `--all` | Used with `--show-config` to display all configurations |
-| `-i, --interactive` | Start an interactive chat session with stylish UI, conversation history, and special commands |
-| `-s, --shell` | Generate and execute shell commands |
-| `-c, --code` | Generate clean code output |
-| `-t, --text` | Open interactive multiline editor for complex prompts |
-| `--language` | Programming language to generate code in (for code mode, default: python) |
-| `--cli-config` | Manage CLI configuration settings (set, get, unset, list, help) |
-| `-v, --version` | Show version information |
+| `--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 |
 
 For a complete reference of all available options, see the [CLI Usage Guide](https://nazdridoy.github.io/ngpt/usage/cli_usage.html).
 

{ngpt-2.12.0.dist-info → ngpt-2.14.0.dist-info}/RECORD

@@ -2,24 +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=5MxWHkE6bW6bH5IAITTj2WrkXf2sV3FPV8LJanb-yw0,9770
+ngpt/cli/args.py,sha256=87b35nG7LFWPwewiICQrgilGIdD_uwqpkgo1DN3xOZY,11073
 ngpt/cli/config_manager.py,sha256=NQQcWnjUppAAd0s0p9YAf8EyKS1ex5-0EB4DvKdB4dk,3662
-ngpt/cli/formatters.py,sha256=1ofNEWEZtFr0MJ3oWomoL_mFmZHlUdT3I5qGtbDQ4g0,9378
+ngpt/cli/formatters.py,sha256=HBYGlx_7eoAKyzfy0Vq5L0yn8yVKjngqYBukMmXCcz0,9401
 ngpt/cli/interactive.py,sha256=DZFbExcXd7RylkpBiZBhiI6N8FBaT0m_lBes0Pvhi48,10894
-ngpt/cli/main.py,sha256=y0L-GlA3oDRup_4nDVTWtVCv70ijswKXx3m3kG0zkjI,27720
+ngpt/cli/main.py,sha256=hFX7Nn9NaRwa6uRp09fnPDzfmbkbbWZNczSLCUZPtLU,28488
 ngpt/cli/renderers.py,sha256=gJ3WdVvCGkNxrLEkLCh6gk9HBFMK8y7an6CsEkqt2Z8,10535
 ngpt/cli/ui.py,sha256=iMinm_QdsmwrEUpb7CBRexyyBqf4sviFI9M3E8D-hhA,5303
-ngpt/cli/modes/__init__.py,sha256=11znFpqzHyRsEtaTrms5M3q2SrscT9VvUgr7C2B1o-E,179
+ngpt/cli/modes/__init__.py,sha256=R3aO662RIzWEOvr3moTrEI8Tpg0zDDyMGGh1-OxiRgM,285
 ngpt/cli/modes/chat.py,sha256=4a5EgM_5A1zCSrLrjgQMDnBwIHd1Rnu5_BjSKSm7p24,4255
 ngpt/cli/modes/code.py,sha256=RjOAj7BDO5vLUdIPkUfPtyIkI_W6qEHsZvYh-sIdVaM,4293
+ngpt/cli/modes/gitcommsg.py,sha256=Su7-e2w5_3-ilgjfo_x055HFC7HROwiyT_jkb667gCM,26637
+ngpt/cli/modes/rewrite.py,sha256=Zb0PFvWRKXs4xJCF3GEdYc-LSmy6qRszz8-QJuldHc0,8595
 ngpt/cli/modes/shell.py,sha256=lF9f7w-0bl_FdZl-WJnZuV736BKrWQtrwoKr3ejPXFE,2682
 ngpt/cli/modes/text.py,sha256=ncYnfLFMdTPuHiOvAaHNiOWhox6GF6S-2fTwMIrAz-g,3140
 ngpt/utils/__init__.py,sha256=E46suk2-QgYBI0Qrs6WXOajOUOebF3ETAFY7ah8DTWs,942
-ngpt/utils/cli_config.py,sha256=A1TgO1rkRs6zgfNwIw5v8-N5jxqrHMZ4B6r3w48egi8,10687
+ngpt/utils/cli_config.py,sha256=b7cXTxbRA-tQWgaehP_uRm_L8-677elPUXk290uzsTs,11110
 ngpt/utils/config.py,sha256=WYOk_b1eiYjo6hpV3pfXr2RjqhOnmKqwZwKid1T41I4,10363
-ngpt/utils/log.py,sha256=3AJiry9vUbo9Rzzrgj6-NMM4lCbgoZhrGcXvdxMqtrs,6353
-ngpt-2.12.0.dist-info/METADATA,sha256=e9iyCtLNNs5dFaX35FlOa1XqeVQw6h-B8SiWHGe2QHU,20967
-ngpt-2.12.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-ngpt-2.12.0.dist-info/entry_points.txt,sha256=SqAAvLhMrsEpkIr4YFRdUeyuXQ9o0IBCeYgE6AVojoI,44
-ngpt-2.12.0.dist-info/licenses/LICENSE,sha256=mQkpWoADxbHqE0HRefYLJdm7OpdrXBr3vNv5bZ8w72M,1065
-ngpt-2.12.0.dist-info/RECORD,,
+ngpt/utils/log.py,sha256=f1jg2iFo35PAmsarH8FVL_62plq4VXH0Mu2QiP6RJGw,15934
+ngpt-2.14.0.dist-info/METADATA,sha256=kvuDMT94vqncE_r5Nlw75ijljRMOBtdWRZ_p3bDsP8k,22573
+ngpt-2.14.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ngpt-2.14.0.dist-info/entry_points.txt,sha256=SqAAvLhMrsEpkIr4YFRdUeyuXQ9o0IBCeYgE6AVojoI,44
+ngpt-2.14.0.dist-info/licenses/LICENSE,sha256=mQkpWoADxbHqE0HRefYLJdm7OpdrXBr3vNv5bZ8w72M,1065
+ngpt-2.14.0.dist-info/RECORD,,