oxker

Built in Rust, making heavy use of ratatui & Bollard

Download & install

Cargo

Published on crates.io, so if you have cargo installed, simply run

shell cargo install oxker

Docker

Published on Docker Hub and ghcr.io, with images built for linux/amd64, linux/arm64, and linux/arm/v6

via Docker Hub shell docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock:ro --pull=always mrjackwills/oxker

via ghcr.io

shell docker run --rm -it -v /var/run/docker.sock:/var/run/docker.sock:ro --pull=always ghcr.io/mrjackwills/oxker

Nix

Using nix flakes, oxker can be ran directly with

shell nix run nixpkgs#oxker

Without flakes, you can build a shell that contains oxker using

shell nix-shell -p oxker

AUR

oxker can be installed from the AUR with using an AUR helper:

shell paru -S oxker

Pre-Built

See the pre-built binaries

or, download & install (x86_64 one liner)

shell wget https://www.github.com/mrjackwills/oxker/releases/latest/download/oxker_linux_x86_64.tar.gz && tar xzvf oxker_linux_x86_64.tar.gz oxker && install -Dm 755 oxker -t "${HOME}/.local/bin" && rm oxker_linux_x86_64.tar.gz oxker

or, for automatic platform selection, download, and installation (to $HOME/.local/bin)

One should always verify script content before running in a shell

shell curl https://raw.githubusercontent.com/mrjackwills/oxker/main/install.sh | bash

Run

shell oxker

In application controls | button| result| |--|--| | ( tab ) or ( shift+tab ) | change panel, clicking on a panel also changes the selected panel| | ( ↑ ↓ ) or ( j k ) or ( PgUp PgDown ) or ( Home End )| change selected line in selected panel, mouse scroll also changes selected line | | ( enter )| execute selected docker command| | ( 1-9 ) | sort containers by heading, clicking on headings also sorts the selected column | | ( 0 ) | stop sorting | | ( h ) | toggle help menu | | ( m ) | toggle mouse capture - if disabled, text on screen can be selected| | ( q ) | to quit at any time |

Available command line arguments | argument|result| |--|--| |-d [number > 0]| set the minimum update interval for docker information, in ms, defaults to 1000 (1 second) | |-r| show raw logs, by default oxker will remove ANSI formatting (conflicts with -c) | |-c| attempt to color the logs (conflicts with -r) | |-t| remove timestamps from each log entry | |-s| if running via docker, will show the oxker container | |-g| no tui, basically a pointless debugging mode, for now |

Build step

x86_64

shell cargo build --release

Raspberry pi

requires docker & cross-rs

64bit pi (pi 4, pi zero w 2)

shell cross build --target aarch64-unknown-linux-gnu --release

32bit pi (pi zero w)

Tested, and fully working on pi zero w, running Raspberry Pi OS 32 bit, the initial logs parsing can take an extended period of time if thousands of lines long, suggest running with a -d argument of 5000

shell cross build --target arm-unknown-linux-musleabihf --release

If no memory information available, try appending /boot/cmdline.txt with

cgroup_enable=cpuset cgroup_enable=memory

see https://forums.raspberrypi.com/viewtopic.php?t=203128 and https://github.com/docker/for-linux/issues/1112

Untested on other platforms

Tests

As of yet untested, needs work

shell cargo test -- --test-threads=1

Run some example docker images

using docker-compose.yml;

shell docker compose -f docker-compose.yml up -d

or individually

shell docker run --name redis -d redis:alpine3.17

shell docker run --name postgres -e POSTGRES_PASSWORD=never_use_this_password_in_production -d postgres:alpine3.17

shell docker run -d --hostname my-rabbit --name rabbitmq rabbitmq:3