Skip to content

Commit ed3c445

Browse files
authored
docs: improve the docs more (#308)
* improve docs * save
1 parent 9bd1117 commit ed3c445

2 files changed

Lines changed: 51 additions & 17 deletions

File tree

docs/get-started/quickstart.md

Lines changed: 46 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -32,39 +32,57 @@ This page gets you from zero to a running, policy-enforced sandbox in two comman
3232

3333
Before you begin, make sure you have:
3434

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`.
3840

3941
## Install the OpenShell CLI
4042

4143
Install the `openshell` package into a virtual environment.
4244

4345
Activate your virtual environment:
4446

45-
```bash
46-
uv venv && source .venv/bin/activate
47+
```console
48+
$ uv venv && source .venv/bin/activate
4749
```
4850

4951
Install the CLI:
5052

51-
```bash
52-
uv pip install openshell
53+
```console
54+
$ uv pip install openshell
5355
```
5456

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)
5672

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.
5875

5976
:::::{tab-set}
6077

6178
::::{tab-item} Brev
6279

6380
:::{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).
6582
:::
6683

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.
6886

6987
```console
7088
$ openshell gateway add https://<your-port-8080-url>.brevlab.com
@@ -94,6 +112,7 @@ After `openshell status` shows the gateway as healthy, all subsequent commands r
94112

95113
## Create Your First OpenShell Sandbox
96114

115+
Create a sandbox and launch an agent inside it.
97116
Choose the tab that matches your agent:
98117

99118
::::{tab-set}
@@ -106,7 +125,10 @@ Run the following command to create a sandbox with Claude Code:
106125
$ openshell sandbox create -- claude
107126
```
108127

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.
110132
:::
111133

112134
:::{tab-item} OpenCode
@@ -117,7 +139,10 @@ Run the following command to create a sandbox with OpenCode:
117139
$ openshell sandbox create -- opencode
118140
```
119141

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.
121146
:::
122147

123148
:::{tab-item} Codex
@@ -128,7 +153,10 @@ Run the following command to create a sandbox with Codex:
128153
$ openshell sandbox create -- codex
129154
```
130155

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.
132160
:::
133161

134162
:::{tab-item} OpenClaw
@@ -139,12 +167,14 @@ Run the following command to create a sandbox with OpenClaw:
139167
$ openshell sandbox create --from openclaw
140168
```
141169

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.
143172
:::
144173

145174
:::{tab-item} Community Sandbox
146175

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:
148178

149179
```console
150180
$ openshell sandbox create --from base

docs/index.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,11 @@ Install the CLI and create your first sandbox in two commands.
105105
</div>
106106
```
107107

108-
Refer to the [Quickstart](get-started/quickstart.md) for more details.
108+
Run `openshell --help` in your terminal to see the full CLI reference, including all commands and flags.
109+
Run `openshell <command> --help` for detailed usage of any subcommand.
110+
111+
Proceed to the [Quickstart](get-started/quickstart.md) for more details.
112+
109113

110114
---
111115

0 commit comments

Comments
 (0)