Installation

Linux

Clone from Github

Firstly, clone the repository

git clone https://github.com/rly0nheart/octosuite.git

Then change the working directory to octosuite

cd octosuite

After that is done, run the following command to build octosuite:

python setup.py sdist bdist_wheel

This will create a tarball and wheel file in the dist directory.

Now run the following command to install octosuite:

pip install dist/octosuite-[current.version.tag]-py3-none-any.whl

Example:

pip install dist/octosuite-2.2.1-py3-none-any.whl

The installation will take less than a minute to complete.

---

Install from PyPI

Installing octosuite from PyPI is simple and straight forward.

Simply run the following command:

pip install octosuite

This will begin the installation.

Windows

• Download the latest (recommended) Windows .exe file

• Then, double click it to launch

Mac OS

• Download the latest (recommended) OSX .app file

• Move the .app file to the Desktop

• Since it is console based, you will have to open the terminal and enter the following command to launch it:

Desktop/Octosuite.app/Contents/MacOS/Octosuite

Note

The .app file has been tested only on MacOS High Sierra 10.13.6

The .exe file has been tested on Windows 10 and Windows 11

The .app and .exe files are still in beta, and might contain some unnoticed bugs. Feel free to open an issue if that's the case.