CLI tool for docker images, containers, logs and more.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for pommee from gravatar.com pommee

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • Author: pommee
  • Requires: Python <4.0.0, >=3.10.9
Classifiers
Report project as malware

Project description

PyPI Downloads

👋🏼 Introduction

Pocker is a TUI tool to help with docker related tasks. For example,

  • View containers/images.
  • Manage status of containers.
  • See logs, attributes, environment variables and container statistics.
  • Filter logs based on keywords.
  • Start shell inside a container.
  • Customize configuration, i.e keybinds and behaviour.

The tool is heavily based on docker-py and textual.
A big thanks goes over to the creator and contributors of textual as it makes for a very sleek and easy interface.

"Buy Me A Coffee"

Why?

I spend a lot of time working with Docker, and typing numerous commands can be time-consuming, energy-draining, and inefficient.
This is something that can, of course, be improved with the right tool.

The initial drive was to type less, but has since evolved into more.
Being able to search for a keyword and quickly get live feedback is very nice.
Need a new env variable? Just head over to the shell tab and run one command.

Prerequisite

[!NOTE] Pipx must be installed.
Python version 3.10.9 or newer.

📦 Installation

Pocker is hosted at PyPi (see here).

pipx install pocker-tui           # Latest version
pipx install pocker-tui==version  # Specific version

Install from GitHub repository

PyPi will mostly contain newest version, but it is also possible to run install from this repository.

pipx install git+https://github.com/pommee/Pocker

🚦 Usage

pocker          # Start pocker
pocker update   # Fetch and install latest version

Keybinds can be seen in the footer when started or by pressing ? to display help modal.

🔧 Configuration

Upon the first startup, a configuration file will be generated and stored at $HOME/.config/pocker/config.yaml.

Key Default Info
log_tail 2000 At startup, Pocker will fetch log_tail amount of container logs.
Not recommended to exceed ~3000 as startup will slow down.
max_log_lines 2000 The displayed container logs are shown sequentially, with the oldest log being removed as a new one appears.
show_all_containers false Show running and exited containers.
start_fullscreen false Display container logs in fullscreen mode at startup.
start_scroll true Automatically scrolls when new logs are fetched.
start_wrap false When enabled, logs will wrap to fit the content window.

Keymap [default]

Key Action Description
q Quit Exits the application.
l Logs Opens the logs view to display log entries.
/ Search Search logs.
TAB Cycle widgets Used to cycle widgets. Newly focused widget will have it's borders alter colors.
a Attributes Displays the attributes panel, showing various item attributes.
e Environment Opens the environment settings view.
d Statistics Shows statistical information related to the container.
v Shell Creates a shell for the current container.
f Fullscreen Toggles fullscreen mode for the logs view.
n Fullscreen (Containers & Images) Toggles fullscreen mode for containers and images view.
w Wrap Logs Toggles log wrapping in the logs view.
s Toggle Scroll Toggles scrolling mode for the current view.

This table helps you understand the functionalities assigned to each key, making navigation and operation more efficient.

Errors

Errors will be displayed whenever encountered.
This can occur if an update is released with new keybinds required as an example.
The solution is to either add the new keybind manually or delete the config and restart pocker.
Default keymap can always be found here.

keybind-error

Example of faulty keybind for Shell; in this case the key does not exist in the config.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for pommee from gravatar.com pommee

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • Author: pommee
  • Requires: Python <4.0.0, >=3.10.9
Classifiers

Release history Release notifications | RSS feed

This version

1.18.4

1.18.3

1.18.2

1.18.1

1.18.0

1.17.5

1.17.4

1.17.3

1.17.2

1.17.1

1.17.0

1.16.0

1.15.0

1.14.3

1.14.2

1.14.1

1.14.0

1.13.1

1.13.0

1.12.5

1.12.4

1.12.3

1.12.2

1.12.1

1.12.0

1.11.5

1.11.4

1.11.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pocker_tui-1.18.4.tar.gz (25.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pocker_tui-1.18.4-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

Details for the file pocker_tui-1.18.4.tar.gz.

File metadata

  • Download URL: pocker_tui-1.18.4.tar.gz
  • Upload date:
  • Size: 25.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pocker_tui-1.18.4.tar.gz
Algorithm Hash digest
SHA256 d83b6bf81964ba721871cb9bb796dfa369f30de0d36e5f25ef5c5bfdfb26f8c4
MD5 acf5405eea66622b7b86bdde5aebbb2c
BLAKE2b-256 6ea09d8ae8db4fdf50dfceed0f1a1bad8d1e1d13e391e1b81960ee78c6732bbe

See more details on using hashes here.

Provenance

The following attestation bundles were made for pocker_tui-1.18.4.tar.gz:

Publisher: release.yml on pommee/Pocker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file pocker_tui-1.18.4-py3-none-any.whl.

File metadata

  • Download URL: pocker_tui-1.18.4-py3-none-any.whl
  • Upload date:
  • Size: 31.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for pocker_tui-1.18.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b3535fba299b5fb0354be6491cc2b5999db4b30c0137e811a8969935b7568e74
MD5 27b308ca45f32888af200e1f2b02118c
BLAKE2b-256 c96ceb6f1ca8ddb3d1e15e20109f242d5de7caa4b88a413befb3091c572c03f0

See more details on using hashes here.

Provenance

The following attestation bundles were made for pocker_tui-1.18.4-py3-none-any.whl:

Publisher: release.yml on pommee/Pocker

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page