Learn Warpdrive · Operator guide

Make it yours.
Run it your way.

Learn how to install, configure, and operate Warpdrive. Start with the shortest path, then open the deeper controls only when the work needs them.

New here? Install the desktop app and begin in Basic Mode. Advanced Mode and the CLI can use the same account and projects later.

Getting Started

Choose the smallest path that matches what you want to do:

I want an assistant and Apps

Install Warpdrive for macOS or Windows, sign in, and stay in Basic Mode.

I want full control

Install the desktop app, switch to Advanced Mode, then create an Instance for a Workspace.

I work in a terminal

Install the platform archive and follow the CLI path. The CLI also supports headless machines.

I want to use another screen

Install the mobile companion or open the web app, then follow Remote Access.

Complete download table

FilePlatformPackage
Warpdrive.dmgmacOSDesktop app, local Gateway, Instance engine, and Local AI setup
WarpdriveSetup.exeWindowsDesktop app, local Gateway, Instance engine, and Local AI setup
warpdrive-gateway-linux.tar.gzLinuxGateway package and Local AI setup without a desktop window
warpdrive-alpha-macos-arm64.tar.gzmacOS Apple SiliconCLI and Instance engine
warpdrive-alpha-macos-x64.tar.gzmacOS IntelCLI and Instance engine
warpdrive-alpha-windows-x64.zipWindows x86-64CLI and Instance engine
warpdrive-alpha-linux-x64.tar.gzLinux x86-64CLI and Instance engine
warpdrive-alpha-linux-arm64.tar.gzLinux ARM64CLI and Instance engine
warpdrive-mobile.apkAndroidMobile companion

Published files live in /downloads/. A build that has not been released yet will not be available at its link.

Verify a download

Each published file has a matching .sha256.txt file beside it. Download both files, then verify before installing:

# macOS or Linux
shasum -a 256 -c Warpdrive.dmg.sha256.txt

# Windows PowerShell — compare this value with the .sha256.txt file
Get-FileHash .\WarpdriveSetup.exe -Algorithm SHA256

Do not install a file when the digest differs. Download it again; if the second copy also differs, report the release.

Basic Mode

Basic Mode is the everyday path. It keeps configuration out of the way and centers the Assistant, your Apps, conversations, and the Store.

  1. Open Assistant and choose the Assistant you want to use.
  2. Describe the App or change you want in plain language.
  3. Open the live result from Apps.
  4. Return to the same conversation when you want a change.

Switch to Advanced Mode when you need to choose an exact Workspace, AI provider, Instance, or Conductor.

Advanced Mode

Advanced Mode exposes the full operating surface: Instances, Workspaces, Studio, Conductors, terminals, files, previews, snapshots, and activity.

  1. Add or choose a Workspace.
  2. Enable the AI providers and tools that should be available.
  3. Create an Instance and choose the Workspace, provider, and optional Orchestrator.
  4. Connect the provider from inside the running Instance.
  5. Work from chat, terminal, files, previews, or a Conductor queue.

Apps

Apps are live, owned results. They can come from a conversation, the Store, or a Workspace you already maintain.

Preview is the technical readiness surface in Advanced Mode. Apps are the owned destination people use.

Assistants

Assistants give Basic Mode a plain-language starting point. In Advanced Mode, the same work is configured through providers, tools, and Instances.

Provider sign-in happens inside a running Instance. Enabling Codex or Claude Code only makes it available. Create or open the Instance, then follow its connection flow.

Instances

An Instance is one running place for AI work. It binds a Workspace to the tools, provider, and optional Orchestrator selected for that job.

Engine requirements

RequirementWhy it is needed
Node.js 20 or newerRuns the packaged CLI and Instance engine.
Docker, Podman, nerdctl, or Apple ContainerRuns Instances. Pairing and relay status do not require a container runtime.
tmux on the hostOptional. Needed only for warpdrive attach in the host terminal.

Engine configuration

Configuration precedence is project .warpdrive/config.json, then global ~/.warpdrive/config.json, then built-in defaults.

SettingDefaultPurpose
WARPDRIVE_CONTAINER_CLIAuto-detectedPin a Docker-compatible executable.
WARPDRIVE_WORKSPACE_ROOTConfig valueDefault folder containing projects.
WARPDRIVE_API_PORT7777Loopback port used by the local engine.
WARPDRIVE_HOST_HOMEUser homeRoot for Warpdrive state, configuration, and pairings.
WARPDRIVE_TMUX_SOCKETWarpdrive-ownedKeeps Instance sessions separate from personal tmux sessions.

Extra mounts belong in the project or global configuration. Host paths must be absolute:

{
  "containerCli": "podman",
  "sandbox": {
    "mounts": [
      { "hostPath": "/Users/you/shared", "containerPath": "/data", "readOnly": true }
    ]
  }
}

Conductors

Conductors coordinate work across one or more agents. Use one when a goal has repeatable steps, review gates, retries, or work that can run in parallel.

  1. Open Studio and choose or create an Orchestrator.
  2. Add the agents, sequence, limits, and approval points.
  3. Save the Orchestrator and attach it when creating an Instance.
  4. Give the Conductor a concrete goal, then follow progress in the conversation and Activity.

Use a direct Assistant conversation for a single small task. Use a Conductor when coordination itself is part of the work.

Gateway

