podman-tui

README

podman-tui

podman-tui is a Terminal User Interface to interact with the podman v3 (>= 3.1).
podman bindings has been used to communicate with podman environment through rest api API (unix socket).

---

Installation

Installation steps are located here.

---

PreRun Checks

• podman-tui use podman unix socket for query therefore podman.socket service needs to be running.
  The recommended way to start Podman system service in production mode is via systemd socket-activation:

  $ systemctl --user start podman.socket
  

  See start podman system service for more details.

• podman-tui uses 256 colors terminal mode. On `Nix system make sure TERM is set accordingly.

  $ export TERM=xterm-256color
  

---

The Command Line

Usage:
  podman-tui [flags]
  podman-tui [command]

Available Commands:
  help        Help about any command
  version     Display podman-tui version and exit.


Flags:
  -d, --debug             Run application in debug mode
  -h, --help              help for podman-tui
  -l, --log-file string   Application runtime log file (default "podman-tui.log")

---

Key Binding

podman-tui uses following keyboard keys for different actions:

Action	Command
Display command menu	m
Switch to next screen	l
Switch to previous screen	h
Move up	k
Move down	j
Exit application	Ctrl+c
Close the active dialog	Esc
Switch between interface widgets	Tab
Move up/down	Up/Down
Scroll Up	Page Up
Scroll Down	Page Down
Display help screen	F1
Display pods screen	F2
Display containers screen	F3
Display volumes screen	F4
Display images screen	F5
Display networks screen	F6
Display system screen	F7

---

Available commands on different views

Check podman-tui docs for list of available commands on different pages (pods, containers, images, ...)

Documentation

Overview

podman-tui is a Terminal User Interface to interact with the podman (v3.x) and its using podman API bindings to communicate with podman environment (unix socket).

Build from source:

• clone repository
• # make build
• # ./bin/podman-tui

Pre-run checks:

• # systemctl --user start podman.socket
• # export TERM=xterm-256color

Key bindings:

• F1: view pods list page
• F2: view container list page
• F3: view volumes list page
• F4: view images list page
• F5: view networks list page
• F6: view system page
• Enter: lunch page command dialog
• Esc: close a dialog
• Tab: switch between interface widgets