Menu

Command Palette

Search for a command to run...

Navigation

HomeGetting StartedGuidesAPI ReferenceCommon ErrorsAcknowledgments

Documentation

Getting Started

Installation
Running Aegis

Aegis

Agents
System
File Structure

Client

Client

Installation

A step-by-step guide to install Aegis on your system.

Prerequisites: Python 3.12.10

Aegis requires Python 3.12.10. Before you begin, check if it’s already installed:

python3 --version

or

python3.12 --version

If the output doesn't show Python 3.12.10, follow the Python Setup Guide to install it and then come back.

Choosing the Right Python Command

Depending on how Python is installed on your system, you may need to use different commands to run Python 3.12 specifically.

On macOS and most Linux systems:

  • python3 usually points to your system's default Python 3 interpreter
  • python3.12 specifically targets Python 3.12 (if installed)

Use:

python3.12

if you have multiple versions installed, or fall back to:

python3

if python3 points to Python 3.12.10.

Python Command

This installation guide assumes your default Python command (python or python3) points to Python 3.12.10. If it doesn’t, substitute the appropriate version-specific command (python3.12 or py -3.12) whenever needed.

Installation

Download the assignment

Start by downloading the assignment ZIP file. Once downloaded, unzip it using your preferred tool. This should create a folder named aegis.

Navigate into the directory

Open a terminal and change into the new directory:

cd <path to aegis>

Run the Setup Script

Aegis requires a set of Python packages to function. Installing these in a virtual environment ensures there are no conflicts with other Python projects or system-wide packages.

You can set everything up with a two commands:

python3 setup.py 
source .venv/bin/activate

If the script was successful, this will:

  • Create a virtual environment named .venv
  • Install the required Python packages
  • Setup the proper client for your system in the client/ directory

Optional: Manual Setup

If the setup script fails or you'd prefer to do it manually:

python3 -m venv .venv
source .venv/bin/activate
pip install -r requirements

Unzip your platform client in the client folder with your preferred method.

Confirm Installation

Before checking if Aegis is installed correctly, make sure you've read the tip below about working inside the virtual environment.

To verify that everything is working as expected, run aegis with one of the methods in the Running Aegis section.

Virtual Environment

Deactivate the virtual environment once you're done working on the assignment:

deactivate

You must reactivate the virtual environment every time you work on the assignment:

source .venv/bin/activate

Once activated, you can simply use the python command—regardless of your system—and it will point to the correct version inside the virtual environment.

If the virtual environment is not active, you may encounter missing dependency errors or use the wrong Python version.