podman-tui

README

podman-tui

Terminal user interface for Podman environment.

• Overview
• Compatibility Matrix
• Installation
• PreRun Checks
• Key Bindings
• Code of Conduct
• License

Overview

podman-tui is a terminal user interface for podman environment. It is using podman go bindings to communicate with local or remote podman machine (through SSH).

Compatibility matrix

Terminal User Interface	Podman
release-1.x	v5.x.y
release-0.x	v4.x.y

Installation

Building from source (Linux, Windows and MacOS) or installing packaged versions are detailed in install guide.

PreRun Checks

• podman.socket service needs to be running on podman machine. 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.

• If the SSH key has a passphrase, then you need to set and export CONTAINER_PASSPHRASE=<password> variable.

  $ export CONTAINER_PASSPHRASE=keypass
  

• podman-tui uses 256 colors terminal mode on Nix system and standard ANSI colors on Windows system (use "command prompt" application).

Key Bindings

Check podman-tui docs for keyboard mappings.

Code of Conduct

This project is using the Containers Community Code of Conduct

License

Licensed under the Apache 2.0 license.

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