Skip to content

Commit a6744fa

Browse files
authored
Merge pull request #24735 from dvdksn/sbx/prerequisites
sbx: clarify prerequisites (kvm, macos version)
2 parents 7b02e9e + 7ad9354 commit a6744fa

File tree

1 file changed

+42
-17
lines changed

1 file changed

+42
-17
lines changed

content/manuals/ai/sandboxes/get-started.md

Lines changed: 42 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -19,25 +19,55 @@ cleaning up.
1919

2020
## Prerequisites
2121

22-
- macOS (Apple silicon), Windows (x86_64, Windows 11 required), or Linux
23-
(Ubuntu 22.04 or later, x86_64)
24-
- If you're on Windows, enable Windows Hypervisor Platform. Open an elevated
25-
PowerShell prompt (Run as Administrator) and run:
22+
{{< tabs group="os" >}}
23+
{{< tab name="macOS" >}}
24+
25+
- macOS Tahoe (26) or later
26+
- Apple silicon
27+
28+
{{< /tab >}}
29+
{{< tab name="Windows" >}}
30+
31+
- 64-bit Intel or AMD (x86_64)
32+
- Windows 11
33+
- Windows Hypervisor Platform enabled. Open an elevated PowerShell prompt (Run
34+
as Administrator) and run:
2635
```powershell
2736
Enable-WindowsOptionalFeature -Online -FeatureName HypervisorPlatform -All
2837
```
29-
- If you're on Linux, your user must be in the `kvm` group for hardware
30-
virtualization access.
31-
- An API key or authentication method for the agent you want to use. Most
32-
agents require an API key for their model provider (Anthropic, OpenAI,
33-
Google, and others). See the [agent pages](agents/) for provider-specific
34-
instructions.
38+
39+
{{< /tab >}}
40+
{{< tab name="Linux (Ubuntu)" >}}
41+
42+
- Ubuntu 22.04 or later
43+
- 64-bit Intel or AMD (x86_64)
44+
- KVM hardware virtualization supported and enabled by the CPU. If you're
45+
running inside a VM, nested virtualization must be turned on. Verify that KVM
46+
is available:
47+
```console
48+
$ lsmod | grep kvm
49+
```
50+
A working setup shows `kvm_intel` or `kvm_amd` in the output. If the output
51+
is empty, run `kvm-ok` for diagnostics. If KVM is unavailable, `sbx` will
52+
not start.
53+
- Your user in the `kvm` group:
54+
```console
55+
$ sudo usermod -aG kvm $USER
56+
```
57+
Log out and back in (or run `newgrp kvm`) for the group change to take effect.
58+
59+
{{< /tab >}}
60+
{{< /tabs >}}
61+
62+
An API key or authentication method for the agent you want to use. Most agents
63+
require an API key for their model provider (Anthropic, OpenAI, Google, and
64+
others). See the [agent pages](agents/) for provider-specific instructions.
3565

3666
Docker Desktop is not required to use `sbx`.
3767

3868
## Install and sign in
3969

40-
{{< tabs >}}
70+
{{< tabs group="os" >}}
4171
{{< tab name="macOS" >}}
4272

4373
```console
@@ -59,15 +89,10 @@ $ sbx login
5989
```console
6090
$ curl -fsSL https://get.docker.com | sudo REPO_ONLY=1 sh
6191
$ sudo apt-get install docker-sbx
62-
$ sudo usermod -aG kvm $USER
63-
$ newgrp kvm
6492
$ sbx login
6593
```
6694

67-
The first command adds Docker's `apt` repository to your system. The
68-
`usermod` command grants your user access to `/dev/kvm` for hardware
69-
virtualization. You need to log out and back in (or use `newgrp`) for the
70-
group change to take effect.
95+
The first command adds Docker's `apt` repository to your system.
7196

7297
{{< /tab >}}
7398
{{< /tabs >}}

0 commit comments

Comments
 (0)