mirror of
https://github.com/NVIDIA/OpenShell.git
synced 2026-10-04 00:23:53 +08:00
Johnny Greco
8bc7955263
* feat(skills): separate public and contributor workflows Closes #2736 Publish the four user-facing OpenShell skills from the top-level skills directory, mark contributor workflows internal, and update portability guidance, validation, and documentation. Signed-off-by: Johnny Greco <jogreco@nvidia.com> * docs(skills): clarify public skill audit scope Signed-off-by: Johnny Greco <jogreco@nvidia.com> * docs(skills): use markdown documentation links Signed-off-by: Johnny Greco <jogreco@nvidia.com> * docs(skills): align public and contributor guidance Signed-off-by: Johnny Greco <jogreco@nvidia.com> --------- Signed-off-by: Johnny Greco <jogreco@nvidia.com>
102 lines
3.2 KiB
Plaintext
102 lines
3.2 KiB
Plaintext
---
|
|
# SPDX-FileCopyrightText: Copyright (c) 2025-2026 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
|
|
# SPDX-License-Identifier: Apache-2.0
|
|
title: "Quickstart"
|
|
description: "Install the OpenShell CLI, connect to a gateway, and create your first sandboxed AI agent."
|
|
keywords: "Generative AI, Cybersecurity, AI Agents, Sandboxing, Installation, Quickstart, Gateway, Docker, Kubernetes, Podman"
|
|
position: 1
|
|
---
|
|
|
|
This page gets you from a reachable OpenShell gateway to a running, policy-enforced sandbox.
|
|
|
|
## Prerequisites
|
|
|
|
Before you begin, make sure you have:
|
|
|
|
- A reachable OpenShell gateway.
|
|
- At least one compute driver configured for the gateway: Kubernetes, Docker, Podman, or MicroVM.
|
|
- The OpenShell CLI installed on your workstation.
|
|
|
|
For a complete list of requirements, refer to [Support Matrix](/reference/support-matrix).
|
|
If you have not chosen a compute driver yet, refer to [Installation](/about/installation).
|
|
|
|
## Install the OpenShell CLI
|
|
|
|
Run the install script:
|
|
|
|
```shell
|
|
curl -LsSf https://raw.githubusercontent.com/NVIDIA/OpenShell/main/install.sh | sh
|
|
```
|
|
|
|
The install script uses Homebrew, RPM, or a Debian package based on your machine. It starts the local gateway server after installation.
|
|
|
|
After installing the CLI, run `openshell --help` in your terminal to view the full CLI reference.
|
|
|
|
<Tip>
|
|
Install the public OpenShell agent skills with `npx skills add NVIDIA/OpenShell`. The `openshell-cli` skill guides your agent through common workflows and uses the installed CLI help as the command reference; no OpenShell source checkout is required.
|
|
</Tip>
|
|
|
|
## Create Your First OpenShell Sandbox
|
|
|
|
Create a sandbox and launch an agent inside it.
|
|
Choose the tab that matches your agent:
|
|
|
|
<Tabs>
|
|
<Tab title="Claude Code">
|
|
|
|
Run the following command to create a sandbox with Claude Code:
|
|
|
|
```shell
|
|
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, the CLI picks it up automatically.
|
|
If not, you can configure it from inside the sandbox after it launches.
|
|
|
|
<Note>
|
|
`ANTHROPIC_API_KEY` is an API key from [console.anthropic.com](https://console.anthropic.com), not a subscription token. Subscription users must generate a separate API key.
|
|
</Note>
|
|
</Tab>
|
|
|
|
<Tab title="OpenCode">
|
|
|
|
Run the following command to create a sandbox with OpenCode:
|
|
|
|
```shell
|
|
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, the CLI picks it up automatically.
|
|
If not, you can configure it from inside the sandbox after it launches.
|
|
</Tab>
|
|
|
|
<Tab title="Codex">
|
|
|
|
Run the following command to create a sandbox with Codex:
|
|
|
|
```shell
|
|
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, the CLI picks it up automatically.
|
|
If not, you can configure it from inside the sandbox after it launches.
|
|
</Tab>
|
|
|
|
<Tab title="Base Sandbox">
|
|
|
|
Use the `--from` flag to create a sandbox from the base container:
|
|
|
|
```shell
|
|
openshell sandbox create --from base
|
|
```
|
|
|
|
</Tab>
|
|
|
|
</Tabs>
|