getwayland

Self-host Wayland - your always-on AI agent - on any Linux box or VPS. Headless web server, reachable from your phone.

npm install -g getwayland
wayland setup     # paste a Flux key (free at fluxrouter.ai) or any OpenAI / Anthropic / Gemini key
wayland start     # then open http://<your-box-ip>:3000 - scan the QR / log in

First boot prints a QR code + admin login right in your terminal. Scan it from your phone and you're in. Set up in 60 seconds.

Requirements: Node 18+ and npm. On a fresh Ubuntu/Debian VPS: sudo apt-get update && sudo apt-get install -y nodejs npm. wayland setup installs everything else it needs (the bun runtime + unzip/curl).

What wayland setup does

• Asks for one provider key. Flux Router is the easy path - one key, every model, best-fit routing (free account at fluxrouter.ai). It's wired as an OpenAI-compatible endpoint (https://api.fluxrouter.ai/v1, model flux-auto), so no engine binary is required. Bring your own OpenAI / Anthropic / Gemini key instead if you prefer.
• Stores the key as an environment variable in ~/.wayland-server/wayland.env - it never touches the OS keychain (which isn't available headless).
• Ensures the bun runtime (offers to install it).
• Optionally installs a systemd service so it runs 24/7 and restarts on reboot.

Keep it private (recommended)

Put it behind Tailscale so it never touches the public internet:

tailscale serve 3000   # reachable only on your tailnet, with HTTPS

Otherwise it binds 0.0.0.0 - front it with a reverse proxy + TLS, and rely on the built-in login + rate limiting.

Commands

| | | |---|---| | wayland setup | Paste a key, wire it, get your login | | wayland start | Run the server (reads the env from setup) | | wayland help | Usage |

Override the data dir with DATA_DIR=…, the port with PORT=….

Notes

• The Wayland Core engine (aionrs) is fetched per-platform on install (Linux/macOS x64+arm64). If the download is skipped, the Flux / API-key path still works - only the Wayland Core agent is unavailable until the engine is present.
• Adding a new key from the web UI on a headless box is a known fast-follow (in-app key storage needs a headless secret backend); for now, add keys by re-running wayland setup.

AGPL-3.0-or-later · FerroxLabs/wayland