#image #kitty #terminal #command-line-interface

kitty_image

Display images using the kitty image protocol

1 unstable release

0.1.0 Dec 17, 2023

#1081 in Encoding


Used in tuviv

LGPL-3.0

440KB
874 lines

Kitty Image

A simple rust crate to allow you to display images using the Kitty Image Protocol, most likely for the Kitty Terminal emulator.

Observe the ease in which you can display an image located on the file system:

// Create an action
let action = Action::TransmitAndDisplay(
    ActionTransmission {
        format: Format::Png,
        medium: Medium::File,
        width: 367,
        height: 480,
        ..Default::default()
    },
    kitty_image::ActionPut::default(),
);

// Add the payload to the command
let command = Command::with_payload_from_path(action, "examples/the_scream.png".as_ref());

// Wrap the command in escape codes
let command = WrappedCommand::new(command);

// Print it
println!("{command}");

Check out the examples

Dependencies

~0.2–2.5MB