PyGPT - pygpt.net

Release: 2.7.12 (2026-02-06)

Project Website: https://pygpt.net

GitHub: https://github.com/szczyglis-dev/py-gpt

Snap Store: https://snapcraft.io/pygpt

PyPI: https://pypi.org/project/pygpt-net

Microsoft Store: https://apps.microsoft.com/detail/XP99R4MX3X65VQ

Contents

• Introduction
  • Overview
  • Features
• How to Install
  • Binaries
    • Windows 10 and 11
    • Linux
  • Microsoft Store
  • AppImage
  • Snap Store
  • Python version
    • PyPi (pip)
  • Running from source code
    • Install with pip
    • Install with Poetry
  • Troubleshooting
  • Other requirements
  • Debugging and logging
• Quick Start
• Work modes
  • Chat
  • Chat with Files (LlamaIndex)
  • Chat with Audio
  • Research
  • Completion
  • Image and video generation
  • Assistants
  • Agent (LlamaIndex)
  • Agent (OpenAI)
  • Agent (Autonomous)
  • Experts (Co-op, co-operation mode)
  • Computer use
• Context and memory
  • Short and long-term memory
  • Handling multiple contexts
  • Clearing history
  • Context storage
• Files and Attachments
  • Uploading attachments
  • Downloading files
• Presets
  • What is preset?
  • Example usage
• Profiles
• Models
  • Built-in models
  • Adding a custom model
  • How to use local or non-GPT models
    • Llama 3, Mistral, DeepSeek, Qwen, gpt-oss, and other local models
    • Using local embeddings
    • Google Gemini, Anthropic Claude, xAI Grok, etc.
• Plugins
  • Overview
  • Creating Your Own Plugins
  • API calls
  • Audio Input
  • Audio Output
  • Autonomous Agent (inline)
  • Bitbucket
  • Chat with files (LlamaIndex, inline)
  • Code Interpreter
  • Context history (calendar, inline)
  • Crontab / Task scheduler
  • Custom Commands
  • Experts (inline)
  • Facebook
  • Files I/O
  • GitHub
  • Google (Gmail, Drive, Calendar, Contacts, YT, Keep, Docs, Maps, Colab)
  • Image Generation (inline)
  • Mailer
  • MCP
    • How it works
    • Adding a new MCP server
    • Example: quickstart via stdio
    • Example: remote docs server (HTTP/SSE)
    • Caching (Tools Cache)
    • Transports
    • Security notes
  • Mouse And Keyboard
  • OpenStreetMap
  • Real Time
  • Serial port / USB
  • Server (SSH/FTP)
  • Slack
  • System Prompt Extra (append)
  • System (OS)
  • Telegram
  • Tuya (IoT)
  • Vision (inline)
  • Voice Control (inline)
  • Web Search
  • Wikipedia
  • Wolfram Alpha
  • X/Twitter
• Tools
  • Notepad
  • Painter
  • Calendar
  • Indexer
  • Media Player
  • Image Viewer
  • Text Editor
  • Transcribe Audio/Video Files
  • OpenAI / Google Vector Stores
  • Python Code Interpreter
  • HTML/JS Canvas
  • Translator
  • Web Browser (Chromium)
  • Agents Builder (beta)
• Functions, commands and tools
• Token usage
  • Input tokens
  • Total tokens
• Accessibility
• Configuration
  • Settings
  • JSON files
  • Manual configuration
  • Setting the Working Directory Using Command Line Arguments
  • Translations / locale
  • Data Loaders
  • Vector stores
• Updates
  • Updating PyGPT
• Debugging and Logging
• Extending PyGPT
  • Quick start
  • Adding a custom model
  • Adding a custom plugin
    • Creating Your Own Plugin
    • Handling events
    • List of Events
  • Adding a custom LLM provider
  • Adding a custom vector store provider
  • Adding a custom data loader
• Security
  • Security Policy
  • Reporting a Vulnerability
  • External Libraries
• Credits
  • Links
  • Special thanks
  • Third-party libraries