docker_compose_ps.yaml 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. command: docker compose ps
  2. short: List containers
  3. long: |-
  4. Lists containers for a Compose project, with current status and exposed ports.
  5. ```console
  6. $ docker compose ps
  7. NAME SERVICE STATUS PORTS
  8. example_foo_1 foo running (healthy) 0.0.0.0:8000->80/tcp
  9. example_bar_1 bar exited (1)
  10. ```
  11. usage: docker compose ps [SERVICE...]
  12. pname: docker compose
  13. plink: docker_compose.yaml
  14. options:
  15. - option: all
  16. shorthand: a
  17. value_type: bool
  18. default_value: "false"
  19. description: |
  20. Show all stopped containers (including those created by the run command)
  21. deprecated: false
  22. hidden: false
  23. experimental: false
  24. experimentalcli: false
  25. kubernetes: false
  26. swarm: false
  27. - option: filter
  28. value_type: string
  29. description: Filter services by a property. Deprecated, use --status instead
  30. deprecated: false
  31. hidden: true
  32. experimental: false
  33. experimentalcli: false
  34. kubernetes: false
  35. swarm: false
  36. - option: format
  37. value_type: string
  38. default_value: pretty
  39. description: 'Format the output. Values: [pretty | json]'
  40. deprecated: false
  41. hidden: false
  42. experimental: false
  43. experimentalcli: false
  44. kubernetes: false
  45. swarm: false
  46. - option: quiet
  47. shorthand: q
  48. value_type: bool
  49. default_value: "false"
  50. description: Only display IDs
  51. deprecated: false
  52. hidden: false
  53. experimental: false
  54. experimentalcli: false
  55. kubernetes: false
  56. swarm: false
  57. - option: services
  58. value_type: bool
  59. default_value: "false"
  60. description: Display services
  61. deprecated: false
  62. hidden: false
  63. experimental: false
  64. experimentalcli: false
  65. kubernetes: false
  66. swarm: false
  67. - option: status
  68. value_type: stringArray
  69. default_value: '[]'
  70. description: |
  71. Filter services by status. Values: [paused | restarting | removing | running | dead | created | exited]
  72. deprecated: false
  73. hidden: false
  74. experimental: false
  75. experimentalcli: false
  76. kubernetes: false
  77. swarm: false
  78. deprecated: false
  79. experimental: false
  80. experimentalcli: false
  81. kubernetes: false
  82. swarm: false