Skip to main content

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.
string
required
Provider name. Used to reference the provider in sandbox create --provider.
string
required
Provider type. Determines which environment variables are injected. Valid values:
boolean
Load credentials from existing local state — reads from the current environment variables and known config files for the provider type. Conflicts with --credential.
string
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.
string
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.
string
required
Provider name.

openshell provider list

List providers registered with the active gateway.
integer
default:"100"
Maximum number of providers to return.
integer
default:"0"
Offset into the provider list for pagination.
boolean
Print only provider names, one per line.

Examples


openshell provider update

Update an existing provider’s credentials or config.
string
required
Provider name to update.
boolean
Re-discover credentials from local state (env vars, config files). Conflicts with --credential.
string
New credential pair in KEY=VALUE format, or just a KEY to read from the current environment. Repeatable. Conflicts with --from-existing.
string
Provider config key/value pair in KEY=VALUE format. Repeatable.

Examples


openshell provider delete

Delete one or more providers by name.
string
required
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.
For agents that auto-discover credentials (Claude, Codex, OpenCode, GitHub Copilot), --from-existing is the fastest path: it reads from the current shell environment without requiring you to specify key names.