EFXCI-Agent Installation
========================

This page describes how to install and run the EFXCI-Agent.  
Currently, only the **build agent** type is supported. Other agent types (e.g., test) are under development.

.. contents::
   :depth: 2
   :local:

Prerequisites
-------------

- Must be run as **root user**
- **Python**: Version 3.12 or above installed on the machine
- **EFXCI-System**: A running EFXCI-System instance (for agent connectivity)

Installation
------------

1. Clone the agent repository:

   .. code-block:: bash

      git clone git@github.com:electrifex/efxci-agent.git ~/efxci-agent
      cd ~/efxci-agent

2. Create a Python virtual environment and activate it:

   .. code-block:: bash

      python3 -m venv venv
      source venv/bin/activate

3. Install the required dependencies:

   .. code-block:: bash

      pip install -r requirements.txt

Running a Build Agent
---------------------

To start a build agent, run:

.. code-block:: bash

   python3 -m src.manager --agent-type build \
       --machine-type machinetype \
       --nats-url nats://<ip-address-of-efxci-system>:4222

- Replace ``<ip-address-of-efxci-system>`` with the controller node IP where EFXCI-System is running.