NAME

ueberzugpp - display images in a terminal

SYNOPSIS

ueberzugpp [options]

ueberzugpp is a program meant to display images in a terminal in a with an IPC.

x11 (May not be available if disabled in compilation)
sixel
kitty
iterm2
wayland (May not be available if disabled in compilation)
chafa

Ueberzugpp reads commands through stdin. Or through the unix socket located at /tmp/ueberzug_.sock

Commands should be in JSON form, as described in the JSON IPC section

There are two actions, add and remove

action json schema

Requried Keys

action (string): should be add
path (string): the path to the image to use
identifier (string): an identifier for the image, so that it can be removed with the remove action
One of, width/height, or max_width/max_height
width (integer): width of the image
max_width (integer): maximum width of the image
height (integer): height of the image
max_height (integer): maximum height of the image
x (integer): the column position in the terminal
y (integer): the row position in the terminal

Optional keys

scaler (string): can be fit_contain or forced_cover.
Both base the scale on whichever is larger, the width, or height of the image

action json schema

Requried Keys

Create a fifo file named fifo, and have an image in the current folder named image.png for this example to work

ueberzugpp layer -o sixel < fifo &

echo '{"path": "./image.png", "action": "add", "identifier": "image", "x": 0, "y": 0, "width": 20, "height": 20}' > fifo

2023 May

Ueberzugpp 2.9.6