From 276146127271f9dc4f7826a7cfad3260f668161e Mon Sep 17 00:00:00 2001 From: mesutoezdil Date: Sat, 2 May 2026 22:23:12 +0200 Subject: [PATCH 1/2] docs: fix tutorial links pointing to /tutorials instead of /get-started/tutorials --- docs/get-started/tutorials/first-network-policy.mdx | 2 +- docs/inference/configure.mdx | 6 +++--- docs/sandboxes/manage-providers.mdx | 2 +- docs/sandboxes/manage-sandboxes.mdx | 2 +- docs/sandboxes/policies.mdx | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/get-started/tutorials/first-network-policy.mdx b/docs/get-started/tutorials/first-network-policy.mdx index 7148a05db..effe7c445 100644 --- a/docs/get-started/tutorials/first-network-policy.mdx +++ b/docs/get-started/tutorials/first-network-policy.mdx @@ -218,4 +218,4 @@ bash examples/sandbox-policy-quickstart/demo.sh ## Next Steps -- To walk through a full policy iteration with Claude Code, including diagnosing denials and applying fixes from outside the sandbox, refer to [GitHub Sandbox](/tutorials/github-sandbox). +- To walk through a full policy iteration with Claude Code, including diagnosing denials and applying fixes from outside the sandbox, refer to [GitHub Sandbox](/get-started/tutorials/github-sandbox). diff --git a/docs/inference/configure.mdx b/docs/inference/configure.mdx index e1ce8b90d..6e4332905 100644 --- a/docs/inference/configure.mdx +++ b/docs/inference/configure.mdx @@ -64,7 +64,7 @@ openshell provider create \ Use `--config OPENAI_BASE_URL` to point to any OpenAI-compatible server running where the gateway runs. For host-backed local inference, use `host.openshell.internal` or the host's LAN IP. Avoid `127.0.0.1` and `localhost`. Set `OPENAI_API_KEY` to a dummy value if the server does not require authentication. -For a self-contained setup, the Ollama community sandbox bundles Ollama inside the sandbox itself — no host-level provider needed. See [Inference Ollama](/tutorials/inference-ollama) for details. +For a self-contained setup, the Ollama community sandbox bundles Ollama inside the sandbox itself — no host-level provider needed. See [Inference Ollama](/get-started/tutorials/inference-ollama) for details. @@ -190,7 +190,7 @@ A successful response confirms the privacy router can reach the configured backe Explore related topics: - To understand the inference routing flow and supported API patterns, refer to [Index](/inference/about). -- To follow a complete Ollama-based local setup, refer to [Inference Ollama](/tutorials/inference-ollama). -- To follow a complete LM Studio-based local setup, refer to [Local Inference Lmstudio](/tutorials/local-inference-lmstudio). +- To follow a complete Ollama-based local setup, refer to [Inference Ollama](/get-started/tutorials/inference-ollama). +- To follow a complete LM Studio-based local setup, refer to [Local Inference Lmstudio](/get-started/tutorials/local-inference-lmstudio). - To control external endpoints, refer to [Policies](/sandboxes/policies). - To manage provider records, refer to [Manage Providers](/sandboxes/manage-providers). diff --git a/docs/sandboxes/manage-providers.mdx b/docs/sandboxes/manage-providers.mdx index 5f95d2f07..7bda8768e 100644 --- a/docs/sandboxes/manage-providers.mdx +++ b/docs/sandboxes/manage-providers.mdx @@ -156,7 +156,7 @@ The following provider types are supported. | `claude` | `ANTHROPIC_API_KEY`, `CLAUDE_API_KEY` | Claude Code, Anthropic API | | `codex` | `OPENAI_API_KEY` | OpenAI Codex | | `generic` | User-defined | Any service with custom credentials | -| `github` | `GITHUB_TOKEN`, `GH_TOKEN` | GitHub API, `gh` CLI — refer to [GitHub Sandbox](/tutorials/github-sandbox) | +| `github` | `GITHUB_TOKEN`, `GH_TOKEN` | GitHub API, `gh` CLI — refer to [GitHub Sandbox](/get-started/tutorials/github-sandbox) | | `gitlab` | `GITLAB_TOKEN`, `GLAB_TOKEN`, `CI_JOB_TOKEN` | GitLab API, `glab` CLI | | `nvidia` | `NVIDIA_API_KEY` | NVIDIA API Catalog | | `openai` | `OPENAI_API_KEY` | Any OpenAI-compatible endpoint. Set `--config OPENAI_BASE_URL` to point to the provider. Refer to [Configure](/inference/configure). | diff --git a/docs/sandboxes/manage-sandboxes.mdx b/docs/sandboxes/manage-sandboxes.mdx index c7397204a..39cf6deea 100644 --- a/docs/sandboxes/manage-sandboxes.mdx +++ b/docs/sandboxes/manage-sandboxes.mdx @@ -235,7 +235,7 @@ openshell sandbox delete my-sandbox ## Next Steps -- To follow a complete end-to-end example, refer to the [GitHub Sandbox](/tutorials/github-sandbox) tutorial. +- To follow a complete end-to-end example, refer to the [GitHub Sandbox](/get-started/tutorials/github-sandbox) tutorial. - To supply API keys or tokens, refer to [Manage Providers](/sandboxes/manage-providers). - To control what the agent can access, refer to [Policies](/sandboxes/policies). - To use a pre-built environment, refer to the [Community Sandboxes](/sandboxes/community-sandboxes) catalog. diff --git a/docs/sandboxes/policies.mdx b/docs/sandboxes/policies.mdx index 12392f5f2..049023b43 100644 --- a/docs/sandboxes/policies.mdx +++ b/docs/sandboxes/policies.mdx @@ -454,7 +454,7 @@ Endpoints without `protocol` use TCP passthrough, where the proxy allows the str Allow Claude and the GitHub CLI to reach `api.github.com` with per-path rules: read-only (GET, HEAD, OPTIONS) and GraphQL (POST) for all paths; full write access for `alpha-repo`; and create/edit issues only for `bravo-repo`. Replace `` with your GitHub org or username. -For an end-to-end walkthrough that combines this policy with a GitHub credential provider and sandbox creation, refer to [GitHub Sandbox](/tutorials/github-sandbox). +For an end-to-end walkthrough that combines this policy with a GitHub credential provider and sandbox creation, refer to [GitHub Sandbox](/get-started/tutorials/github-sandbox). From 6a6343628915ceccb1070a7c210f8e5b3f2456eb Mon Sep 17 00:00:00 2001 From: mesutoezdil Date: Sat, 2 May 2026 23:19:02 +0200 Subject: [PATCH 2/2] docs: add Debian package install option to quickstart --- docs/get-started/quickstart.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/get-started/quickstart.mdx b/docs/get-started/quickstart.mdx index 2f26c7bfb..bb3e01fe3 100644 --- a/docs/get-started/quickstart.mdx +++ b/docs/get-started/quickstart.mdx @@ -31,6 +31,14 @@ If you prefer [uv](https://docs.astral.sh/uv/): uv tool install -U openshell ``` +On Debian and Ubuntu, download the `.deb` package from the [GitHub releases page](https://github.com/NVIDIA/OpenShell/releases) and install it: + +```shell +sudo dpkg -i openshell__amd64.deb +``` + +The package includes the CLI, the gateway binary, and the VM compute driver. + After installing the CLI, run `openshell --help` in your terminal to see the full CLI reference, including all commands and flags.