Skip to content

Commit 993e557

Browse files
committed
docs(cli): document JSON/YAML output format for provider list
Add documentation for the -o/--output flag on provider list command, following the established pattern from sandbox list documentation. Changes: - Add examples showing -o json and -o yaml usage - Explain output structure (metadata, credential keys, config keys) - Emphasize security design (keys-only exposure, never values) - Cross-reference existing Credential Injection section The documentation matches the feature added in a26a634 and refined in subsequent commits (509db49, a5f59ce). Signed-off-by: Jeff MAURY <[email protected]>
1 parent a5f59ce commit 993e557

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

‎docs/sandboxes/manage-providers.mdx‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,15 @@ List all providers:
8585
openshell provider list
8686
```
8787

88+
Use `-o json` or `-o yaml` for machine-readable output:
89+
90+
```shell
91+
openshell provider list -o json
92+
openshell provider list -o yaml
93+
```
94+
95+
Structured output includes provider metadata (`id`, `name`, `type`), credential key names, config key names, labels, creation timestamp, resource version, and credential expiration times. Only credential and config keys are exposed, never values, preventing accidental credential leakage in logs or output. For details on how credentials are injected into sandboxes, refer to [Credential Injection](#how-credential-injection-works).
96+
8897
Inspect a provider:
8998

9099
```shell

0 commit comments

Comments
 (0)