ps

Usage: hyper ps [OPTIONS]

List containers

  -a, --all=false       Show all containers (default shows just running)
  -f, --filter=[]       Filter output based on conditions provided
  --format=[]           Pretty-print containers using a Go template
  --help=false          Print usage
  -l, --latest=false    Show the latest created container (includes all states)
  -n=-1                 Show n last created containers (includes all states)
  --no-trunc=false      Don't truncate output
  -q, --quiet=false     Only display numeric IDs
  -s, --size=false      Display total file sizes

Running hyper ps --no-trunc showing 2 linked containers.

$ hyper ps
CONTAINER ID        IMAGE                        COMMAND                CREATED              STATUS              PORTS               NAMES              PUBLIC IP
4c01db0b339c        ubuntu:12.04                 bash                   17 seconds ago       Up 16 seconds       3300-3310/tcp       webapp
d7886598dbe2        crosbymichael/redis:latest   /redis-server --dir    33 minutes ago       Up 33 minutes       6379/tcp            redis,webapp/db

hyper ps will show only running containers by default. To see all containers: hyper ps -a

hyper ps will group exposed ports into a single range if possible. E.g., a container that exposes TCP ports 100, 101, 102 will display 100-102/tcp in the PORTS column.

Filtering

The filtering flag (-f or --filter) format is a key=value pair. If there is more than one filter, then pass multiple flags (e.g. --filter "foo=bar" --filter "bif=baz")

The currently supported filters are:

  • id (container's id)

  • label (label=<key> or label=<key>=<value>)

  • name (container's name)

  • exited (int - the code of exited containers. Only useful with --all)

  • status (created|restarting|running|paused|exited)

  • ancestor (<image-name>[:<tag>], <image id> or <image@digest>) - filters containers that were created from the given image or a descendant.

Label

The label filter matches containers based on the presence of a label alone or a label and a value.

The following filter matches containers with the color label regardless of its value.

The following filter matches containers with the color label with the blue value.

Name

The name filter matches on all or part of a container's name.

The following filter matches all containers with a name containing the nostalgic-stallman string.

You can also filter for a substring in a name as this shows:

Exited

The exited filter matches containers by exist status code. For example, to filter for containers that have exited successfully:

Status

The status filter matches containers by status. You can filter using created, restarting, running, paused and exited. For example, to filter for running containers:

To filter for paused containers:

Ancestor

The ancestor filter matches containers based on its image or a descendant of it. The filter supports the following image representation:

  • image

  • image:tag

  • image:tag@digest

  • short-id

  • full-id

If you don't specify a tag, the latest tag is used. For example, to filter for containers that use the latest ubuntu image:

Match containers based on the ubuntu-c1 image which, in this case, is a child of ubuntu:

Match containers based on the ubuntu version 12.04.5 image:

The following matches containers based on the layer d0e008c6cf02 or an image that have this layer in it's layer stack.

Formatting

The formatting option (--format) will pretty-print container output using a Go template.

Valid placeholders for the Go template are listed below:

Placeholder

Description

.ID

Container ID

.Image

Image ID

.Command

Quoted command

.CreatedAt

Time when the container was created.

.RunningFor

Elapsed time since the container was started.

.Ports

Exposed ports.

.Status

Container status.

.Size

Container disk size.

.Names

Container names.

.Labels

All labels assigned to the container.

.Label

Value of a specific label for this container.

When using the --format option, the ps command will either output the data exactly as the template declares or, when using the table directive, will include column headers as well.

The following example uses a template without headers and outputs the ID and Command entries separated by a colon for all running containers:

To list all running containers with their labels in a table format you can use:

PreviousportNextpull

Last updated