Files
docker-docs/data/sbx_cli/sbx_completion_bash.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

54 lines
1.6 KiB
YAML

name: sbx completion bash
synopsis: Generate the autocompletion script for bash
description: |
Generate the autocompletion script for the bash shell.
This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.
To load completions in your current shell session:
source <(sbx completion bash)
To load completions for every new session, execute once:
#### Linux:
sbx completion bash > /etc/bash_completion.d/sbx
#### macOS:
sbx completion bash > $(brew --prefix)/etc/bash_completion.d/sbx
You will need to start a new shell for this setup to take effect.
usage: sbx completion bash
options:
- name: help
shorthand: h
default_value: "false"
usage: help for bash
- name: no-descriptions
default_value: "false"
usage: disable completion descriptions
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-
# Load completions in the current shell
source <(sbx completion bash)
# Install for every new shell
sbx completion bash > /etc/bash_completion.d/sbx
see_also:
- sbx completion - Generate the autocompletion script for the specified shell