sbx env plan
| 内容説明 | Show what an environment would change outside the sandbox |
|---|---|
| 利用方法 | sbx env plan [PATH...] [flags] |
試験的
This command is experimental.
Experimental features are intended for testing and feedback as their functionality or design may change between releases without warning or can be removed entirely in a future release.
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
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.
Options
| オプション | デフォルト | 内容説明 |
|---|---|---|
--clone | Override workspace.clone in sbxenv.yaml (see 'sbx create --clone') | |
--env-arg | experimental Value for an argument the environment file declares, as name=value (can be repeated) | |
--env-args-file | experimental File of name=value environment arguments, one per line (can be repeated); --env-arg overrides | |
--kit-arg | experimental 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 | |
--kit-args-file | experimental File of name=value kit arguments, one per line (can be repeated); --kit-arg overrides | |
--name | 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) | |
--skip-host-commands | Plan without the host lifecycle commands the environment declares |
Global options
| オプション | デフォルト | 内容説明 |
|---|---|---|
--cloud | 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) | |
-D, --debug | Enable debug logging |
Examples
sbx env plan
sbx env plan ./project