The Gateway is the selected access boundary for clients. It authenticates the session and routes requests to the service that owns the work. It does not become a copy of your Workspace.

How the components fit

The desktop package starts a local Gateway on 127.0.0.1:8787 and a local engine on 127.0.0.1:7777. A hosted Gateway terminates browser or phone traffic over HTTPS while paired machines make outbound relay connections.

Hosted Gateway configuration

Environment variableRequirement
GATEWAY_DEPLOYMENT_MODEUse hosted, public, or production for an exposed deployment.
GATEWAY_REALM_IDStable backend-owned Gateway GUID. The legacy variable name remains part of the API contract.
GATEWAY_REALM_DISPLAY_NAMEUser-visible name. Never use it as an identifier.
AGENT_CP_JWT_KEYAt least 32 characters. Do not reuse a placeholder or another signing key.
IDENTITY_JWT_KEYAt least 32 characters and distinct from the control-plane key.
GATEWAY_REQUIRE_AUTHKeep enabled for hosted and public deployments.
GATEWAY_REMOTE_RELAY_STATE_PATHWritable durable storage included in backups.
GATEWAY_DEVICE_PAIRING_CODE_TTL_SECONDSShort-lived pairing codes; default 600.
GATEWAY_REMOTE_COMMAND_TTL_SECONDSShort-lived remote commands; default 120.

Terminate TLS before the Gateway, expose only the intended HTTPS origin, restrict trusted browser origins, and back up relay state with Gateway logs.

CLI

The CLI is the terminal-first interface for creating, running, attaching to, and remotely connecting Instances. The complete CLI guide contains every command and flag.

Install and add it to PATH

tar -xzf warpdrive-alpha-macos-arm64.tar.gz -C ~/
cd ~/warpdrive-alpha-*
./install.sh
warpdrive --help

The installer links warpdrive into /usr/local/bin when writable, otherwise ~/.local/bin. If needed, add the latter to your shell:

export PATH="$HOME/.local/bin:$PATH"

Keep the extracted archive together. The launcher resolves its runtime beside itself. On Windows, extract the zip and run Install Warpdrive.bat.

Core commands

CommandPurpose
warpdriveOpen the terminal UI.
warpdrive buildCreate or rebuild the Instance for the current Workspace.
warpdrive attachAttach to the current Workspace's running session.
warpdrive serveRun the engine headless and log to standard output.
warpdrive remote …Pair a machine, approve bindings, and run its relay.
warpdrive local-ai …Configure a model that runs on this machine.

Headless installation

  1. Install Node.js 20 or newer and a supported container runtime.
  2. Download the archive for the server architecture and verify its checksum.
  3. Extract it to a permanent folder and run ./install.sh --yes.
  4. Run warpdrive serve in the foreground once and confirm the engine listens on loopback.
  5. Create a systemd, launchd, or equivalent service under the same OS user that owns ~/.warpdrive/. Set it to restart on failure and keep the service logs.
  6. For remote control, complete the pairing and binding steps.

Local AI

Local AI lets supported agents use a model running on your hardware. Open Settings → Local AI, review the model Warpdrive recommends for the machine, then select Set up on this machine.

From the CLI, use:

warpdrive local-ai setup
warpdrive local-ai status

The Local AI guide covers hardware sizing, model choice, existing Ollama or LM Studio installs, ports, checksums, privacy, and troubleshooting.

Remote Access

A paired machine opens one outbound authenticated relay to the selected Gateway. It does not expose the local engine, container runtime, SSH, or preview ports to the public internet.

  1. Create a pairing code in Warpdrive. Codes expire after 10 minutes.
  2. Redeem the code on the machine that will run work:
warpdrive remote pair \
  --gateway=https://gateway.example.com \
  --code=XXXX-XXXX-XXXX-XXXX-XXXX

Approve exact backend Workspace and provider IDs before remote commands may use them:

warpdrive remote bind-workspace \
  --workspace-id=<backend-id> \
  --path=/absolute/path/to/project

warpdrive remote bind-provider \
  --provider-id=<backend-id> \
  --provider=claude-code

Start and inspect the relay:

warpdrive remote relay
warpdrive remote status

# macOS: keep the relay running after login and across reboots
warpdrive remote install-agent

Use warpdrive remote relay --once to diagnose one foreground connection. Use warpdrive remote uninstall-agent to remove the macOS LaunchAgent.

Security

Troubleshooting

SymptomWhat to check
warpdrive is not foundRe-run the installer. Add ~/.local/bin to PATH if the installer could not use /usr/local/bin.
Node.js requirement errorInstall Node.js 20 or newer, open a new shell, and confirm with node --version.
Build fails at the container checkStart Docker or Podman. Use WARPDRIVE_CONTAINER_CLI when the executable is not auto-detected.
Port 7777 is in useAn engine may already be running. Reuse it or set a different WARPDRIVE_API_PORT.
No Instance matches the current folderChange to the Workspace root or create an Instance for that path.
Relay will not reconnectRun warpdrive remote status, then warpdrive remote relay --once to read the foreground error.
Local AI is not availableUse an installed desktop or Gateway package. A browser-only client cannot host the local model.
Checksum mismatchDelete the file, download it again, and stop if the second digest also differs.

For more detail, use the CLI troubleshooting table or the Local AI troubleshooting table.