trending/OpenShell
1
0
Fork 0
mirror of https://github.com/NVIDIA/OpenShell.git synced 2026-10-17 05:31:16 +08:00
Code Issues Packages Projects Releases Wiki Activity

improve docs

Browse Source
This commit is contained in:
Miyoung Choi
2026-03-14 15:04:05 -07:00
parent 05eade959c
commit eff01a54fa
2 changed files with 43 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/get-started/quickstart.md
+38 -13
View File
@@ -42,29 +42,42 @@ Install the `openshell` package into a virtual environment.
Activate your virtual environment:
```bash
uv venv && source .venv/bin/activate
```console
$ uv venv && source .venv/bin/activate
```
Install the CLI:
```bash
uv pip install openshell
```console
$ uv pip install openshell
```
## Connect to a Remote Gateway (Optional)
:::{tip}
OpenShell does not have a separate CLI reference page.
Run `openshell --help` to see all available commands, and `openshell <command> --help` for detailed usage of any subcommand.
If you're running locally, skip this step. The OpenShell CLI creates a gateway automatically when you create your first sandbox.
```console
$ openshell --help
$ openshell gateway --help
$ openshell sandbox create --help
```
:::
## Deploy a Gateway (Optional)
Running `openshell sandbox create` without a gateway auto-bootstraps a local one.
To start the gateway explicitly or deploy to a remote host, choose the tab that matches your setup.
:::::{tab-set}
::::{tab-item} Brev
:::{note}
Deploy an OpenShell gateway on Brev by hitting **Deploy** on the [OpenShell Launchable](https://brev.nvidia.com/launchable/deploy/now?launchableID=env-3AaK9NmCzWp3pVyUDNNFBt805FT).
Deploy an OpenShell gateway on Brev by clicking **Deploy** on the [OpenShell Launchable](https://brev.nvidia.com/launchable/deploy/now?launchableID=env-3AaK9NmCzWp3pVyUDNNFBt805FT).
:::
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.
After the instance starts running, find the gateway URL in the Brev console under **Using Secure Links**.
Copy the shareable URL for **port 8080**, which is the gateway endpoint.
```console
$ openshell gateway add https://<your-port-8080-url>.brevlab.com
@@ -94,6 +107,7 @@ After `openshell status` shows the gateway as healthy, all subsequent commands r
## Create Your First OpenShell Sandbox
Create a sandbox and launch an agent inside it.
Choose the tab that matches your agent:
::::{tab-set}
@@ -106,7 +120,10 @@ Run the following command to create a sandbox with Claude Code:
$ openshell sandbox create -- claude
```
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.
The CLI prompts you to create a provider from local credentials.
Type `yes` to continue.
If `ANTHROPIC_API_KEY` is set in your environment, the CLI picks it up automatically.
If not, you can configure it from inside the sandbox after it launches.
:::
:::{tab-item} OpenCode
@@ -117,7 +134,10 @@ Run the following command to create a sandbox with OpenCode:
$ openshell sandbox create -- opencode
```
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.
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, the CLI picks it up automatically.
If not, you can configure it from inside the sandbox after it launches.
:::
:::{tab-item} Codex
@@ -128,7 +148,10 @@ Run the following command to create a sandbox with Codex:
$ openshell sandbox create -- codex
```
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.
The CLI prompts you to create a provider from local credentials.
Type `yes` to continue.
If `OPENAI_API_KEY` is set in your environment, the CLI picks it up automatically.
If not, you can configure it from inside the sandbox after it launches.
:::
:::{tab-item} OpenClaw
@@ -139,12 +162,14 @@ Run the following command to create a sandbox with OpenClaw:
$ openshell sandbox create --from openclaw
```
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.
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.
:::
:::{tab-item} Community Sandbox
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:
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:
```console
$ openshell sandbox create --from base
docs/index.md
+5 -1
View File
@@ -105,7 +105,11 @@ Install the CLI and create your first sandbox in two commands.
</div>
```
Refer to the [Quickstart](get-started/quickstart.md) for more details.
Run `openshell --help` in your terminal to see the full CLI reference, including all commands and flags.
Run `openshell <command> --help` for detailed usage of any subcommand.
Proceed to the [Quickstart](get-started/quickstart.md) for more details.
---