added the readme contents
This commit is contained in:
parent
9802546b60
commit
8ca96849da
3
.gitignore
vendored
3
.gitignore
vendored
@ -17,4 +17,5 @@
|
||||
/_vendor*
|
||||
/vendor
|
||||
/.image
|
||||
*.log
|
||||
*.log
|
||||
/dist
|
72
README.md
72
README.md
@ -1,15 +1,69 @@
|
||||
# dive
|
||||
|
||||
A tool for interrogating docker images.
|
||||
|
||||
**This is beta quality!**
|
||||
A tool for interrogating docker images.
|
||||
|
||||
|
||||
|
||||
|
||||
## Installing
|
||||
```
|
||||
docker build -t die-test:latest .
|
||||
go run main.go
|
||||
To analyze a Docker image simply run dive with an image tag/id/digest:
|
||||
```bash
|
||||
dive <your-image-tag>
|
||||
```
|
||||
|
||||
or if you want to build your image then jump straight into analyzing it:
|
||||
```bash
|
||||
dive build -t <some-tag> .
|
||||
```
|
||||
|
||||
**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 change 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 is in
|
||||
your image. 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 you `docker build` command with the same `dive build` command.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
**Ubuntu/Debian**
|
||||
```bash
|
||||
wget https://github.com/wagoodman/dive/releases/download/v0.0.1/dive_0.0.1_linux_amd64.deb
|
||||
sudo apt install ./dive_0.0.1_linux_amd64.deb
|
||||
```
|
||||
|
||||
**RHEL/Centos**
|
||||
```bash
|
||||
wget https://github.com/wagoodman/dive/releases/download/v0.0.1/dive_0.0.1_linux_amd64.rpm
|
||||
rpm -i dive_0.0.1_linux_amd64.rpm
|
||||
```
|
||||
|
||||
**Mac**
|
||||
```bash
|
||||
brew tap wagoodman/dive
|
||||
brew install dive
|
||||
```
|
||||
or download a Darwin build from the releases page.
|
||||
|
||||
**Go tools**
|
||||
```bash
|
||||
go get github.com/wagoodman/dive
|
||||
```
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user