private-gpt

(β˜… 57,450)

Complete API layer for private AI applications on local models: RAG, skills, tools, MCP, text-to-sql, and more. Works with any OpenAI-compatible inference server.

  • .dockerignore
  • .gitignore
  • CHANGELOG.md
  • CITATION.cff
  • Dockerfile
  • LICENSE
  • Makefile
  • pyproject.toml
  • README.md
  • SECURITY.md
  • settings-mock.yaml
  • settings-test.yaml
  • settings.yaml
  • uv.lock
  • version.txt

πŸš€ Installation Guide

1. Get the code
git clone https://github.com/zylon-ai/private-gpt

Downloads the entire project code from GitHub to your computer.

cd private-gpt

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
brew tap zylon-ai/tap

Registers this project's repository (tap) with Homebrew.

brew install private-gpt

Installs the pre-built package via Homebrew β€” no source build required.

curl -LsSf https://astral.sh/uv/install.sh | sh

Downloads and runs the official install script in one line β€” this handles the full setup automatically.

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Docker

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Docker Desktop Needed to build and run containers. Install it and keep it running in the background.
docker build -t private-gpt .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 private-gpt

Runs the built image as an actual container.

βœ… Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
pip install .

Installs the package published on PyPI directly β€” no need to clone the source.

python <μ‹€ν–‰ν•  파일λͺ…>.py # READMEμ—μ„œ μ •ν™•ν•œ μ‹€ν–‰ 파일λͺ…을 ν™•μΈν•˜μ„Έμš”

Runs the Python script (or module).

βœ… If it runs without errors and prints output in the terminal, it worked.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.
// repository documentation