mirror of
https://github.com/docker/docs.git
synced 2026-11-04 10:01:00 +00:00
David Karlsson
1773367159
Vendor the checked-in CLI YAML from Docker Sandboxes release/v0.51 at 7d55286de0c7. This updates command help, adds `sbx policy check http`, and replaces seven agent-specific create pages with redirects to `sbx create`. Validation: full site build with Hugo 0.169.0; upstream byte-for-byte comparison; all 115 command pages, reference links, and seven redirects checked; template formatting and whitespace checks passed.
79 lines
3.3 KiB
YAML
79 lines
3.3 KiB
YAML
name: sbx env plan
|
|
synopsis: Show what an environment would change outside the sandbox
|
|
experimental: true
|
|
description: |-
|
|
Read the environment file from PATH (default: current directory) and print
|
|
everything applying it would set up: the host commands it runs, the credentials
|
|
and bindings it provisions, the MCP servers it registers, the directories it
|
|
creates, the ports it publishes, and the sandbox itself along with the variables
|
|
it runs with.
|
|
|
|
The plan is compared against what this environment last applied on this machine,
|
|
against what was approved where nothing applied it, and against what is there
|
|
now, so a second run shows only what moved. Nothing is applied, approved, or
|
|
recorded: use "sbx env create" or "sbx env run" for that.
|
|
|
|
Each PATH may be a directory (the file is <PATH>/sbxenv.yaml) or the
|
|
path to the environment file itself. Passing more than one PATH deep-merges them
|
|
in order, matching the other "sbx env" subcommands.
|
|
|
|
A directory PATH selects sbxenv.yaml; a file PATH selects that file.
|
|
With no PATH, ~/.sbxenv.yaml supplies shared defaults when present.
|
|
Explicit PATHs skip those defaults. Later files override earlier values;
|
|
lists such as ports and mcp.servers are concatenated.
|
|
usage: sbx env plan [PATH...] [flags]
|
|
options:
|
|
- name: clone
|
|
default_value: "false"
|
|
usage: |
|
|
Override workspace.clone in sbxenv.yaml (see 'sbx create --clone')
|
|
- name: env-arg
|
|
default_value: '[]'
|
|
experimental: true
|
|
usage: |
|
|
Value for an argument the environment file declares, as name=value (can be repeated)
|
|
- name: env-args-file
|
|
default_value: '[]'
|
|
experimental: true
|
|
usage: |
|
|
File of name=value environment arguments, one per line (can be repeated); --env-arg overrides
|
|
- name: help
|
|
shorthand: h
|
|
default_value: "false"
|
|
usage: help for plan
|
|
- name: kit-arg
|
|
default_value: '[]'
|
|
experimental: true
|
|
usage: |
|
|
Value for an argument a kit declares, as name=value for every kit or kit.name=value for one (can be repeated); overrides the args a kits: entry pins in sbxenv.yaml
|
|
- name: kit-args-file
|
|
default_value: '[]'
|
|
experimental: true
|
|
usage: |
|
|
File of name=value kit arguments, one per line (can be repeated); --kit-arg overrides
|
|
- name: name
|
|
usage: |
|
|
Name for the sandbox, overriding 'name:' in sbxenv.yaml and the derived <agent>-<directory> (every 'sbx env' command addressing this environment needs the same value)
|
|
- name: skip-host-commands
|
|
default_value: "false"
|
|
usage: |
|
|
Plan without the host lifecycle commands and command-backed MCP servers the environment declares
|
|
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
|
|
- name: no-input
|
|
default_value: "false"
|
|
usage: |
|
|
Never prompt; commands that need an answer fail with the command to run instead
|
|
example: |4-
|
|
sbx env plan
|
|
sbx env plan ./project
|
|
see_also:
|
|
- sbx env - (Experimental) Manage sandboxes declaratively from an sbxenv.yaml file
|