Skip to content

installation.md

Latest commit

 

History

History
151 lines (108 loc) · 3.43 KB

installation.md

File metadata and controls

151 lines (108 loc) · 3.43 KB
Raw

Installation Guide

Prerequisites

FORGE requires two main dependencies:

  1. Rust (1.91.0 or newer)
  2. Docker (20.10.0 or newer; tested on 28.2.2)

Installing Docker

Windows

  1. Download Docker Desktop for Windows
  2. Run the installer and follow the setup wizard
  3. Restart your computer
  4. Verify installation: docker --version

With Package Manager:

# With Chocolatey
choco install docker-desktop

macOS

  1. Download Docker Desktop for Mac
  2. Drag Docker.app to Applications folder
  3. Launch Docker Desktop
  4. Verify installation: docker --version

With Package Manager:

# With Homebrew
brew install --cask docker

Linux (Ubuntu/Debian)

# Update package index
sudo apt update

# Install Docker
sudo apt install docker.io

# Start Docker service
sudo systemctl start docker
sudo systemctl enable docker

# Add your user to docker group (optional, to run without sudo)
sudo usermod -aG docker $USER

# Verify installation
docker --version

Installing Rust

# Install Rust using rustup (all platforms)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# On Windows, download from: https://rustup.rs/

# Verify installation
rustc --version
cargo --version

Installing FORGE

Once Docker and Rust are installed, you can install FORGE:

With Cargo (from crates.io)

cargo install forge-runner

Install from GitHub

# Install directly from GitHub
cargo install --git https://github.com/0xReLogic/Forge.git

From Source (for development)

# Clone the repository
git clone https://github.com/0xReLogic/Forge.git
cd Forge

# Build the project
cargo build --release

# The binary will be at: target/release/forge-runner

Pre-compiled Binaries

Download from the releases page.

Linux (amd64)

curl -L https://github.com/0xReLogic/Forge/releases/latest/download/forge-linux-amd64 -o forge
# or: wget -O forge https://github.com/0xReLogic/Forge/releases/latest/download/forge-linux-amd64
chmod +x forge
./forge --version
# Optional (install to PATH): sudo install -m 755 forge /usr/local/bin/forge

macOS (amd64)

curl -L https://github.com/0xReLogic/Forge/releases/latest/download/forge-macos-amd64 -o forge
# or: wget -O forge https://github.com/0xReLogic/Forge/releases/latest/download/forge-macos-amd64
chmod +x forge
./forge --version
# Optional (install to PATH): sudo install -m 755 forge /usr/local/bin/forge

Windows (PowerShell)

Invoke-WebRequest -Uri https://github.com/0xReLogic/Forge/releases/latest/download/forge.exe -OutFile forge.exe
.\forge.exe --version
# Optional: move forge.exe into a directory on PATH (or add its directory to PATH)

Verification

After installation, verify everything is working:

# Check FORGE version
forge --version

# Check Docker is running
docker ps

# Check Rust installation
cargo --version

Optional: VSCode Setup

If you use VSCode, these extensions can improve your workflow:

  • YAML (redhat.vscode-yaml) - Syntax highlighting for forge.yaml
  • Docker (ms-azuretools.vscode-docker) - Docker management

Note: These extensions are optional. FORGE works from any terminal.