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.

# Pull and run the latest version
docker run -d --name halberd -p 8050:8050 ghcr.io/vectra-ai-research/halberd:main

# Access the web interface
open http://localhost:8050

git clone https://github.com/vectra-ai-research/Halberd.git
cd Halberd
docker compose up -d

# With persistent storage
docker run -d \
  --name halberd \
  -p 8050:8050 \
  -v $(pwd)/data:/app/local \
  -v $(pwd)/output:/app/output \
  -v $(pwd)/reports:/app/report \
  ghcr.io/vectra-ai-research/halberd:latest

# Custom configuration
docker run -d \
  --name halberd \
  -p 8080:8080 \
  -e HALBERD_HOST=0.0.0.0 \
  -e HALBERD_PORT=8080 \
  ghcr.io/vectra-ai-research/halberd:v2.2.0

• ghcr.io/vectra-ai-research/halberd:main - Latest build
• ghcr.io/vectra-ai-research/halberd:latest - Latest stable release
• ghcr.io/vectra-ai-research/halberd:v2.2.0 - Specific version

• Python: Version 3.8.x >= 3.12.x
• Memory: 4GB minimum (8GB recommended)
• Storage: 1GB free space

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

# 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, enable Halberd Attack Agent

# 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 Halberd at http://127.0.0.1:8050/

Optionally, enable Halberd Attack Agent

1. Generate API key from Anthropic's website
2. Click on the settings icon in the Halberd navigation bar to access the app settings
3. Add & save your Anthropic API key.
4. Your Halberd Attack Agent is ready!

• Ensure Python is in your system PATH
• Ensure you are using python version 3.8>=3.12
• 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

• 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.