# docui
**Repository Path**: gaoyuke/docui
## Basic Information
- **Project Name**: docui
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 1
- **Forks**: 0
- **Created**: 2019-06-03
- **Last Updated**: 2021-08-21
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# docui - TUI Client for Docker Written in Go
[](https://goreportcard.com/report/github.com/skanehira/docui)
[](https://goreportcard.com/report/github.com/skanehira/docui)
[](https://github.com/skanehira/docui/releases)
## About docui
docui is a TUI Client for Docker.
docui can do the following:
- image
- search/pull/remove
- save/import/load
- inspect/filtering
- container
- create/remove
- start/stop
- export/commit
- inspect/rename/filtering
- exec cmd
- volume
- create/remove/prune
- inspect/filtering
- network
- remove
- inspect/filtering
[](https://asciinema.org/a/223035)
## Supported OSes
- Mac
- Linux
## Required Tools
- Go Ver.1.11.4~
- Docker Engine Ver.18.06.1~
- Git
## Installation
### From Source
If you have not installed go and set GOPATH/GOBIN,
you must install and set env before installing docui.
This project uses [Go Modules](https://github.com/golang/go/wiki/Modules) for dependencies introduced in Go 1.11.
Use go get or git clone:
```
$ go get -d github.com/skanehira/docui
$ cd $GOPATH/src/github.com/skanehira/docui
$ GO111MODULE=on go install
```
```
$ git clone https://github.com/skanehira/docui.git
$ cd docui/
$ GO111MODULE=on go install
```
Make sure your PATH includes the $GOPATH/bin directory so your commands can be easily used:
```sh
export PATH=$PATH:$GOPATH/bin
```
### Homebrew
```sh
$ brew tap skanehira/docui
$ brew install docui
```
### Snapd
```sh
$ snap install docui --classic
```
### Nix
docui is available on nixpkgs unstable channel:
```sh
$ nix-env -i docui
```
## Update
Use git pull:
```sh
$ git pull
$ GO111MODULE=on go install
```
## Log file
```sh
~/docui.log
```
## Use on Docker
```
$ docker run --rm -itv /var/run/docker.sock:/var/run/docker.sock skanehira/docui
```
## Build Docker Image
```sh
$ make docker-build
```
## Keybindings
| panel | operation | key |
| ---------------- | ---------------------- | ------------------------------- |
| all | change panel | Tab |
| all | quit | Ctrl + q |
| all | quit | q |
| list panels | next entry | j / ↓ |
| list panels | previous entry | k / ↑ |
| image list | pull image | p |
| image list | search images | Ctrl + f |
| image list | remove image | d |
| image list | create container | c |
| image list | inspect image | Enter / o |
| image list | save image | s |
| image list | import image | i |
| image list | load image | Ctrl + l |
| image list | remove dangling images | Ctrl + d |
| image list | refresh image list | Ctrl + r |
| image list | filter image | f |
| container list | inspect container | Enter / o |
| container list | remove container | d |
| container list | start container | u |
| container list | stop container | s |
| container list | export container | e |
| container list | commit container | c |
| container list | rename container | r |
| container list | refresh container list | Ctrl + r |
| container list | filter image | f |
| container list | exec container cmd | Ctrl + c |
| container logs | show container logs | Ctrl + l |
| volume list | create volume | c |
| volume list | remove volume | d |
| volume list | prune volume | p |
| volume list | inspect volume | Enter / o |
| volume list | refresh volume list | Ctrl + r |
| volume list | filter image | f |
| network list | inspect network | Enter / o |
| network list | remove network | d |
| pull image | pull image | Enter |
| pull image | close panel | Esc |
| create container | next input box | ↓ / Tab |
| create container | previous input box | ↑ |
| create container | close panel | Esc |
| detail | cursor dwon | j |
| detail | cursor up | k |
| detail | page dwon | d |
| detail | page up | u |
| search images | search image | Enter |
| search images | close panel | Esc |
| images | next image | j / ↓ |
| images | previous image | k / ↑ |
| images | pull image | Enter |
| images | close panel | Esc |
| create volume | close panel | Esc |
| create volume | next input box | ↓ / Tab |
| create volume | previous input box | ↑ |
## How to use
For details of the input panel please refer to [wiki](https://github.com/skanehira/docui/blob/master/wiki.md)
## Screenshots
