> For the complete documentation index, see [llms.txt](https://hyperhq.gitbook.io/docs-hyper-sh/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://hyperhq.gitbook.io/docs-hyper-sh/index-2/index/inspect.md).

# inspect

## inspect

```
Usage:    hyper inspect [OPTIONS] CONTAINER|IMAGE [CONTAINER|IMAGE...]

Return low-level information on a container or image

  -f, --format       Format the output using the given go template
  --help             Print usage
  -s, --size         Display total file sizes if the type is container
  --type             Return JSON for specified type, (e.g image or container)
```

By default, this will render all results in a JSON array. If the container and image have the same name, this will return container JSON for unspecified type. If a format is specified, the given template will be executed for each result.

Go’s `text/template` package describes all the details of the format.

## Examples

**Get an instance's IP address:**

For the most part, you can pick out any field from the JSON in a fairly straightforward manner.

```
$ hyper inspect --format='{{range .NetworkSettings.Networks}}{{.IPAddress}}{{end}}' $INSTANCE_ID
```

**Get an instance's MAC Address:**

For the most part, you can pick out any field from the JSON in a fairly straightforward manner.

```
$ hyper inspect --format='{{range .NetworkSettings.Networks}}{{.MacAddress}}{{end}}' $INSTANCE_ID
```

**Get an instance's log path:**

```
$ hyper inspect --format='{{.LogPath}}' $INSTANCE_ID
```

**List All Port Bindings:**

One can loop over arrays and maps in the results to produce simple text output:

```
$ hyper inspect --format='{{range $p, $conf := .NetworkSettings.Ports}} {{$p}} -> {{(index $conf 0).HostPort}} {{end}}' $INSTANCE_ID
```

**Find a Specific Port Mapping:**

The `.Field` syntax doesn't work when the field name begins with a number, but the template language's `index` function does. The `.NetworkSettings.Ports` section contains a map of the internal port mappings to a list of external address/port objects. To grab just the numeric public port, you use `index` to find the specific port map, and then `index` 0 contains the first object inside of that. Then we ask for the `HostPort` field to get the public address.

```
$ hyper inspect --format='{{(index (index .NetworkSettings.Ports "8787/tcp") 0).HostPort}}' $INSTANCE_ID
```

**Get a subsection in JSON format:**

If you request a field which is itself a structure containing other fields, by default you get a Go-style dump of the inner values. hyper adds a template function, `json`, which can be applied to get results in JSON format.

```
$ hyper inspect --format='{{json .Config}}' $INSTANCE_ID
```