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
$ 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.
$ hyper ps --filter "label=color"
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES PUBLIC IP
673394ef1d4c busybox "top" 47 seconds ago Up 45 seconds nostalgic-shockley
d85756f57265 busybox "top" 52 seconds ago Up 51 seconds high-albattani
The following filter matches containers with the color label with the blue value.
$ hyper ps --filter "label=color=blue"
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES PUBLIC IP
d85756f57265 busybox "top" About a minute ago Up About a minute high-albattani
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.
$ hyper ps --filter "name=nostalgic-stallman"
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES PUBLIC IP
9b6247364a03 busybox "top" 2 minutes ago Up 2 minutes nostalgic-stallman
You can also filter for a substring in a name as this shows:
$ hyper ps --filter "name=nostalgic"
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES PUBLIC IP
715ebfcee040 busybox "top" 3 seconds ago Up 1 seconds i-am-nostalgic
9b6247364a03 busybox "top" 7 minutes ago Up 7 minutes nostalgic-stallman
673394ef1d4c busybox "top" 38 minutes ago Up 38 minutes nostalgic-shockley
Exited
The exited filter matches containers by exist status code. For example, to filter for containers that have exited successfully:
$ hyper ps -a --filter 'exited=0'
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES PUBLIC IP
ea09c3c82f6e registry:latest /srv/run.sh 2 weeks ago Exited (0) 2 weeks ago 127.0.0.1:5000->5000/tcp desperate-leakey
106ea823fe4e fedora:latest /bin/sh -c 'bash -l' 2 weeks ago Exited (0) 2 weeks ago determined-albattani
48ee228c9464 fedora:20 bash 2 weeks ago Exited (0) 2 weeks ago tender-torvalds
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:
$ hyper ps --filter status=running
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES PUBLIC IP
715ebfcee040 busybox "top" 16 minutes ago Up 16 minutes i-am-nostalgic
d5c976d3c462 busybox "top" 23 minutes ago Up 23 minutes top
9b6247364a03 busybox "top" 24 minutes ago Up 24 minutes nostalgic-stallman
To filter for paused containers:
$ hyper ps --filter status=paused
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES PUBLIC IP
673394ef1d4c busybox "top" About an hour ago Up About an hour (Paused) nostalgic-shockley
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:
$ hyper ps --filter ancestor=ubuntu
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES PUBLIC IP
919e1179bdb8 ubuntu-c1 "top" About a minute ago Up About a minute admiring-lovelace
5d1e4a540723 ubuntu-c2 "top" About a minute ago Up About a minute admiring-sammet
82a598284012 ubuntu "top" 3 minutes ago Up 3 minutes sleepy-bose
bab2a34ba363 ubuntu "top" 3 minutes ago Up 3 minutes focused-yonath
Match containers based on the ubuntu-c1 image which, in this case, is a child of ubuntu:
$ hyper ps --filter ancestor=ubuntu-c1
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES PUBLIC IP
919e1179bdb8 ubuntu-c1 "top" About a minute ago Up About a minute admiring-lovelace
Match containers based on the ubuntu version 12.04.5 image:
$ hyper ps --filter ancestor=ubuntu:12.04.5
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES PUBLIC IP
82a598284012 ubuntu:12.04.5 "top" 3 minutes ago Up 3 minutes sleepy-bose
The following matches containers based on the layer d0e008c6cf02 or an image that have this layer in it's layer stack.
$ hyper ps --filter ancestor=d0e008c6cf02
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES PUBLIC IP
82a598284012 ubuntu:12.04.5 "top" 3 minutes ago Up 3 minutes sleepy-bose
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:
$ hyper ps --format "{{.ID}}: {{.Command}}"
a87ecb4f327c: /bin/sh -c #(nop) MA
01946d9d34d8: /bin/sh -c #(nop) MA
c1d3b0166030: /bin/sh -c yum -y up
41d50ecd2f57: /bin/sh -c #(nop) MA
To list all running containers with their labels in a table format you can use:
