https://github.com/containers/podman-tui

Podman Terminal UI
https://github.com/containers/podman-tui

containers podman terminal-ui

Last synced: 2 days ago
JSON representation

Podman Terminal UI

• Host: GitHub
• URL: https://github.com/containers/podman-tui
• Owner: containers
• License: apache-2.0
• Created: 2022-01-21T15:34:14.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-19T00:59:28.000Z (2 months ago)
• Last Synced: 2024-10-19T05:19:28.839Z (2 months ago)
• Topics: containers, podman, terminal-ui
• Language: Go
• Homepage:
• Size: 35.3 MB
• Stars: 630
• Watchers: 17
• Forks: 28
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE-OF-CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-tuis - Podman-tui

README

        
## podman-tui

![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)

![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/containers/podman-tui)

![Go](https://github.com/containers/podman-tui/workflows/Go/badge.svg)

[![Go Report](https://goreportcard.com/badge/github.com/containers/podman-tui)](https://goreportcard.com/report/github.com/containers/podman-tui)

[![codecov](https://codecov.io/gh/navidys/podman-tui/branch/main/graph/badge.svg)](https://codecov.io/gh/navidys/podman-tui)

Terminal user interface for Podman environment.

![Screenshot](./docs/podman-tui.gif)

- [**Overview**](#overview)

- [**Compatibility Matrix**](#compatibility-matrix)

- [**Installation**](#installation)

- [**PreRun Checks**](#prerun-checks)

- [**Key Bindings**](#key-bindings)

- [**Code of Conduct**](#code-of-conduct)

- [**License**](#license)

## Overview

podman-tui is a terminal user interface for podman environment.

It is using [podman go bindings](https://github.com/containers/podman/tree/main/pkg/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](install.md).

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

    ```shell

    $ systemctl --user start podman.socket

    ```

    See [start podman system service](https://podman.io/blogs/2020/08/10/podman-go-bindings.html) for more details.

* If the SSH key has a passphrase, then you need to set and export `CONTAINER_PASSPHRASE=` variable.

    ```shell

    $ 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](./docs/README.md) for keyboard mappings.

## Code of Conduct

This project is using the [Containers Community Code of Conduct](https://github.com/containers/common/blob/main/CODE-OF-CONDUCT.md)

## License

Licensed under the [Apache 2.0](LICENSE) license.