Skip to content

Getting Started

Download the latest archive from the Release Page and extract it. Two variants are available: KV (redb, default) and SQL (SQLite, queryable).

Download via CLI

Section titled “Download via CLI”

To get the SQL version, append -sql to the download URL.

Terminal window
curl -L -o spyweb.tar.gz https://dl.spyweb.app/linux && tar -xf spyweb.tar.gz && rm spyweb.tar.gz

Release Structure

Section titled “Release Structure”

The downloaded archive extracts to the following structure:

  • Directorydocs/ Offline documentation
    • …
  • Directoryexamples/ Sample configs and Lua hooks
    • …
  • Directoryjobs/ Folder for per-job configs (optional)
    • …
  • Directoryui/ Dashboard UI files
    • …
  • data Internal database file (created on first run)
  • jobs.toml Single-file config (optional)
  • spyweb Terminal executable
  • spyweb-tray Background tray executable

Two Binaries

Section titled “Two Binaries”

SpyWeb ships as two separate binaries:

Terminal Version (spyweb)

Section titled “Terminal Version (spyweb)”

Best for headless servers, VPS, and cloud environments. Runs in the terminal with real-time logs.

Terminal window
./spyweb start

Press Ctrl+C to quit.

Silent Tray Version (spyweb-tray)

Section titled “Silent Tray Version (spyweb-tray)”

Best for desktop use. Runs in the background without a terminal window, provides quick access via system tray.

Terminal window
# Windows
spyweb-tray.exe

Right-click the tray icon to open the web UI or quit.

Port Configuration

Section titled “Port Configuration”

Customize the port with --port or the SPYWEB_PORT environment variable:

Terminal window
# Linux / macOS
./spyweb start --port 9000


# Or:
SPYWEB_PORT=9000 ./spyweb start


# Windows (PowerShell)
.\spyweb.exe start --port 9000
Section titled “Recommended Workflow”

Use the Terminal Version for initial setup, debugging Lua hooks, and verifying selectors. Once satisfied, switch to the Tray Version for silent background operation.