Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/skanehira/docui

TUI Client for Docker
https://github.com/skanehira/docui

docker gocui tui

Last synced: 15 days ago
JSON representation

TUI Client for Docker

Host: GitHub
URL: https://github.com/skanehira/docui
Owner: skanehira
License: mit
Archived: true
Created: 2018-09-08T01:33:55.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2021-12-23T05:12:12.000Z (over 2 years ago)
Last Synced: 2024-05-02T02:29:45.489Z (21 days ago)
Topics: docker, gocui, tui
Language: Go
Homepage:
Size: 64.6 MB
Stars: 2,282
Watchers: 36
Forks: 104
Open Issues: 10
Metadata Files:
- Readme: README.md
- License: LICENSE

Lists

awesome-list - docui
awesome-stars - skanehira/docui
awesome-docker - docui - :skull: An interactive shell UI for managing Docker containers. Also works in Windows. By [@skanehira] (Container Operations / User Interface)
go-awesome - docui - TUI Client for Docker (开源类库 / 容器技术)
go-awesome - docui - TUI Client for Docker (开源类库 / 容器技术)
awesome-from-stars - skanehira/docui
awesome-stars - docui
awesome-luooooob - skanehira/docui - TUI Client for Docker (Go)
awesome-stars - skanehira/docui - TUI Client for Docker (Go)
awesome-star - skanehira/docui
awesome-stars - docui
awesome-docker - docui - :skull: An interactive shell UI for managing Docker containers. Also works in Windows. By [@skanehira] (Container Operations / User Interface)
my-awesome - skanehira/docui - TUI Client for Docker (Go)
awesome-stars - skanehira/docui - TUI Client for Docker (Go)
awesome-stars - skanehira/docui - `★2280` TUI Client for Docker (Go)
go-awesome - docui - TUI client for Docker (Open source library / Container Technology)
awesome - docui - TUI Client for Docker (Go)
awesome-docker - docui - :skull: An interactive shell UI for managing Docker containers. Also works in Windows. By [@skanehira] (Container Operations / User Interface)
my-awesome-stars - skanehira/docui - TUI Client for Docker (Go)
Awesome-GitHub-Repo - docui - 终端 Docker 管理工具，自带一个终端界面。。[<img src="https://tva1.sinaimg.cn/large/008i3skNly1gxlhtmg11mj305k05k746.jpg" alt="微信" width="18px" height="18px" />](https://mp.weixin.qq.com/s?__biz=MzUxNjg4NDEzNA%3D%3D&chksm=f9a1d4fbced65ded0e1856a1db7ce2e6f2c9e423de4428795644770bf2dbb9910874e1678b64&idx=1&mid=2247485234&scene=21&sn=e2ff671bbe9ff9c8a642ccc5793c266a#wechat_redirect) (开源工具 / Docker工具)
go-awesome - docui - TUI Client for Docker (开源类库 / 容器技术)

README

        # docui - TUI Client for Docker Written in Go

[![Go Report Card](https://goreportcard.com/badge/github.com/skanehira/docui?)](https://goreportcard.com/report/github.com/skanehira/docui)

[![CircleCI](https://img.shields.io/circleci/project/github/skanehira/docui.svg?style=flat-square)](https://goreportcard.com/report/github.com/skanehira/docui)

[![CircleCI](https://img.shields.io/github/release/skanehira/docui.svg?style=flat-square)](https://github.com/skanehira/docui/releases)

![GitHub All Releases](https://img.shields.io/github/downloads/skanehira/docui/total.svg?style=flat)

![GitHub commits](https://img.shields.io/github/commits-since/skanehira/docui/1.0.0.svg?style=flat-square)

# This repository is no longer maintenance. Please use [lazydocker](https://github.com/jesseduffield/lazydocker) instead.

## About docui

![demo](https://github.com/skanehira/docui/blob/images/images/docui.v2-demo.gif?raw=true)

docui is a TUI Client for Docker.

It can do the following:

- image

    - search/pull/remove

    - save/import/load

    - inspect/filtering

- container

    - create/remove

    - start/stop/kill

    - export/commit

    - inspect/rename/filtering

    - exec cmd

- volume

    - create/remove

    - inspect/filtering

- network

    - remove

    - inspect/filtering

## Supported OSes

- Mac

- Linux

## Required Tools

- Go Ver.1.11.4~

- Docker Engine Ver.18.06.1~

- Git

## 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](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 install docui

```

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

Check [wiki](https://github.com/skanehira/docui/blob/master/wiki.md).

## 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 / Shift + Tab |

| all              | quit                   | q                                       |

| list panels      | next entry             | j / ↓                        |

| list panels      | previous entry         | k / ↑                        |

| list panels      | next page              | Ctrl / f                     |

| list panels      | previous page          | Ctrl / b                     |

| list panels      | scroll to top          | g                                       |

| list panels      | scroll to bottom       | G                                       |

| image list       | pull image             | p                                       |

| image list       | search images          | f                                       |

| image list       | remove image           | d                                       |

| image list       | create container       | c                                       |

| image list       | inspect image          | Enter                                   |

| image list       | save image             | s                                       |

| image list       | import image           | i                                       |

| image list       | load image             | Ctrl + l                     |

| image list       | refresh image list     | Ctrl + r                     |

| image list       | filter image           | /                                       |

| container list   | inspect container      | Enter                                   |

| container list   | remove container       | d                                       |

| container list   | start container        | u                                       |

| container list   | stop container         | s                                       |

| container list   | kill container         | Ctrl + k                     |

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

| container list   | exec container cmd     | Ctrl + e                     |

| container logs   | show container logs    | Ctrl + l                     |

| volume list      | create volume          | c                                       |

| volume list      | remove volume          | d                                       |

| volume list      | inspect volume         | Enter                                   |

| volume list      | refresh volume list    | Ctrl + r                     |

| volume list      | filter volume          | /                                       |

| network list     | inspect network        | Enter                                   |

| network list     | remove network         | d                                       |

| network list     | filter network         | /                                       |

| pull image       | pull image             | Enter                                   |

| pull image       | close panel            | Esc                                     |

| create container | next input box         | Tab                                     |

| create container | previous input box     | Shift +  Tab                 |

| detail           | cursor dwon            | j                                       |

| detail           | cursor up              | k                                       |

| detail           | next page              | Ctrl / f                     |

| detail           | previous page          | Ctrl / b                     |

| search images    | search image           | Enter                                   |

| search images    | close panel            | Esc                                     |

| search result    | next image             | j                                       |

| search result    | previous image         | k                                       |

| search result    | pull image             | Enter                                   |

| search result    | close panel            | q                                       |

| create volume    | close panel            | Esc                                     |

| create volume    | next input box         | Tab                                     |

| create volume    | previous input box     | Shift +  Tab                 |

## How to use

For details of the input panel please refer to [wiki](https://github.com/skanehira/docui/blob/master/wiki.md)

## Alternatives

- [lazydocker](https://github.com/jesseduffield/lazydocker)

A simple terminal UI for both docker and docker-compose, written in Go with the gocui library.

- [docker.vim](https://github.com/skanehira/docker.vim)

Manage docker containers and images in Vim

- See [Awesome Docker list](https://github.com/veggiemonk/awesome-docker/blob/master/README.md#terminal) for similar tools to work with Docker.