# image

Container image operations

## Usage

```bash
apolo image [OPTIONS] COMMAND [ARGS]...
```

Container image operations.

**Commands:**

| Usage               | Description                                 |
| ------------------- | ------------------------------------------- |
| [*digest*](#digest) | Get digest of an image from remote registry |
| [*ls*](#ls)         | List images                                 |
| [*pull*](#pull)     | Pull an image from platform registry        |
| [*push*](#push)     | Push an image to platform registry          |
| [*rm*](#rm)         | Remove image from platform registry         |
| [*size*](#size)     | Get image size                              |
| [*tags*](#tags)     | List tags for image in platform registry    |

### digest

Get digest of an image from remote registry

#### Usage

```bash
apolo image digest [OPTIONS] IMAGE
```

Get digest of an image from remote registry

Image name must be `URL` with image:// scheme. Image name must contain tag.

#### Examples

```bash

$ apolo image digest image:/other-project/alpine:shared
$ apolo image digest image:myimage:latest
```

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### ls

List images

#### Usage

```bash
apolo image ls [OPTIONS]
```

List images.

#### Options

| Name                 | Description                                                                     |
| -------------------- | ------------------------------------------------------------------------------- |
| *--help*             | Show this message and exit.                                                     |
| *--all-orgs*         | Show images in all orgs.                                                        |
| *--all-projects*     | Show images in all projects.                                                    |
| *--cluster CLUSTER*  | Show images on a specified cluster (the current cluster by default).            |
| *-l*                 | List in long format.                                                            |
| *--full-uri*         | Output full image URI.                                                          |
| *-n, --name PATTERN* | Filter out images by name regex.                                                |
| *--org ORG*          | Filter out images by org (multiple option, the current org by default).         |
| *--project PROJECT*  | Filter out images by project (multiple option, the current project by default). |

### pull

Pull an image from platform registry

#### Usage

```bash
apolo image pull [OPTIONS] REMOTE_IMAGE [LOCAL_IMAGE]
```

Pull an image from platform registry.

Remote image name must be `URL` with image:// scheme. Image names can contain tag.

#### Examples

```bash

$ apolo pull image:myimage
$ apolo pull image:/other-project/alpine:shared
$ apolo pull image:/project/my-alpine:production alpine:from-registry
```

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### push

Push an image to platform registry

#### Usage

```bash
apolo image push [OPTIONS] LOCAL_IMAGE [REMOTE_IMAGE]
```

Push an image to platform registry.

Remote image must be `URL` with image:// scheme. Image names can contain tag. If tags not specified 'latest' will be used as value.

#### Examples

```bash

$ apolo push myimage
$ apolo push alpine:latest image:my-alpine:production
$ apolo push alpine image:/other-project/alpine:shared
```

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### rm

Remove image from platform registry

#### Usage

```bash
apolo image rm [OPTIONS] IMAGES...
```

Remove image from platform registry.

Image name must be `URL` with image:// scheme. Image name must contain tag.

#### Examples

```bash

$ apolo image rm image:/other-project/alpine:shared
$ apolo image rm image:myimage:latest
```

#### Options

| Name     | Description                                       |
| -------- | ------------------------------------------------- |
| *--help* | Show this message and exit.                       |
| *-f*     | Force deletion of all tags referencing the image. |

### size

Get image size

#### Usage

```bash
apolo image size [OPTIONS] IMAGE
```

Get image size

Image name must be `URL` with image:// scheme. Image name must contain tag.

#### Examples

```bash

$ apolo image size image:/other-project/alpine:shared
$ apolo image size image:myimage:latest
```

#### Options

| Name     | Description                 |
| -------- | --------------------------- |
| *--help* | Show this message and exit. |

### tags

List tags for image in platform registry

#### Usage

```bash
apolo image tags [OPTIONS] IMAGE
```

List tags for image in platform registry.

Image name must be `URL` with image:// scheme.

#### Examples

```bash

$ apolo image tags image:/other-project/alpine
$ apolo image tags -l image:myimage
```

#### Options

| Name     | Description                            |
| -------- | -------------------------------------- |
| *--help* | Show this message and exit.            |
| *-l*     | List in long format, with image sizes. |