nGPT Documentation

Welcome to the nGPT documentation. This guide will help you get started with nGPT, a Swiss army knife for LLMs that combines a powerful CLI and interactive chatbot in one package.

Table of Contents

• Overview
• Installation
• Usage
  • CLI Usage
  • CLI Configuration
  • Git Commit Messages
  • Web Search
• Examples
  • Basic Examples
  • Advanced Examples
• Configuration
• Contributing
• License

What is nGPT?

nGPT is a versatile command-line tool designed to interact with AI language models through various APIs. It provides a seamless interface for generating text, code, shell commands, and more, all from your terminal.

Getting Started

For a quick start, refer to the Installation and CLI Usage guides.

Key Features

• 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 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
• 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
• Provider Switching: Easily switch between different LLM providers with a single parameter
• Performance Optimized: Fast response times and minimal resource usage

Quick Examples

# Basic chat
ngpt "Tell me about quantum computing"

# Interactive chat session
ngpt -i

# Generate code
ngpt --code "function to calculate Fibonacci numbers"

# Generate and execute shell commands
ngpt --shell "find large files in current directory"

# Generate git commit messages
ngpt --gitcommsg

For more examples and detailed instructions, explore the documentation sections listed above.