You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/get-started/quickstart.md
+46-16Lines changed: 46 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,39 +32,57 @@ This page gets you from zero to a running, policy-enforced sandbox in two comman
32
32
33
33
Before you begin, make sure you have:
34
34
35
-
- Python 3.12 or later
36
-
-[uv](https://docs.astral.sh/uv/) installed
37
-
- Docker Desktop running on your machine
35
+
- Python 3.12 or later.
36
+
-[uv](https://docs.astral.sh/uv/) installed.
37
+
- Docker Desktop running on your machine.
38
+
39
+
For a complete list of requirements, refer to {doc}`../reference/support-matrix`.
38
40
39
41
## Install the OpenShell CLI
40
42
41
43
Install the `openshell` package into a virtual environment.
42
44
43
45
Activate your virtual environment:
44
46
45
-
```bash
46
-
uv venv &&source .venv/bin/activate
47
+
```console
48
+
$ uv venv &&source .venv/bin/activate
47
49
```
48
50
49
51
Install the CLI:
50
52
51
-
```bash
52
-
uv pip install openshell
53
+
```console
54
+
$ uv pip install openshell
53
55
```
54
56
55
-
## Connect to a Remote Gateway (Optional)
57
+
:::{tip}
58
+
To find the CLI reference, run:
59
+
-`openshell --help` to see all available commands.
60
+
-`openshell <command> --help` for detailed usage of any subcommand.
61
+
62
+
For example:
63
+
64
+
```console
65
+
$ openshell --help
66
+
$ openshell gateway --help
67
+
$ openshell sandbox create --help
68
+
```
69
+
:::
70
+
71
+
## Deploy a Gateway (Optional)
56
72
57
-
If you're running locally, skip this step. The OpenShell CLI creates a gateway automatically when you create your first sandbox.
73
+
Running `openshell sandbox create` without a gateway auto-bootstraps a local one.
74
+
To start the gateway explicitly or deploy to a remote host, choose the tab that matches your setup.
58
75
59
76
:::::{tab-set}
60
77
61
78
::::{tab-item} Brev
62
79
63
80
:::{note}
64
-
Deploy an OpenShell gateway on Brev by hitting**Deploy** on the [OpenShell Launchable](https://brev.nvidia.com/launchable/deploy/now?launchableID=env-3AaK9NmCzWp3pVyUDNNFBt805FT).
81
+
Deploy an OpenShell gateway on Brev by clicking**Deploy** on the [OpenShell Launchable](https://brev.nvidia.com/launchable/deploy/now?launchableID=env-3AaK9NmCzWp3pVyUDNNFBt805FT).
65
82
:::
66
83
67
-
After the instance is running, find the gateway URL in the Brev console under **Using Secure Links**. Copy the shareable URL for **port 8080** — this is the gateway endpoint.
84
+
After the instance starts running, find the gateway URL in the Brev console under **Using Secure Links**.
85
+
Copy the shareable URL for **port 8080**, which is the gateway endpoint.
@@ -94,6 +112,7 @@ After `openshell status` shows the gateway as healthy, all subsequent commands r
94
112
95
113
## Create Your First OpenShell Sandbox
96
114
115
+
Create a sandbox and launch an agent inside it.
97
116
Choose the tab that matches your agent:
98
117
99
118
::::{tab-set}
@@ -106,7 +125,10 @@ Run the following command to create a sandbox with Claude Code:
106
125
$ openshell sandbox create -- claude
107
126
```
108
127
109
-
The CLI prompts you to create a provider from local credentials — type `yes` to continue. If `ANTHROPIC_API_KEY` is set in your environment, it is picked up automatically. If not, you can configure it from inside the sandbox after it launches.
128
+
The CLI prompts you to create a provider from local credentials.
129
+
Type `yes` to continue.
130
+
If `ANTHROPIC_API_KEY` is set in your environment, the CLI picks it up automatically.
131
+
If not, you can configure it from inside the sandbox after it launches.
110
132
:::
111
133
112
134
:::{tab-item} OpenCode
@@ -117,7 +139,10 @@ Run the following command to create a sandbox with OpenCode:
117
139
$ openshell sandbox create -- opencode
118
140
```
119
141
120
-
The CLI prompts you to create a provider from local credentials. Type `yes` to continue. If `OPENAI_API_KEY` or `OPENROUTER_API_KEY` is set in your environment, it is picked up automatically. If not, you can configure it from inside the sandbox after it launches.
142
+
The CLI prompts you to create a provider from local credentials.
143
+
Type `yes` to continue.
144
+
If `OPENAI_API_KEY` or `OPENROUTER_API_KEY` is set in your environment, the CLI picks it up automatically.
145
+
If not, you can configure it from inside the sandbox after it launches.
121
146
:::
122
147
123
148
:::{tab-item} Codex
@@ -128,7 +153,10 @@ Run the following command to create a sandbox with Codex:
128
153
$ openshell sandbox create -- codex
129
154
```
130
155
131
-
The CLI prompts you to create a provider from local credentials. Type `yes` to continue. If `OPENAI_API_KEY` is set in your environment, it is picked up automatically. If not, you can configure it from inside the sandbox after it launches.
156
+
The CLI prompts you to create a provider from local credentials.
157
+
Type `yes` to continue.
158
+
If `OPENAI_API_KEY` is set in your environment, the CLI picks it up automatically.
159
+
If not, you can configure it from inside the sandbox after it launches.
132
160
:::
133
161
134
162
:::{tab-item} OpenClaw
@@ -139,12 +167,14 @@ Run the following command to create a sandbox with OpenClaw:
139
167
$ openshell sandbox create --from openclaw
140
168
```
141
169
142
-
The `--from` flag pulls a pre-built sandbox definition from the [OpenShell Community](https://github.com/NVIDIA/OpenShell-Community) catalog. Each definition bundles a container image, a tailored policy, and optional skills into a single package.
170
+
The `--from` flag pulls a pre-built sandbox definition from the [OpenShell Community](https://github.com/NVIDIA/OpenShell-Community) catalog.
171
+
Each definition bundles a container image, a tailored policy, and optional skills into a single package.
143
172
:::
144
173
145
174
:::{tab-item} Community Sandbox
146
175
147
-
You can use the `--from` flag to pull other OpenShell sandbox images from the [NVIDIA Container Registry](https://registry.nvidia.com/). For example, to pull the `base` image, run the following command:
176
+
Use the `--from` flag to pull other OpenShell sandbox images from the [NVIDIA Container Registry](https://registry.nvidia.com/).
177
+
For example, to pull the `base` image, run the following command:
0 commit comments