For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact usJoin the Discord
ManualAPI GuideAPI Reference
  • Getting started
    • Introduction
    • Quickstart
    • How it works
  • Installation Options
    • Package Install
    • Docker
    • Development
  • Configuration
    • CLI
    • Settings & Profiles
    • Model Configuration
  • Inference Providers
    • Overview
    • Ollama
    • LM Studio
    • LlamaCPP Server
    • vLLM
  • Integrations
    • Overview
    • Claude Code
    • Claude Desktop
    • Claude for Microsoft 365
    • OpenCode
  • Built-in Tools
    • Web Tools
    • Database Tools
  • Storage Providers
    • Vector Store
    • Object Storage
  • User Interface
    • Workbench
  • Observability
    • Observability
  • Reference
    • Troubleshooting
LogoLogo
Contact usJoin the Discord
On this page
  • Install
  • Verify
  • Run
  • Key environment variables
  • What’s next?
Installation Options

Package Install

Was this page helpful?
Previous

Docker

Next
Built with

This is the recommended installation method for developers who want to run PrivateGPT against an existing LLM server (Ollama, LM Studio, etc.) without cloning the repository.

PrivateGPT package files are hosted at https://zylon-ai.github.io/private-gpt/packages/. uv uses that location to find the PrivateGPT release and continues to resolve public dependencies from PyPI by default.

Install

macOS (Homebrew)
uv (recommended, any platform)
$brew tap zylon-ai/tap
$brew install private-gpt

Upgrade:

$brew upgrade private-gpt

Python 3.11 is required. PrivateGPT does not support Python 3.10 or 3.12+.

Verify

macOS / Linux
Windows (PowerShell)
Windows (CMD)
$command -v private-gpt

Run

After installing, set OPENAI_API_BASE to your LLM server and start:

macOS / Linux
Windows (PowerShell)
Windows (CMD)
$OPENAI_API_BASE=http://localhost:11434/v1 private-gpt serve

PrivateGPT starts on port 8080 by default. Change it with private-gpt serve --port <port>.

Key environment variables

VariableDefaultDescription
OPENAI_API_BASEhttps://api.openai.com/v1Base URL of your OpenAI-compatible LLM server
OPENAI_API_KEY(empty)API key, if your server requires one
OPENAI_EMBEDDING_API_BASEsame as OPENAI_API_BASEOverride for the embeddings endpoint
PORT8080Port the server listens on (also settable via private-gpt serve --port)
PGPT_LLM_AUTO_DISCOVER_MODELStrueDiscover LLM models from /v1/models on startup

What’s next?

  • Choose an LLM server — compare Ollama, LM Studio, LlamaCPP, vLLM
  • Local with uv — source install, hot reload, and detailed model configuration
  • API Reference — start building