docker_compose_ps.yaml 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  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. experimental: false
  23. experimentalcli: false
  24. kubernetes: false
  25. swarm: false
  26. - option: filter
  27. value_type: string
  28. description: Filter services by a property
  29. deprecated: false
  30. experimental: false
  31. experimentalcli: false
  32. kubernetes: false
  33. swarm: false
  34. - option: format
  35. value_type: string
  36. default_value: pretty
  37. description: 'Format the output. Values: [pretty | json]'
  38. deprecated: false
  39. experimental: false
  40. experimentalcli: false
  41. kubernetes: false
  42. swarm: false
  43. - option: quiet
  44. shorthand: q
  45. value_type: bool
  46. default_value: "false"
  47. description: Only display IDs
  48. deprecated: false
  49. experimental: false
  50. experimentalcli: false
  51. kubernetes: false
  52. swarm: false
  53. - option: services
  54. value_type: bool
  55. default_value: "false"
  56. description: Display services
  57. deprecated: false
  58. experimental: false
  59. experimentalcli: false
  60. kubernetes: false
  61. swarm: false
  62. - option: status
  63. value_type: string
  64. description: Filter services by status
  65. deprecated: false
  66. experimental: false
  67. experimentalcli: false
  68. kubernetes: false
  69. swarm: false
  70. deprecated: false
  71. experimental: false
  72. experimentalcli: false
  73. kubernetes: false
  74. swarm: false