Installation

Agentic Installation

An agent can perform all the required and recommended steps of this page automatically, driven by the matr1x-install skill. Start an agent of your choice in the target directory of the installation, e.g. an empty one or an existing folder with your own drivers, and point it to the skills page, for example:

Please install matr1x as described in the matr1x-install skill on
https://andythomas.github.io/matr1x/skills.html

Basic Installation

Please use Github Desktop to clone the repository. We recommend to install uv, because it simplifies the installation and downloads the package versions we utilize for testing. Then, two more steps are required for the installation:

  1. Sychronize uv in the cloned directory
  2. Activate the virtual environment
Always keep uv updated.

In case of errors during the installation or unexpected behavior at the first run, always keep uv updated.

  1. Follow the uv installation procedure.
  2. Execute uv sync
  3. Execute .venv\Scripts\activate.bat in a command prompt or PowerShell window.

The system Python version is quite old (3.9 in Sequoia) and cannot be used to install the packages.

  1. Follow the uv installation procedure.
  2. Execute uv sync
  3. Execute source .venv/bin/activate

The package can be installed on Linux systems (well tested) and also on BSD systems (not tested regularly) and likely other Posix compliant systems. We recommend using a virtual environment. First, make sure you have the required system packages installed.

sudo apt install qt6-base-dev

Then, continue the basic installation:

  1. Follow the uv installation procedure.
  2. Execute uv sync
  3. Execute source .venv/bin/activate

If an optional feature is required for your setup use uv sync --extra <FEATURE> instead.

Desktop Integration

After the installation, any application launch will perform the desktop integration, i.e. provide application icons, start menu entries and such. For example, please execute

  • matrix-preview

A command line tool can carry out the integration as well: Please start matrix-di for integration and matrix-di -u for removal.

matrix-script might need a few moments at the first start to download the editor assets.