File: docker_compose_events.yaml

package info (click to toggle)
docker-compose 2.32.4-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,300 kB
  • sloc: makefile: 113; sh: 2
file content (54 lines) | stat: -rw-r--r-- 1,433 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
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](/reference/cli/docker/system/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
inherited_options:
    - option: dry-run
      value_type: bool
      default_value: "false"
      description: Execute command in dry run mode
      deprecated: false
      hidden: false
      experimental: false
      experimentalcli: false
      kubernetes: false
      swarm: false
deprecated: false
hidden: false
experimental: false
experimentalcli: false
kubernetes: false
swarm: false