Skip to content

Commit 2576dba

Browse files
bnavettawarp-factories[bot]hongyi-chen
authored
Document macOS and Linux support (#673)
* Document macOS and Linux support * docs(runners): address review feedback on OS targets and units - Drop Windows-roadmap clause from the Flexible OS targets bullet - Use aarch64 instead of ARM64 for consistency with --arch flag values - Use GB instead of GiB in macOS resource configs to match --memory-gb --------- Co-authored-by: warp-factories[bot] <warp-factories[bot]@users.noreply.github.com> Co-authored-by: Hong Yi Chen <hongyi@warp.dev>
1 parent 2117200 commit 2576dba

1 file changed

Lines changed: 27 additions & 2 deletions

File tree

src/content/docs/platform/runners.mdx

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ description: >-
77
agents run on, managed with the {{WARP_AGENT_CLI}}.
88
---
99
import { VARS } from '@data/vars';
10+
import { Tabs, TabItem } from '@astrojs/starlight/components';
1011

1112
Runners define the compute a [cloud agent](/platform/) runs on: the operating system, CPU architecture, instance size, and sandbox image used to execute a run.
1213

@@ -22,7 +23,7 @@ What runners give you:
2223

2324
* **Reusable compute configs** – Define an OS, architecture, instance size, and sandbox image once, then reuse the runner across cloud agent runs and orchestration without repeating the configuration.
2425
* **Right-sized hardware** – Choose the number of vCPUs and amount of memory a run needs, so lightweight tasks stay cheap and heavy builds get enough resources.
25-
* **Flexible OS targets** – Run agents on Linux with a custom Docker image. macOS runners are in limited preview.
26+
* **Flexible OS targets** – Run agents on Linux or macOS.
2627
* **Independent of environments** – Override an environment's default runner per run without changing the environment itself.
2728

2829
## How runners fit into cloud agent runs
@@ -35,6 +36,30 @@ A runner is the compute layer for a cloud agent run. When a run starts, Warp pro
3536

3637
Each environment has a default runner. Specifying a runner for a run overrides that default for that run only.
3738

39+
## Operating systems
40+
41+
<Tabs>
42+
<TabItem label="Linux">
43+
Linux runners execute the agent in a fresh Docker container. Warp uses the Docker image you select to provide the agent's base filesystem and toolchains.
44+
45+
Warp-hosted Linux runners support any public x86-64 or aarch64 image. By default, runners use [`warpdotdev/dev-base:latest`](https://hub.docker.com/r/warpdotdev/dev-base).
46+
Linux supports any combination of CPU and memory as long as both are a power of two and within your plan's maximum resource limit.
47+
</TabItem>
48+
<TabItem label="macOS">
49+
macOS runners execute the agent in a fresh VM on Apple Silicon. You can choose from macOS 14, 15, 26, or 27. If not specified, Warp uses the current macOS release.
50+
51+
The VM has Xcode and standard system tools installed. Use setup commands to install additional dependencies. Downloads from Homebrew and popular language package
52+
managers are cached automatically.
53+
54+
The following resource configurations are supported:
55+
* 4 vCPUs, 7 GB memory
56+
* 6 vCPUs, 14 GB memory
57+
* 8 vCPUs, 14 GB memory
58+
* 12 vCPUs, 28 GB memory
59+
* 12 vCPUs, 56 GB memory
60+
</TabItem>
61+
</Tabs>
62+
3863
## Managing runners with the CLI
3964

4065
Use the [{VARS.WARP_AGENT_CLI}](/reference/cli/) to create, list, update, and delete runners. Runner commands require an authenticated CLI—see the [CLI quickstart](/reference/cli/quickstart/) to get set up.
@@ -68,7 +93,7 @@ Key flags:
6893
* `--team` / `--personal` — create the runner at the team level or private to your account.
6994

7095
:::caution
71-
OS-specific options must match `--os`. Use `--docker-image` only with `--os linux`, and `--macos-version` only with `--os macos`. macOS runners are in limited preview.
96+
OS-specific options must match `--os`. Use `--docker-image` only with `--os linux`, and `--macos-version` only with `--os macos`.
7297
:::
7398

7499
### List runners

0 commit comments

Comments
 (0)