Installation

Prerequisites

To be able to use all features of MatrixCtl you need to have:

• Python 3.8 or higher on your machine.

• deployed the instance of synapse with the spantaleev/matrix-docker-ansible-deploy ansible playbook.

• the access token of your administrator account.

• SSH access to the matrix server from your machine with a public key.

Note

If you don’t need all features, you are good to start with python 3.8. This is the only mandatory prerequisite of this list.

See also

We have a guide, how you accomplish the rest of the list in the Getting Started guide.

Installation with pip

To install MatrixCtl run pip install matrixctl with a Python>=3.8. If you already have a version of MatrixCtl installed, you can upgrade it with pip install --upgrade matrixctl.