How to Install

Binaries

You can download compiled binary versions for Linux and Windows (10/11).

PyGPT binaries require a PC with Windows 10, 11, or Linux. Simply download the installer or the archive with the appropriate version from the download page at https://pygpt.net, extract it, or install it, and then run the application. A binary version for Mac is not available, so you must run PyGPT from PyPi or from the source code on Mac. Currently, only 64-bit binaries are available.

Windows 10 and 11

The application is available for 64-bit Windows 10, 11 in the form of an MSI installer. The installer will automatically install all required dependencies and create a shortcut on the desktop. Just download the installer from the download page and run it

Linux

The application is available for 64-bit Linux in the form of an archive with all required dependencies. Just download the archive from the download page and extract it. Then run the application by running the pygpt binary file in the root directory.

Linux version requires GLIBC >= 2.35.

Snap Store

You can install PyGPT directly from Snap Store:

$ sudo snap install pygpt

To manage future updates just use:

$ sudo snap refresh pygpt

Using camera: to use camera in Snap version you must connect the camera with interface:

$ snap connect pygpt:camera

Using microphone: to use microphone in Snap version you must connect the microphone with:

$ sudo snap connect pygpt:audio-record :audio-record
$ sudo snap connect pygpt:alsa

Using audio output: to use audio output in Snap version you must connect the audio with:

$ sudo snap connect pygpt:audio-playback
$ sudo snap connect pygpt:alsa

Connecting IPython in Docker in Snap version:

To use IPython in the Snap version, you must connect PyGPT to the Docker daemon:

$ sudo snap connect pygpt:docker-executables docker:docker-executables
$ sudo snap connect pygpt:docker docker:docker-daemon

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

Python version

The second way to run is to download the source code from GitHub and run the application using the Python interpreter (>=3.10, <3.13). You can also install application from PyPi (using pip install) and we recommend this type of installation.

PyPi (pip)

  1. Create a new virtual environment:

$ python3 -m venv venv
$ source venv/bin/activate
  1. Install from PyPi:

$ pip install pygpt-net
  1. Once installed run the command to start the application:

$ pygpt

Running from source code

Install with pip

  1. Clone git repository or download .zip file:

$ git clone https://github.com/szczyglis-dev/py-gpt.git
$ cd py-gpt
  1. Create a new virtual environment:

$ python3 -m venv venv
$ source venv/bin/activate
  1. Install requirements:

$ pip install -r requirements.txt
  1. Run the application:

$ python3 run.py

Install with Poetry

  1. Clone git repository or download .zip file:

$ git clone https://github.com/szczyglis-dev/py-gpt.git
$ cd py-gpt
  1. Install Poetry (if not installed):

$ pip install poetry
  1. Create a new virtual environment that uses Python 3.10:

$ poetry env use python3.10
$ poetry shell
  1. Install requirements:

$ poetry install
  1. Run the application:

$ poetry run python3 run.py

Tip: you can use PyInstaller to create a compiled version of the application for your system (required version >= 6.0.0).

Troubleshooting

If you have a problems with xcb plugin with newer versions of PySide on Linux, e.g. like this:

qt.qpa.plugin: Could not load the Qt platform plugin "xcb" in "" even though it was found.
This application failed to start because no Qt platform plugin could be initialized. Reinstalling the application may fix this problem.

…then install libxcb on linux:

$ sudo apt install libxcb-cursor0

If you have a problems with audio on Linux, then try to install portaudio19-dev and/or libasound2:

$ sudo apt install portaudio19-dev
$ sudo apt install libasound2
$ sudo apt install libasound2-data
$ sudo apt install libasound2-plugins

Access to camera in Snap version:

To use camera in Vision mode in Snap version you must connect the camera with:

$ sudo snap connect pygpt:camera

Access to microphone in Snap version:

To use microphone in Snap version you must connect the microphone with:

$ sudo snap connect pygpt:audio-record :audio-record

Problems with GLIBC on Linux

If you encounter error:

Error loading Python lib libpython3.10.so.1.0: dlopen: /lib/x86_64-linux-gnu/libm.so.6: version GLIBC_2.35 not found (required by libpython3.10.so.1.0)

when trying to run the compiled version for Linux, try updating GLIBC to version 2.35, or use a newer operating system that has at least version 2.35 of GLIBC.

Access to microphone and audio in Windows version:

If you have a problems with audio or microphone in the non-binary PIP/Python version on Windows, check to see if FFmpeg is installed. If it’s not, install it and add it to the PATH. You can find a tutorial on how to do this here: https://phoenixnap.com/kb/ffmpeg-windows. The binary version already includes FFmpeg.

Windows and VC++ Redistributable

On Windows, the proper functioning requires the installation of the VC++ Redistributable, which can be found on the Microsoft website:

https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist

The libraries from this environment are used by PySide6 - one of the base packages used by PyGPT. The absence of the installed libraries may cause display errors or completely prevent the application from running.

It may also be necessary to add the path C:\path\to\venv\Lib\python3.x\site-packages\PySide6 to the PATH variable.

WebEngine/Chromium renderer and OpenGL problems

If you have a problems with WebEngine / Chromium renderer you can force the legacy mode by launching the app with command line arguments:

$ python3 run.py --legacy=1

and to force disable OpenGL hardware acceleration:

$ python3 run.py --disable-gpu=1

You can also manualy enable legacy mode by editing config file - open the %WORKDIR%/config.json config file in editor and set the following options:

"render.engine": "legacy",
"render.open_gl": false,

Other requirements

For operation, an internet connection is needed (for API connectivity), a registered OpenAI account, and an active API key that must be input into the program. Local models, such as Llama3 do not require OpenAI account and any API keys.

Debugging and logging

Please go to Debugging and Logging section for instructions on how to log and diagnose issues in a more detailed manner.