Installation

Installation & Requirements 🛠️

⚠️ Recommendation: Venom is optimized for WSL2 (Windows Subsystem for Linux). Running directly on Windows (PowerShell/CMD) is not officially supported due to AI library dependencies (uvloop, lancedb).

1. Enable WSL2 (Windows Users)

Open PowerShell as Administrator and run:

powershell wsl --install

Restart your computer. After reboot, complete the Ubuntu setup (username/password) in the terminal window.

2. Prepare Ubuntu Environment

Open your Ubuntu terminal and install core dependencies:

Update system

sudo apt update && sudo apt upgrade -y

Install Python, Git, and build tools

sudo apt install -y python3 python3-pip python3-venv git make build-essential curl

3. Clone Repository

cd ~ git clone [https://github.com/mpieniak01/Venom.git](https://github.com/mpieniak01/Venom.git)

cd Venom

4. Backend Setup (Python)

Create a virtual environment to keep your system clean:

Create venv

python3 -m venv .venv

Activate venv

source .venv/bin/activate

Install dependencies

pip install --upgrade pip pip install -r requirements.txt Note: Always run source .venv/bin/activate when opening a new terminal.

5. Frontend Setup (Node.js)

The Cockpit UI (Next.js) requires Node.js. Install it via nvm:

Install NVM

curl -o- [https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh](https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh) | bash

Reload shell configuration

source ~/.bashrc

Install Node.js LTS

nvm install --lts

Install frontend dependencies

npm --prefix web-next install

✅ Done!

Your environment is ready. Go to Configuration to set up your keys.