Documentation Index
Fetch the complete documentation index at: https://mintlify.com/NVIDIA/OpenShell/llms.txt
Use this file to discover all available pages before exploring further.
openshell provider
Providers are named credential bundles — API keys, tokens, and service accounts — that are injected into sandboxes as environment variables at creation time. Credentials are never written to the sandbox filesystem.openshell provider create
Create a provider and register its credentials with the gateway.Provider name. Used to reference the provider in
sandbox create --provider.Provider type. Determines which environment variables are injected. Valid values:
| Value | Credentials injected |
|---|---|
claude | ANTHROPIC_API_KEY, CLAUDE_API_KEY |
anthropic | ANTHROPIC_API_KEY, CLAUDE_API_KEY |
openai | OPENAI_API_KEY |
codex | OPENAI_API_KEY |
opencode | OPENCODE_API_KEY, OPENROUTER_API_KEY, OPENAI_API_KEY |
nvidia | NVIDIA_API_KEY |
github | GITHUB_TOKEN, GH_TOKEN |
gitlab | GITLAB_TOKEN, GLAB_TOKEN, CI_JOB_TOKEN |
outlook | Outlook OAuth credentials |
generic | Any custom env var (specified with --credential) |
Load credentials from existing local state — reads from the current environment variables and known config files for the provider type. Conflicts with
--credential.Credential pair in
KEY=VALUE format, or just a KEY to read from the current environment. Repeatable for multiple credentials. Conflicts with --from-existing.Examples:--credential OPENAI_API_KEY— reads value from$OPENAI_API_KEY.--credential OPENAI_API_KEY=sk-...— sets the value directly.
Provider config key/value pair in
KEY=VALUE format. Repeatable. Use for non-credential configuration that travels with the provider.Either
--from-existing or at least one --credential is required. The two flags are mutually exclusive.Examples
openshell provider get
Fetch details for a provider by name.Provider name.
openshell provider list
List providers registered with the active gateway.Maximum number of providers to return.
Offset into the provider list for pagination.
Print only provider names, one per line.
Examples
openshell provider update
Update an existing provider’s credentials or config.Provider name to update.
Re-discover credentials from local state (env vars, config files). Conflicts with
--credential.New credential pair in
KEY=VALUE format, or just a KEY to read from the current environment. Repeatable. Conflicts with --from-existing.Provider config key/value pair in
KEY=VALUE format. Repeatable.Examples
openshell provider delete
Delete one or more providers by name.One or more provider names to delete.
Examples
Provider types and env vars
The following table lists recognized provider types and the environment variables the CLI reads when--from-existing is set.
| Type | Environment variables read |
|---|---|
claude / anthropic | ANTHROPIC_API_KEY, CLAUDE_API_KEY |
openai / codex | OPENAI_API_KEY |
opencode | OPENCODE_API_KEY, OPENROUTER_API_KEY, OPENAI_API_KEY |
nvidia | NVIDIA_API_KEY |
github | GITHUB_TOKEN, GH_TOKEN |
gitlab | GITLAB_TOKEN, GLAB_TOKEN, CI_JOB_TOKEN |
outlook | Outlook OAuth state |
generic | Any env var specified with --credential |