You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit 8fcba28
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: docs/how-it-works/sandboxes/overview.mdx
+6Lines changed: 6 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -437,6 +437,12 @@ openshell sandbox list --selector env=dev
437
437
openshell sandbox list --selector env=dev,team=platform
438
438
```
439
439
440
+
Use `--annotation KEY=VALUE` for non-secret metadata that does not fit label limits, such as a file path. Annotation values can contain `/`, spaces, and `=`, and appear in the `annotations` field of `sandbox get -o json` and `sandbox list -o json`.
441
+
442
+
```shell
443
+
openshell sandbox create --annotation "policy-source-file=/home/you/policies/research policy.yaml" -- claude
444
+
```
445
+
440
446
The Python SDK accepts the same gateway labels and selectors. Labels passed to
441
447
`create` are stored on the gateway sandbox object and are returned on
442
448
`SandboxRef.labels`, so selector-based listing finds Python-created sandboxes:
-`--template NAME`: Create from a named sandbox workload template. Conflicts with inline workload flags such as `--from`, `--gpu`, `--cpu`, `--memory`, `--env`, `--env-from`, and `--driver-config-json`.
307
307
-`--label KEY=VALUE`: Add labels for later selection (repeatable)
308
+
-`--annotation KEY=VALUE`: Add non-secret metadata such as file paths (repeatable)
308
309
-`--env KEY=VALUE`: Set non-secret sandbox environment variables (repeatable); use `--provider` for credentials
309
310
-`--env-from KEY[=ENVVAR]`: Read a sandbox environment value from the CLI process environment without putting its value in arguments; use `--provider` to keep credentials hidden from the workload
310
311
-`--tty`: Allocate a retained PTY for the canonical main process
0 commit comments