Getting Started

Initial configuration

  1. We will send you your licence key. If you did not get it, please contact us at

  2. Install Aiviro package using pip, see Installation section.

  3. Set-up your client-id and api-key using aiviro-cli tool.

# set-up client-id & api-key
(venv) aiviro-cli config login --client-id <your-client-id> --api-key <your-api-key>
  1. You’re ready to go! You can check your overall configuration using aiviro-cli tool. For more detailed configuration options, see Global Configuration section.

(venv) aiviro-cli config print

Installing Aiviro


Aiviro requires Python 64-bit version, we recommend to you to use Python 3.10 or 3.11 version. Currently supported Python versions are 3.9, 3.10, 3.11.

Supported OS with respective CPU architecture








To install aiviro package via pip, run:

# create virtual environment
python -m venv venv

# activate virtual environment
# linux
source venv/bin/activate
# windows

# install aiviro
(venv) pip install -i aiviro

Optional dependencies

To work with different robots, you have to install some additional dependencies.

  • Web Robot - for using Web Robot you have to install chrome-driver.

  • RDP Robot - for using RDP Robot (Remote Desktop Protocol) you have to install our PyFreeRDP python package.

# install aiviro & pyfreerdp at once
pip install -i aiviro[rdp]

Aiviro also ships with a number of optional modules, which can be installed using “extras” syntax:

pip install -i "aiviro[extra_1,extra_2]"

Example of extra packages include:

  • all_extras: includes all of the optional dependencies

  • rdp: tools for using RDP Robot - see RDPRobot

  • pdf: tools for working with PDF files - see PDFRobot

  • dxf: tools for working with DXF files

  • email: tools for working with IMAP, SMTP protocols or Outlook - see Email

  • prefect: tools for working with Prefect flows - see Flow Example

  • codes: tools to extract QR & Bar codes - see QR, Bar Codes

  • reader: tools for using aiviro-cli reader scripts & Universal Parser - see Reader Scripts, Reader

  • excel: tools to read Excel files - see Excel

  • deploy: tools for deploying Aiviro modules as web applications - see Deployment as Web App


To update aiviro & additional dependencies, we use similar command as for installation, we just need to add -U option.

# update aiviro
pip install -i -U aiviro

# update aiviro & pyfreerdp at once
pip install -i -U aiviro[rdp]

To update chrome-driver, you have to download a new version of it and reinstall it.

In case you want to update Aiviro version in server deployment, refer to Update Agent section.