Github url

dive

by wagoodman

wagoodman /dive

A tool for exploring each layer in a docker image

20.8K Stars 748 Forks Last release: 5 months ago (v0.9.2) MIT License 387 Commits 24 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

dive

Go Report CardPipeline StatusDonate

A tool for exploring a docker image, layer contents, and discovering ways to shrink the size of your Docker/OCI image.

Image

To analyze a Docker image simply run dive with an image tag/id/digest:

bash dive <your-image-tag>
</your-image-tag>

or if you want to build your image then jump straight into analyzing it:

bash dive build -t <some-tag> .
</some-tag>

Building on Macbook (supporting only the Docker container engine)

docker run --rm -it \ -v /var/run/docker.sock:/var/run/docker.sock \ -v "$(pwd)":"$(pwd)" \ -w "$(pwd)" \ -v "$HOME/.dive.yaml":"$HOME/.dive.yaml" \ wagoodman/dive:latest build -t <some-tag> .
</some-tag>

Additionally you can run this in your CI pipeline to ensure you're keeping wasted space to a minimum (this skips the UI):

CI=true dive <your-image>
</your-image>

Image

This is beta quality! Feel free to submit an issue if you want a new feature or find a bug :)

Basic Features

Show Docker image contents broken down by layer

As you select a layer on the left, you are shown the contents of that layer combined with all previous layers on the right. Also, you can fully explore the file tree with the arrow keys.

Indicate what's changed in each layer

Files that have changed, been modified, added, or removed are indicated in the file tree. This can be adjusted to show changes for a specific layer, or aggregated changes up to this layer.

Estimate "image efficiency"

The lower left pane shows basic layer info and an experimental metric that will guess how much wasted space your image contains. This might be from duplicating files across layers, moving files across layers, or not fully removing files. Both a percentage "score" and total wasted file space is provided.

Quick build/analysis cycles

You can build a Docker image and do an immediate analysis with one command:

dive build -t some-tag .

You only need to replace your

docker build

command with the same

dive build

command.

CI Integration

Analyze and image and get a pass/fail result based on the image efficiency and wasted space. Simply set

CI=true

in the environment when invoking any valid dive command.

Multiple Image Sources and Container Engines Supported

With the

--source

option, you can select where to fetch the container image from:

bash dive <your-image> --source <source>
</source></your-image>

or

bash dive <source>://<your-image>
</your-image></source>

With valid

source

options as such: -

docker

: Docker engine (the default option) -

docker-archive

: A Docker Tar Archive from disk -

podman

: Podman engine (linux only)

Installation

Ubuntu/Debian

bash wget https://github.com/wagoodman/dive/releases/download/v0.9.2/dive\_0.9.2\_linux\_amd64.deb sudo apt install ./dive\_0.9.2\_linux\_amd64.deb

RHEL/Centos

bash curl -OL https://github.com/wagoodman/dive/releases/download/v0.9.2/dive\_0.9.2\_linux\_amd64.rpm rpm -i dive\_0.9.2\_linux\_amd64.rpm

Arch Linux

Available as dive in the Arch User Repository (AUR).

yay -S dive

The above example assumes [

yay

](https://aur.archlinux.org/packages/yay/) as the tool for installing AUR packages.

Mac

brew install dive

or download the latest Darwin build from the releases page.

Windows

Download the latest release.

Go toolsRequires Go version 1.10 or higher.

go get github.com/wagoodman/dive

Note: installing in this way you will not see a proper version when running

dive -v

.

Docker

bash docker pull wagoodman/dive

or

docker pull quay.io/wagoodman/dive

When running you'll need to include the docker socket file:

bash docker run --rm -it \ -v /var/run/docker.sock:/var/run/docker.sock \ wagoodman/dive:latest <dive arguments...>
</dive>

Docker for Windows (showing PowerShell compatible line breaks; collapse to a single line for Command Prompt compatibility)

bash docker run --rm -it ` -v /var/run/docker.sock:/var/run/docker.sock ` wagoodman/dive:latest <dive arguments...>
</dive>

Note: depending on the version of docker you are running locally you may need to specify the docker API version as an environment variable:

bash DOCKER\_API\_VERSION=1.37 dive ...

or if you are running with a docker image:

bash docker run --rm -it \ -v /var/run/docker.sock:/var/run/docker.sock \ -e DOCKER\_API\_VERSION=1.37 \ wagoodman/dive:latest <dive arguments...>
</dive>

CI Integration

When running dive with the environment variable

CI=true

then the dive UI will be bypassed and will instead analyze your docker image, giving it a pass/fail indication via return code. Currently there are three metrics supported via a

.dive-ci

file that you can put at the root of your repo: ``` rules: # If the efficiency is measured below X%, mark as failed. # Expressed as a ratio between 0-1. lowestEfficiency: 0.95

If the amount of wasted space is at least X or larger than X, mark as failed. # Expressed in B, KB, MB, and GB. highestWastedBytes: 20MB

If the amount of wasted space makes up for X% or more of the image, mark as failed. # Note: the base image layer is NOT included in the total image size. # Expressed as a ratio between 0-1; fails if the threshold is met or crossed. highestUserWastedPercent: 0.20 ``

You can override the CI config path with the

--ci-config` option.

KeyBindings

Key Binding | Description -------------------------------------------|---------------------------------------------------------Ctrl + C | ExitTab | Switch between the layer and filetree viewsCtrl + F | Filter filesPageUp | Scroll up a pagePageDown | Scroll down a pageCtrl + A | Layer view: see aggregated image modificationsCtrl + L | Layer view: see current layer modificationsSpace | Filetree view: collapse/uncollapse a directoryCtrl + Space | Filetree view: collapse/uncollapse all directoriesCtrl + A | Filetree view: show/hide added filesCtrl + R | Filetree view: show/hide removed filesCtrl + M | Filetree view: show/hide modified filesCtrl + U | Filetree view: show/hide unmodified filesCtrl + B | Filetree view: show/hide file attributesPageUp | Filetree view: scroll up a pagePageDown | Filetree view: scroll down a page

UI Configuration

No configuration is necessary, however, you can create a config file and override values: ```yaml

supported options are "docker" and "podman"

container-engine: docker

continue with analysis even if there are errors parsing the image archive

ignore-errors: false log: enabled: true path: ./dive.log level: info

Note: you can specify multiple bindings by separating values with a comma.

Note: UI hinting is derived from the first binding

keybinding: # Global bindings quit: ctrl+c toggle-view: tab filter-files: ctrl+f, ctrl+slash

Layer view specific bindings compare-all: ctrl+a compare-layer: ctrl+l

File view specific bindings toggle-collapse-dir: space toggle-collapse-all-dir: ctrl+space toggle-added-files: ctrl+a toggle-removed-files: ctrl+r toggle-modified-files: ctrl+m toggle-unmodified-files: ctrl+u toggle-filetree-attributes: ctrl+b page-up: pgup page-down: pgdn

diff: # You can change the default files show in the filetree (right pane). All diff types are shown by default. hide: - added - removed - modified - unmodified

filetree: # The default directory-collapse state collapse-dir: false

The percentage of screen width the filetree should take on the screen (must be >0 and <1) pane-width: 0.5

Show the file attributes next to the filetree show-attributes: true

layer: # Enable showing all changes from this layer and ever previous layer show-aggregated-changes: false

dive will search for configs in the following locations: - `$XDG_CONFIG_HOME/dive/*.yaml` - `$XDG_CONFIG_DIRS/dive/*.yaml` - `~/.config/dive/*.yaml` - `~/.dive.yaml`

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.