mirror of
https://github.com/docker/docs.git
synced 2026-03-27 14:28:47 +07:00
- **sandboxes: regenerate, vendor cli reference docs** - **chore: move `docker sandbox create` to a section page** --------- Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
196 lines
4.8 KiB
YAML
Generated
196 lines
4.8 KiB
YAML
Generated
command: docker sandbox exec
|
|
short: Execute a command inside a sandbox
|
|
long: |-
|
|
Execute a command in a sandbox that was previously created with 'docker sandbox create'.
|
|
|
|
The command and any additional arguments are executed inside the sandbox container.
|
|
usage: docker sandbox exec [OPTIONS] SANDBOX COMMAND [ARG...]
|
|
pname: docker sandbox
|
|
plink: docker_sandbox.yaml
|
|
options:
|
|
- option: detach
|
|
shorthand: d
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: 'Detached mode: run command in the background'
|
|
details_url: '#detach'
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: detach-keys
|
|
value_type: string
|
|
description: Override the key sequence for detaching a container
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: env
|
|
shorthand: e
|
|
value_type: stringArray
|
|
default_value: '[]'
|
|
description: Set environment variables
|
|
details_url: '#env'
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: env-file
|
|
value_type: stringArray
|
|
default_value: '[]'
|
|
description: Read in a file of environment variables
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: interactive
|
|
shorthand: i
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Keep STDIN open even if not attached
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: privileged
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Give extended privileges to the command
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: tty
|
|
shorthand: t
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Allocate a pseudo-TTY
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: user
|
|
shorthand: u
|
|
value_type: string
|
|
description: 'Username or UID (format: <name|uid>[:<group|gid>])'
|
|
details_url: '#user'
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: workdir
|
|
shorthand: w
|
|
value_type: string
|
|
description: Working directory inside the container
|
|
details_url: '#workdir'
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
inherited_options:
|
|
- option: debug
|
|
shorthand: D
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Enable debug logging
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
- option: socket
|
|
value_type: string
|
|
description: |
|
|
Connect to daemon at specific socket path (for development/debugging)
|
|
deprecated: false
|
|
hidden: true
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
examples: |-
|
|
### Execute a command in a sandbox
|
|
|
|
```console
|
|
$ docker sandbox exec my-sandbox ls -la
|
|
```
|
|
|
|
### Run an interactive shell
|
|
|
|
```console
|
|
$ docker sandbox exec -it my-sandbox /bin/bash
|
|
```
|
|
|
|
### Set environment variables (-e, --env) {#env}
|
|
|
|
```text
|
|
--env KEY=VALUE
|
|
```
|
|
|
|
Pass environment variables to the command:
|
|
|
|
```console
|
|
$ docker sandbox exec \
|
|
--env NODE_ENV=development \
|
|
--env DATABASE_URL=postgresql://localhost/myapp \
|
|
my-sandbox npm test
|
|
```
|
|
|
|
### Set working directory (-w, --workdir) {#workdir}
|
|
|
|
```text
|
|
--workdir PATH
|
|
```
|
|
|
|
Run the command in a specific directory:
|
|
|
|
```console
|
|
$ docker sandbox exec --workdir /app my-sandbox python script.py
|
|
```
|
|
|
|
### Run as specific user (-u, --user) {#user}
|
|
|
|
```text
|
|
--user USER[:GROUP]
|
|
```
|
|
|
|
Execute command as a different user:
|
|
|
|
```console
|
|
$ docker sandbox exec --user 1000:1000 my-sandbox id
|
|
```
|
|
|
|
### Run in background (-d, --detach) {#detach}
|
|
|
|
Run a long-running command in the background:
|
|
|
|
```console
|
|
$ docker sandbox exec -d my-sandbox python server.py
|
|
```
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
|