tyler.durden
/
compose
mirror of https://github.com/docker/compose.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix docs to reflect docker compose ps being aligned with docker ps 

Signed-off-by: Nicolas De Loof <nicolas.deloof@gmail.com>
This commit is contained in:
Nicolas De Loof 2023-01-24 09:10:09 +01:00 committed by Guillaume Lours
parent 5919fcb4cd
commit 4721c01702
2 changed files with 34 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
docs/reference/compose_ps.md
View File

@ -20,13 +20,20 @@ List containers
## Description ## Description
Lists containers for a Compose project, with current status and exposed ports. Lists containers for a Compose project, with current status and exposed ports.
By default, both running and stopped containers are shown:
```console ```console
$ docker compose ps $ docker compose ps
NAME COMMAND SERVICE STATUS PORTS NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
example-bar-1 "/docker-entrypoint.…" bar exited (0) example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp
example-foo-1 "/docker-entrypoint.…" foo running 0.0.0.0:8080->80/tcp ```
By default, only running containers are shown. `--all` flag can be used to include stopped containers
```console
$ docker compose ps --all
NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp
example-bar-1 alpine "/entrypoint.…" bar 4 seconds ago exited (0)
``` ```
## Examples ## Examples
@ -89,12 +96,12 @@ to show only containers that are running or only containers that have exited:
```console ```console
$ docker compose ps --status=running $ docker compose ps --status=running
NAME COMMAND SERVICE STATUS PORTS NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
example-foo-1 "/docker-entrypoint.…" foo running 0.0.0.0:8080->80/tcp example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp
$ docker compose ps --status=exited $ docker compose ps --status=exited
NAME COMMAND SERVICE STATUS PORTS NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
example-bar-1 "/docker-entrypoint.…" bar exited (0) example-bar-1 alpine "/entrypoint.…" bar 4 seconds ago exited (0)
``` ```
### <a name="filter"></a> Filter containers by status (--filter) ### <a name="filter"></a> Filter containers by status (--filter)
@ -105,12 +112,8 @@ this time using the `--filter` flag:
```console ```console
$ docker compose ps --filter status=running $ docker compose ps --filter status=running
NAME COMMAND SERVICE STATUS PORTS NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
example-foo-1 "/docker-entrypoint.…" foo running 0.0.0.0:8080->80/tcp example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp
$ docker compose ps --filter status=running
NAME COMMAND SERVICE STATUS PORTS
example-bar-1 "/docker-entrypoint.…" bar exited (0)
``` ```
The `docker compose ps` command currently only supports the `--filter status=<status>` The `docker compose ps` command currently only supports the `--filter status=<status>`

31
docs/reference/docker_compose_ps.yaml
View File

@ -2,13 +2,20 @@ command: docker compose ps
short: List containers short: List containers
long: |- long: |-
Lists containers for a Compose project, with current status and exposed ports. Lists containers for a Compose project, with current status and exposed ports.
By default, both running and stopped containers are shown:
```console ```console
$ docker compose ps $ docker compose ps
NAME COMMAND SERVICE STATUS PORTS NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
example-bar-1 "/docker-entrypoint.…" bar exited (0) example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp
example-foo-1 "/docker-entrypoint.…" foo running 0.0.0.0:8080->80/tcp ```
By default, only running containers are shown. `--all` flag can be used to include stopped containers
```console
$ docker compose ps --all
NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp
example-bar-1 alpine "/entrypoint.…" bar 4 seconds ago exited (0)
``` ```
usage: docker compose ps [OPTIONS] [SERVICE...] usage: docker compose ps [OPTIONS] [SERVICE...]
pname: docker compose pname: docker compose
@ -139,12 +146,12 @@ examples: |-
```console ```console
$ docker compose ps --status=running $ docker compose ps --status=running
NAME COMMAND SERVICE STATUS PORTS NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
example-foo-1 "/docker-entrypoint.…" foo running 0.0.0.0:8080->80/tcp example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp
$ docker compose ps --status=exited $ docker compose ps --status=exited
NAME COMMAND SERVICE STATUS PORTS NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
example-bar-1 "/docker-entrypoint.…" bar exited (0) example-bar-1 alpine "/entrypoint.…" bar 4 seconds ago exited (0)
``` ```
### Filter containers by status (--filter) {#filter} ### Filter containers by status (--filter) {#filter}
@ -155,12 +162,8 @@ examples: |-
```console ```console
$ docker compose ps --filter status=running $ docker compose ps --filter status=running
NAME COMMAND SERVICE STATUS PORTS NAME IMAGE COMMAND SERVICE CREATED STATUS PORTS
example-foo-1 "/docker-entrypoint.…" foo running 0.0.0.0:8080->80/tcp example-foo-1 alpine "/entrypoint.…" foo 4 seconds ago Up 2 seconds 0.0.0.0:8080->80/tcp
$ docker compose ps --filter status=running
NAME COMMAND SERVICE STATUS PORTS
example-bar-1 "/docker-entrypoint.…" bar exited (0)
``` ```
The `docker compose ps` command currently only supports the `--filter status=<status>` The `docker compose ps` command currently only supports the `--filter status=<status>`