mirror of
https://github.com/docker/compose.git
synced 2025-05-09 17:10:12 +02:00
9db79856be
This updates the format of various usage strings to be more consistent with other parts of the CLI. - Use `[OPTIONS]` to indicate where command-specific options should be added - Use `[SERVICE...]` to indicate zero-or-more services - Remove some usage strings for specific options (e.g. `-e NAME=VAL`), as that option is part of the already mentioned `[OPTIONS]` and we don't provide usage for each possible option that can be passed. - Remove `[--]`, which (I think) was needed for the Python implementation, but is a general feature to stop processing flag-options. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
43 lines
1.1 KiB
YAML
43 lines
1.1 KiB
YAML
command: docker compose events
|
|
short: Receive real time events from containers.
|
|
long: |-
|
|
Stream container events for every container in the project.
|
|
|
|
With the `--json` flag, a json object is printed one per line with the format:
|
|
|
|
```json
|
|
{
|
|
"time": "2015-11-20T18:01:03.615550",
|
|
"type": "container",
|
|
"action": "create",
|
|
"id": "213cf7...5fc39a",
|
|
"service": "web",
|
|
"attributes": {
|
|
"name": "application_web_1",
|
|
"image": "alpine:edge"
|
|
}
|
|
}
|
|
```
|
|
|
|
The events that can be received using this can be seen [here](/engine/reference/commandline/events/#object-types).
|
|
usage: docker compose events [OPTIONS] [SERVICE...]
|
|
pname: docker compose
|
|
plink: docker_compose.yaml
|
|
options:
|
|
- option: json
|
|
value_type: bool
|
|
default_value: "false"
|
|
description: Output events as a stream of json objects
|
|
deprecated: false
|
|
hidden: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
deprecated: false
|
|
experimental: false
|
|
experimentalcli: false
|
|
kubernetes: false
|
|
swarm: false
|
|
|