mirror of https://github.com/docker/docs.git
64 lines
3.1 KiB
YAML
64 lines
3.1 KiB
YAML
command: docker exec
|
|
short: Run a command in a running container
|
|
long: |-
|
|
The `docker exec` command runs a new command in a running container.
|
|
|
|
The command started using `docker exec` only runs while the container's primary
|
|
process (`PID 1`) is running, and it is not restarted if the container is
|
|
restarted.
|
|
|
|
COMMAND will run in the default directory of the container. It the
|
|
underlying image has a custom directory specified with the WORKDIR directive
|
|
in its Dockerfile, this will be used instead.
|
|
|
|
COMMAND should be an executable, a chained or a quoted command
|
|
will not work. Example: `docker exec -ti my_container "echo a && echo b"` will
|
|
not work, but `docker exec -ti my_container sh -c "echo a && echo b"` will.
|
|
usage: docker exec [OPTIONS] CONTAINER COMMAND [ARG...]
|
|
pname: docker
|
|
plink: docker.yaml
|
|
options:
|
|
- option: detach
|
|
shorthand: d
|
|
default_value: "false"
|
|
description: 'Detached mode: run command in the background'
|
|
- option: detach-keys
|
|
description: Override the key sequence for detaching a container
|
|
- option: env
|
|
shorthand: e
|
|
description: Set environment variables
|
|
- option: interactive
|
|
shorthand: i
|
|
default_value: "false"
|
|
description: Keep STDIN open even if not attached
|
|
- option: privileged
|
|
default_value: "false"
|
|
description: Give extended privileges to the command
|
|
- option: tty
|
|
shorthand: t
|
|
default_value: "false"
|
|
description: Allocate a pseudo-TTY
|
|
- option: user
|
|
shorthand: u
|
|
description: 'Username or UID (format: <name|uid>[:<group|gid>])'
|
|
examples: "### Run `docker exec` on a running container\n\nFirst, start a container.\n\n```bash\n$
|
|
docker run --name ubuntu_bash --rm -i -t ubuntu bash\n```\n\nThis will create a
|
|
container named `ubuntu_bash` and start a Bash session.\n\nNext, execute a command
|
|
on the container.\n\n```bash\n$ docker exec -d ubuntu_bash touch /tmp/execWorks\n```\n\nThis
|
|
will create a new file `/tmp/execWorks` inside the running container\n`ubuntu_bash`,
|
|
in the background.\n\nNext, execute an interactive `bash` shell on the container.\n\n```bash\n$
|
|
docker exec -it ubuntu_bash bash\n```\n\nThis will create a new Bash session in
|
|
the container `ubuntu_bash`.\n\nNext, set an environment variable in the current
|
|
bash session.\n\n```bash\n$ docker exec -it -e VAR=1 ubuntu_bash bash\n```\n\nThis
|
|
will create a new Bash session in the container `ubuntu_bash` with environment \nvariable
|
|
`$VAR` set to \"1\". Note that this environment variable will only be valid \non
|
|
the current Bash session.\n\n\n### Try to run `docker exec` on a paused container\n\nIf
|
|
the container is paused, then the `docker exec` command will fail with an error:\n\n```bash\n$
|
|
docker pause test\n\ntest\n\n$ docker ps\n\nCONTAINER ID IMAGE COMMAND
|
|
\ CREATED STATUS PORTS NAMES\n1ae3b36715d2
|
|
\ ubuntu:latest \"bash\" 17 seconds ago Up 16 seconds
|
|
(Paused) test\n\n$ docker exec test ls\n\nFATA[0000] Error
|
|
response from daemon: Container test is paused, unpause the container before exec\n\n$
|
|
echo $?\n1\n```"
|
|
|