Skip to content

Getting Started

Jump to bottom
Samuele Gallicani edited this page Sep 12, 2026 · 1 revision

This software is designed to run on Linux. It has been tested on Ubuntu 22.04 and 20.04, but it should work on other Linux distributions as well.

This software is built using Python 3.10 so it can be run on any Linux distribution that has python 3.10 or higher version installed. It can be run from source or installed using the provided AppImage or the installer script.

Dependencies

The following dependencies are required to run this software:

  • Python 3.10 or higher
  • libusb-1.0-0
  • usbmuxd
  • every Python module listed in requirements.txt, but in some cases, are shipped in the AppImage, Package or installed with the install.sh script.

Installation

Supported installation methods are:

  • From Release: Noot is built using pyinstaller, so all dependencies are included in the package.
  • From Source: You can clone the repository and install the required dependencies using pip. This method is recommended for developers or users who want to contribute to the project.
  • Install Script: You can run the provided install.sh script to install Noot and its dependencies. This method is recommended for users who want a quick and easy installation. the software will be installed in /opt/noot and a desktop entry will be created in /usr/share/applications/ for easy access.

Please note that the install script will be deprecated in the future, in favor of a more standard installation method, such as using a package manager or Flatpak. The install script is currently provided for convenience, but only because I still haven't created the other installation methods.

In the future, Noot will be available on:

  • Distro's package manager
  • Flatpak
  • AppImage

Depencencies Installation

To install the required dependencies, you can use the following commands:

sudo apt update
sudo apt install -y usbmuxd libusb-1.0-0

Then, enable the usbmuxd service:

sudo systemctl enable usbmuxd
sudo systemctl start usbmuxd

Noot will try to start the usbmuxd service if it is not running, but it is recommended to enable it at startup.

Installation from Source

Simply clone the repository and install the required dependencies using pip:

git clone https://github.com/SamuGallo-06/noot.git
cd noot
pip install -r requirements.txt

Now you can run Noot using the following command inside the cloned repository:

python3 src/main.py

Installation from Release

Download the latest release from the releases page and extract the downloaded archive. Then, open a terminal in the extracted folder and run the following commands:

chmod +x install.sh
sudo ./install.sh

The script will copy the files to /opt/noot, install the required dependencies and Python modules, and enable the usbmuxd service. It will also create a desktop entry in /usr/share/applications/ for easy access.

Clone this wiki locally