Skip to content

Deployment Guide

Arpan Sarkar edited this page Apr 14, 2024 · 6 revisions

Deploying Halberd is super easy (but hey its ok if its a star-crossed day 🤷🏻‍♂️).

Prerequisites

Halberd can be installed in few minutes. Halberd is supported on Linux, macOS & Windows. Checkout the deployment guide for each platform.

Linux / macOS Deployment

1. Download or Clone from GitHub

$ git clone https://github.com/vectra-ai-research/Halberd.git

2. Move to Halberd Directory

$ cd Halberd

3. Create & Activate Python Virtual Environment

$ python3 -m venv venv

$ source venv/bin/activate

4. Install dependencies

$ pip install -r requirements.txt

5. Launch Halberd

$ python3 Halberd.py

Windows Deployment

1. Download or Clone from GitHub

$ git clone https://github.com/vectra-ai-research/Halberd.git

2. Move to Halberd Directory

$ cd Halberd

3. Create & Activate Python Virtual Environment

$ python3 -m venv venv

$ .\venv\Scripts\activate

4. Install dependencies

$ pip install -r requirements.txt

5. Launch Halberd

$ python Halberd.py