I want an assistant and Apps
Install Warpdrive for macOS or Windows, sign in, and stay in Basic Mode.
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.
Choose the smallest path that matches what you want to do:
Install Warpdrive for macOS or Windows, sign in, and stay in Basic Mode.
Install the desktop app, switch to Advanced Mode, then create an Instance for a Workspace.
Install the platform archive and follow the CLI path. The CLI also supports headless machines.
Install the mobile companion or open the web app, then follow Remote Access.
| File | Platform | Package |
|---|---|---|
| Warpdrive.dmg | macOS | Desktop app, local Gateway, Instance engine, and Local AI setup |
| WarpdriveSetup.exe | Windows | Desktop app, local Gateway, Instance engine, and Local AI setup |
| warpdrive-gateway-linux.tar.gz | Linux | Gateway package and Local AI setup without a desktop window |
| warpdrive-alpha-macos-arm64.tar.gz | macOS Apple Silicon | CLI and Instance engine |
| warpdrive-alpha-macos-x64.tar.gz | macOS Intel | CLI and Instance engine |
| warpdrive-alpha-windows-x64.zip | Windows x86-64 | CLI and Instance engine |
| warpdrive-alpha-linux-x64.tar.gz | Linux x86-64 | CLI and Instance engine |
| warpdrive-alpha-linux-arm64.tar.gz | Linux ARM64 | CLI and Instance engine |
| warpdrive-mobile.apk | Android | Mobile companion |
Published files live in /downloads/. A build that has not been released yet will not be available at its link.
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 SHA256Do not install a file when the digest differs. Download it again; if the second copy also differs, report the release.
Basic Mode is the everyday path. It keeps configuration out of the way and centers the Assistant, your Apps, conversations, and the Store.
Switch to Advanced Mode when you need to choose an exact Workspace, AI provider, Instance, or Conductor.
Advanced Mode exposes the full operating surface: Instances, Workspaces, Studio, Conductors, terminals, files, previews, snapshots, and activity.
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 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.
An Instance is one running place for AI work. It binds a Workspace to the tools, provider, and optional Orchestrator selected for that job.
| Requirement | Why it is needed |
|---|---|
| Node.js 20 or newer | Runs the packaged CLI and Instance engine. |
| Docker, Podman, nerdctl, or Apple Container | Runs Instances. Pairing and relay status do not require a container runtime. |
| tmux on the host | Optional. Needed only for warpdrive attach in the host terminal. |
Configuration precedence is project .warpdrive/config.json, then global ~/.warpdrive/config.json, then built-in defaults.
| Setting | Default | Purpose |
|---|---|---|
WARPDRIVE_CONTAINER_CLI | Auto-detected | Pin a Docker-compatible executable. |
WARPDRIVE_WORKSPACE_ROOT | Config value | Default folder containing projects. |
WARPDRIVE_API_PORT | 7777 | Loopback port used by the local engine. |
WARPDRIVE_HOST_HOME | User home | Root for Warpdrive state, configuration, and pairings. |
WARPDRIVE_TMUX_SOCKET | Warpdrive-owned | Keeps 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 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.
Use a direct Assistant conversation for a single small task. Use a Conductor when coordination itself is part of the work.
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.
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.
| Environment variable | Requirement |
|---|---|
GATEWAY_DEPLOYMENT_MODE | Use hosted, public, or production for an exposed deployment. |
GATEWAY_REALM_ID | Stable backend-owned Gateway GUID. The legacy variable name remains part of the API contract. |
GATEWAY_REALM_DISPLAY_NAME | User-visible name. Never use it as an identifier. |
AGENT_CP_JWT_KEY | At least 32 characters. Do not reuse a placeholder or another signing key. |
IDENTITY_JWT_KEY | At least 32 characters and distinct from the control-plane key. |
GATEWAY_REQUIRE_AUTH | Keep enabled for hosted and public deployments. |
GATEWAY_REMOTE_RELAY_STATE_PATH | Writable durable storage included in backups. |
GATEWAY_DEVICE_PAIRING_CODE_TTL_SECONDS | Short-lived pairing codes; default 600. |
GATEWAY_REMOTE_COMMAND_TTL_SECONDS | Short-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.
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.
tar -xzf warpdrive-alpha-macos-arm64.tar.gz -C ~/
cd ~/warpdrive-alpha-*
./install.sh
warpdrive --helpThe 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.
| Command | Purpose |
|---|---|
warpdrive | Open the terminal UI. |
warpdrive build | Create or rebuild the Instance for the current Workspace. |
warpdrive attach | Attach to the current Workspace's running session. |
warpdrive serve | Run 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. |
./install.sh --yes.warpdrive serve in the foreground once and confirm the engine listens on loopback.~/.warpdrive/. Set it to restart on failure and keep the service logs.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 statusThe Local AI guide covers hardware sizing, model choice, existing Ollama or LM Studio installs, ports, checksums, privacy, and troubleshooting.
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.
warpdrive remote pair \
--gateway=https://gateway.example.com \
--code=XXXX-XXXX-XXXX-XXXX-XXXXApprove 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-codeStart and inspect the relay:
warpdrive remote relay
warpdrive remote status
# macOS: keep the relay running after login and across reboots
warpdrive remote install-agentUse warpdrive remote relay --once to diagnose one foreground connection. Use warpdrive remote uninstall-agent to remove the macOS LaunchAgent.
| Symptom | What to check |
|---|---|
warpdrive is not found | Re-run the installer. Add ~/.local/bin to PATH if the installer could not use /usr/local/bin. |
| Node.js requirement error | Install Node.js 20 or newer, open a new shell, and confirm with node --version. |
| Build fails at the container check | Start Docker or Podman. Use WARPDRIVE_CONTAINER_CLI when the executable is not auto-detected. |
Port 7777 is in use | An engine may already be running. Reuse it or set a different WARPDRIVE_API_PORT. |
| No Instance matches the current folder | Change to the Workspace root or create an Instance for that path. |
| Relay will not reconnect | Run warpdrive remote status, then warpdrive remote relay --once to read the foreground error. |
| Local AI is not available | Use an installed desktop or Gateway package. A browser-only client cannot host the local model. |
| Checksum mismatch | Delete 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.