Installing Apio

This page explains how to install Apio for end users. If you’re an Apio developer, see the Apio Development Environment page.

To install Apio, select your desired method from the Instructions column below and follow the instructions.

Method	Description	Instructions
Pip	Installation using the Python `pip` command. This method requires Python to be preinstalled on your system.	macOS Apple Silicon macOS Intel Silicon Linux X86-64 Linux ARM-64 Windows
Installer	Installation using an installer wizard.	macOS Apple Silicon Windows
Debian	Installation using a Debian package and the `dpkg` package manager.	Linux X86-64
Bundle	Installation using a file archive that contains all the necessary files to run Apio.	macOS Apple Silicon Linux X86-64 Windows

macOS Apple Silicon¶

Install using a Pip package ¶

To install Apio on macOS Apple Silicon using a Pip package, follow these steps:

Verify that you have Python installed by running:
```
python --version
```

Install Apio using pip:

pip install --force-reinstall -U git+https://github.com/fpgawars/apio.git@develop

In a new shell window, run the following command to test your installation:
```
apio
```

If necessary, add the directory of the installed apio binary to your $PATH.

Install using an installer ¶

To install Apio on macOS Apple Silicon using an installer, follow these steps:

From the latest release download the installer file:

apio-darwin-arm64-[version]-[date]-installer.pkg

Run the following command to allow the unsigned Apio installer to run:

xattr -d com.apple.quarantine apio-darwin-arm64-*-installer.pkg 2>&1 | grep -v "No such xattr"

Double-click on the installer file and follow the instructions.
In a new shell window, run the following command to test your installation:
```
apio
```

NOTE: The installer creates the file /etc/paths.d/Apio to export automatically the path of the installed app.

Install using a file bundle ¶

To install Apio on macOS Apple Silicon using a file bundle, follow these steps:

From the latest release download the file bundle:

apio-darwin-arm64-[version]-[date]-bundle.tgz

Run the following command to allow the unsigned Apio app to run.

xattr -d com.apple.quarantine apio-darwin-arm64-*-bundle.tgz 2>&1 | grep -v "No such xattr"

After you run the xattr command, double click on the bundle file to uncompress it and reveal the apio directory with the application files.
While in the apio directory, run the following command to test your installation:
```
./apio
```
Move the apio directory to a location of your choosing and add it to your $PATH.

macOS Intel Silicon¶

Install using a Pip package ¶

To install Apio on macOS Intel Silicon using a Pip package, follow these steps:

Verify that you have Python installed by running:
```
python --version
```

Install Apio using pip:

pip install --force-reinstall -U git+https://github.com/fpgawars/apio.git@develop

In a new shell window, run the following command to test your installation:
```
apio
```

If necessary, add the directory of the installed apio binary to your $PATH.

Linux X86-64¶

To install Apio on Linux X86-64 using a Pip package, follow these steps:

Install using a Pip package ¶

Verify that you have Python installed by running:
```
python --version
```

Install Apio using pip:

pip install --force-reinstall -U git+https://github.com/fpgawars/apio.git@develop

In a new shell window, run the following command to test your installation:
```
apio
```

If necessary, add the directory of the installed apio binary to your $PATH.

Install a Debian package ¶

To install Apio on Linux X86-64 using a Debian package, follow these steps:

From the latest release download the Debian package file:
```
apio-linux-x86-64-[version]-[date]-debian.deb
```
In the directory where you downloaded the package, install it using:
```
sudo dpkg -i ./apio-linux-x86-64-[version]-[date]-debian.deb
```
In a new shell window, run the following command to test your installation:
```
apio
```

Install using a file bundle ¶

To install Apio on Linux X86-64 using a file bundle, follow these steps:

From the latest release download the file bundle:

apio-linux-x86-64-[version]-[date]-bundle.tgz

Uncompress the bundle file to reveal the apio directory with the application files.
```
tar -xzf apio-linux-x86-64-*-bundle.tgz
```
While in the apio directory, run the following command to test your installation:
```
./apio
```
Move the apio directory to a location of your choosing and add it to your $PATH.

Linux ARM-64¶

To install Apio on Linux ARM-64 using a Pip package, follow these steps:

Install using a Pip package ¶

Verify that you have Python installed by running:
```
python --version
```

Install Apio using pip:

pip install --force-reinstall -U git+https://github.com/fpgawars/apio.git@develop

In a new shell window, run the following command to test your installation:
```
apio
```

If necessary, add the directory of the installed apio binary to your $PATH.

Windows X86-64¶

Install using a Pip package ¶

To install Apio on Windows X86-64 using a Pip package, follow these steps:

Verify that you have Python installed by running:
```
python --version
```

Install Apio using pip:

pip install --force-reinstall -U git+https://github.com/fpgawars/apio.git@develop

In a new command window, run the following command to test your installation:
```
apio
```

If necessary, add the directory of the installed apio binary to your $PATH.

Install using an installer ¶

To install Apio on Windows X86-64 using an installer, follow these steps:

From the latest release download the installer file:

apio-windows-amd64-[version]-[date]-installer.exe

Right click on the installer file, select properties, check the Unblock checkbox and press OK. This will allow you to run the unsigned installer.
After enabling the installer for execution in the previous step, double click on it and follow the installer wizard.
In a new command window, run the following command to test your installation:
```
apio
```

Install using a file bundle ¶

To install Apio on Windows X86-64 using a file bundle, follow these steps:

From the latest release download the file bundle:

apio-windows-amd64-[version]-[date]-bundle.zip

Right click on the bundle file , select properties, check the Unblock checkbox and press OK. This will allow you to run the the unsigned Apio app.
Uncompress the bundle to reveal the apio directory with the application files.
While in the apio directory, run the following command to test your installation (this will run apio.exe):
```
.\apio
```
Move the apio directory to a location of your choosing and add it to your %PATH%.