Deployment Guide

Quick Start: Halberd can be up and running in under 5 minutes! The setup process is straightforward and works seamlessly across Windows, macOS, and Linux.

System Requirements

• Python: Version 3.8.x >= 3.12.x
• Memory: 2GB minimum (4GB recommended)
• Storage: 1GB free space
• Browser: Any modern browser (Chrome, Firefox, Edge, or Safari)

Pre-Installation Steps (2 minutes)

1. Install Python if not already installed:
   • Windows installer
   • macOS installer
   • Linux source (or use package manager)
2. Get Halberd - choose one:
   • Using Git: git clone https://github.com/vectra-ai-research/Halberd.git
   • Direct download: Download ZIP

Installation Guide (~3 minutes)

Windows

# 1. Navigate to Halberd directory
cd Halberd

# 2. Create and activate virtual environment
python -m venv venv
.\venv\Scripts\activate

# 3. Install dependencies
pip install -r requirements.txt

# 4. Install Azure CLI (required for Azure modules)
# Download and run from: https://aka.ms/installazurecliwindowsx64

# 5. Launch Halberd
python run.py

# 6. Access the interface at http://127.0.0.1:8050/

Optionally, to use the Halberd Attack Agent, checkout the setup here.

macOS/Linux

# 1. Navigate to Halberd directory
cd Halberd

# 2. Create and activate virtual environment
python3 -m venv venv
source venv/bin/activate

# 3. Install dependencies
pip install -r requirements.txt

# 4. Install Azure CLI:
# macOS:
brew update && brew install azure-cli
# Linux (Ubuntu/Debian):
curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash

# 5. Launch Halberd
python3 run.py

# 6. Access the interface at http://127.0.0.1:8050/

Optionally, to use the Halberd Attack Agent, checkout the setup here.

Setup Halberd Attack Agent

Create a .env file in the Halberd project root directory and add Anthropic API key to it:

# Windows (cmd):
echo ANTHROPIC_API_KEY=your_api_key_here > .env

# Windows (PowerShell):
"ANTHROPIC_API_KEY=your_api_key_here" | Out-File -FilePath .env -Encoding utf8

# Linux/macOS:
echo "ANTHROPIC_API_KEY=your_api_key_here" > .env

# Alternatively, create the file manually in your preferred text editor and add:
ANTHROPIC_API_KEY=your_api_key_here

Troubleshooting Tips

• Ensure Python is in your system PATH
• For virtual environment issues, try deactivating and reactivating
• Azure CLI issues? Check the official installation guide
• Port occupied - Try launching halberd on a different port. Check port usage using netstat

Platform-Specific Notes

• Windows: Run PowerShell or Command Prompt as administrator if needed
• macOS: Homebrew is recommended for Azure CLI installation
• Linux: Different distributions may have varying Azure CLI installation methods. Check the distribution-specific guide

Need help? Check our GitHub Issues or start a discussion in Halberd community.