How to Install PyInstaller

PyInstaller is a normal Python package. You can download the archive from PyPi, but it is easier to install using pip where is is available, for example:

pip install pyinstaller

or upgrade to a newer version:

pip install --upgrade pyinstaller

To install the current development version use:

pip install

Installing from the archive

If pip is not available, download the compressed archive from PyPI. If you are asked to test a problem using the latest development code, download the compressed archive from the develop branch of PyInstaller Downloads page.

Expand the archive. Inside is a script named Execute python install with administrator privilege to install or upgrade PyInstaller.

For platforms other than Windows, GNU/Linux and macOS, you must first build a bootloader program for your platform: see Building the Bootloader. After the bootloader has been created, use python install with administrator privileges to complete the installation.

Verifying the installation

On all platforms, the command pyinstaller should now exist on the execution path. To verify this, enter the command:

pyinstaller --version

The result should resemble 4.n for a released version, and 4.n.dev0-xxxxxx for a development branch.

If the command is not found, make sure the execution path includes the proper directory:

  • Windows: C:\PythonXY\Scripts where XY stands for the major and minor Python version number, for example C:\Python38\Scripts for Python 3.8)

  • GNU/Linux: /usr/bin/

  • macOS (using the default Apple-supplied Python) /usr/bin

  • macOS (using Python installed by homebrew) /usr/local/bin

  • macOS (using Python installed by macports) /opt/local/bin

To display the current path in Windows the command is echo %path% and in other systems, echo $PATH.

Installed commands

The complete installation places these commands on the execution path:

If you do not perform a complete installation (installing via pip or executing, these commands will not be installed as commands. However, you can still execute all the functions documented below by running Python scripts found in the distribution folder. The equivalent of the pyinstaller command is PyInstaller-folder/ The other commands are found in PyInstaller-folder/cliutils/ with meaningful names (, etc.)