mirror of
https://github.com/docker/docs.git
synced 2026-11-04 10:01:00 +00:00
David Karlsson
c64e3927ef
## Summary Update the Sandbox documentation for the v0.48.0 CLI refactor: renamed flags, settings commands, terminal output, structured output, and non-interactive confirmations. Add a migration reference for scripts and CI workflows, with a [**Copy as prompt** button](https://deploy-preview-26314--docsdocker.netlify.app/ai/sandboxes/workflows/automation/#update-scripts-for-v0480) that copies agent instructions and the section Markdown. This PR targets `main` independently of the other PRs in the sbx/v0.48.0 milestone. It keeps the generated reference import separate from documentation edits: - Vendor the 120 generated CLI YAML files - Update command examples and guidance. Historical release notes retain their original command spellings. The other milestone PRs cover separate release features; this PR covers the CLI migration. @netlify /ai/sandboxes/workflows/automation/ Generated by Codex
45 lines
1.7 KiB
YAML
45 lines
1.7 KiB
YAML
name: sbx policy inspect
|
|
synopsis: Show policy or rule details
|
|
description: |-
|
|
Inspect full detail for a selected policy or rule.
|
|
|
|
The selector may be a policy ID, policy name, rule ID, or rule name.
|
|
Selecting a policy lists every resource with its decision, rule, and status,
|
|
plus a rule table showing each rule's RULE_ID, whether it is editable, and
|
|
either the exact removal command or the reason it is read-only. Selecting a
|
|
rule shows just that rule with the same editability detail. RULE_ID is the
|
|
identifier accepted by "sbx policy rm network --id" (local rules only). Use
|
|
"sbx policy ls" to find policy names and "sbx policy ls --wide" to find rule
|
|
IDs and resource values.
|
|
usage: sbx policy inspect POLICY|RULE [flags]
|
|
options:
|
|
- name: format
|
|
usage: 'Output format: table, json or yaml'
|
|
- name: help
|
|
shorthand: h
|
|
default_value: "false"
|
|
usage: help for inspect
|
|
- name: json
|
|
default_value: "false"
|
|
usage: Output in JSON format
|
|
inherited_options:
|
|
- name: cloud
|
|
default_value: "false"
|
|
usage: |
|
|
Dispatch to Docker Cloud Sandboxes API instead of local sandboxd (supported by a growing set of verbs — run 'sbx --cloud --help' for the current list)
|
|
- name: debug
|
|
shorthand: D
|
|
default_value: "false"
|
|
usage: Enable debug logging
|
|
example: |4-
|
|
# Inspect a policy by name
|
|
sbx policy inspect "Developer access"
|
|
|
|
# Inspect a rule by ID
|
|
sbx policy inspect 2d3c1f0e-4a73-4e05-bc9d-f2f9a4b50d67
|
|
|
|
# Machine-readable output for scripting
|
|
sbx policy inspect "Developer access" --json
|
|
see_also:
|
|
- sbx policy - Manage sandbox policies
|