Files
docker-docs/data/sbx_cli/sbx_settings_set.yaml
David Karlsson 1773367159 Sync sbx CLI reference from release/v0.51 (#26514)
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.
2026-11-04 10:10:52 +01:00

39 lines
1.4 KiB
YAML

name: sbx settings set
synopsis: Set a setting override
description: |-
Set a user override for a setting. Values are parsed according to the
setting's type: bool (true or false), int, float, string, or raw JSON.
Administrator constraints apply; conflicting values are rejected.
Environment variables take precedence over user overrides.
Most changes take effect within about five seconds. This command reports
when a daemon restart is required.
usage: sbx settings set KEY VALUE [flags]
options:
- name: help
shorthand: h
default_value: "false"
usage: help for set
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-
# Route sandbox, daemon, and CLI egress through an upstream proxy
sbx settings set proxy http://proxy.example.com:3128
# Pull template and kit images through a registry mirror
sbx settings set platform.images.registryMirror artifactory.corp/docker-remote
see_also:
- sbx settings - Manage Docker Sandboxes settings