Home

Awesome

docui - TUI Client for Docker Written in Go

Go Report Card CircleCI CircleCI GitHub All Releases GitHub commits

This repository is no longer maintenance. Please use lazydocker instead.

About docui

demo

docui is a TUI Client for Docker. It can do the following:

Supported OSes

Required Tools

Installation

Environment variables

The following environment variables must be set.

export LC_CTYPE=en_US.UTF-8
export TERM=xterm-256color

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 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:

export PATH=$PATH:$GOPATH/bin

Homebrew

$ brew install docui

Nix

docui is available on nixpkgs unstable channel:

$ nix-env -i docui

Update

Use git pull:

$ git pull
$ GO111MODULE=on go install

Log file

Check wiki.

Use on Docker

$ docker run --rm -itv /var/run/docker.sock:/var/run/docker.sock skanehira/docui

Build Docker Image

$ make docker-build

Keybindings

paneloperationkey
allchange panel<kbd>Tab</kbd> / <kbd>Shift</kbd> + <kbd>Tab</kbd>
allquit<kbd>q</kbd>
list panelsnext entry<kbd>j</kbd> / <kbd></kbd>
list panelsprevious entry<kbd>k</kbd> / <kbd></kbd>
list panelsnext page<kbd>Ctrl</kbd> / <kbd>f</kbd>
list panelsprevious page<kbd>Ctrl</kbd> / <kbd>b</kbd>
list panelsscroll to top<kbd>g</kbd>
list panelsscroll to bottom<kbd>G</kbd>
image listpull image<kbd>p</kbd>
image listsearch images<kbd>f</kbd>
image listremove image<kbd>d</kbd>
image listcreate container<kbd>c</kbd>
image listinspect image<kbd>Enter</kbd>
image listsave image<kbd>s</kbd>
image listimport image<kbd>i</kbd>
image listload image<kbd>Ctrl</kbd> + <kbd>l</kbd>
image listrefresh image list<kbd>Ctrl</kbd> + <kbd>r</kbd>
image listfilter image<kbd>/</kbd>
container listinspect container<kbd>Enter</kbd>
container listremove container<kbd>d</kbd>
container liststart container<kbd>u</kbd>
container liststop container<kbd>s</kbd>
container listkill container<kbd>Ctrl</kbd> + <kbd>k</kbd>
container listexport container<kbd>e</kbd>
container listcommit container<kbd>c</kbd>
container listrename container<kbd>r</kbd>
container listrefresh container list<kbd>Ctrl</kbd> + <kbd>r</kbd>
container listfilter image<kbd>/</kbd>
container listexec container cmd<kbd>Ctrl</kbd> + <kbd>e</kbd>
container logsshow container logs<kbd>Ctrl</kbd> + <kbd>l</kbd>
volume listcreate volume<kbd>c</kbd>
volume listremove volume<kbd>d</kbd>
volume listinspect volume<kbd>Enter</kbd>
volume listrefresh volume list<kbd>Ctrl</kbd> + <kbd>r</kbd>
volume listfilter volume<kbd>/</kbd>
network listinspect network<kbd>Enter</kbd>
network listremove network<kbd>d</kbd>
network listfilter network<kbd>/</kbd>
pull imagepull image<kbd>Enter</kbd>
pull imageclose panel<kbd>Esc</kbd>
create containernext input box<kbd>Tab</kbd>
create containerprevious input box<kbd>Shift</kbd> + <kbd>Tab</kbd>
detailcursor dwon<kbd>j</kbd>
detailcursor up<kbd>k</kbd>
detailnext page<kbd>Ctrl</kbd> / <kbd>f</kbd>
detailprevious page<kbd>Ctrl</kbd> / <kbd>b</kbd>
search imagessearch image<kbd>Enter</kbd>
search imagesclose panel<kbd>Esc</kbd>
search resultnext image<kbd>j</kbd>
search resultprevious image<kbd>k</kbd>
search resultpull image<kbd>Enter</kbd>
search resultclose panel<kbd>q</kbd>
create volumeclose panel<kbd>Esc</kbd>
create volumenext input box<kbd>Tab</kbd>
create volumeprevious input box<kbd>Shift</kbd> + <kbd>Tab</kbd>

How to use

For details of the input panel please refer to wiki

Alternatives