[ Getting started ]

Install

Native installer, source build, or Docker. Pick what fits.

Pre-built installers

Recommended for most users. Includes sidecar + UI; auto-installs OpenClaw on first launch.

macOS (Apple Silicon + Intel)

AgentiqFlow.dmg — drag to /Applications
AgentiqFlow.pkg — installer with autostart hook

First launch may show "AgentiqFlow can't be opened because Apple cannot check it for malicious software." Right-click the app → Open → confirm. Notarization in progress.

For iMessage, grant Full Disk Access to AgentiqFlow.app in System Settings → Privacy & Security so it can read ~/Library/Messages/chat.db.

Windows

AgentiqFlow-setup.exe — NSIS installer

SmartScreen may flag the unsigned binary. Click More info → Run anyway. Installs to %LOCALAPPDATA%\AgentiqFlow, registers a Start menu entry.

Linux

AgentiqFlow.AppImage — x86_64
AgentiqFlow-aarch64.AppImage — ARM64 (Raspberry Pi 4/5, 64-bit Pi OS)
AgentiqFlow-armhf.AppImage — 32-bit ARM (Raspberry Pi 3, Pi Zero 2 W, 32-bit Pi OS)

chmod +x AgentiqFlow-*.AppImage
./AgentiqFlow-*.AppImage

Optional: integrate with your menu via appimaged or AppImageLauncher.

From source

For contributors, customizers, and air-gapped deployments.

Prerequisites

Node 20+ — node -v
npm 10+ — bundled with Node
git — to clone

Setup

git clone https://github.com/agentiqflow/agentiqflow.git
cd agentiqflow
./setup.sh           # install + build + start :8858
# or
./setup.sh dev       # Vite + HMR on :5173
./setup.sh docker    # docker compose up
./setup.sh stop      # stop the prod server

The script is idempotent — rerunning skips work that's already done.

Manual

npm install
npm run build
npm start            # → http://localhost:8858

Docker

Single container, port 8858. Persistent state in a named volume.

npm run docker:up        # build + start
npm run docker:logs      # tail
npm run docker:down      # stop

Compose file: docker/docker-compose.yml. Override the port via PORT=9000 npm run docker:up.

Where state lives

Everything stays on your machine.

data/secrets.env — vault keys + tokens (chmod 600)
data/agents/ — per-agent memory, history
data/channels.json — channel adapter configs
data/cron.json — scheduled jobs
data/workflows/ — saved workflow graphs

For a complete portable export — server data/ directory plus the browser vault + memory + threads — use Backup & Restore in the app. One .json.gz, one file, full state.

Updating

Native installers auto-check update.agentiqflow.ai on launch and prompt when a new release ships. To opt out, toggle Check for updates in Settings → Updates.

Source installs: git pull && ./setup.sh.

Uninstall

macOS: drag /Applications/AgentiqFlow.app to Trash; delete ~/Library/Application Support/AgentiqFlow
Windows: Settings → Apps → AgentiqFlow → Uninstall
Linux: delete the AppImage and ~/.config/agentiqflow/
Source: ./setup.sh stop && rm -rf node_modules dist data

Stuck? Discord · [email protected]