little-kitty 0.0.3

A low-level interface for the Kitty Graphics Protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

[![crates.io](https://img.shields.io/crates/v/little-kitty?color=%23227700)](https://crates.io/crates/little-kitty)
[![docs.rs](https://img.shields.io/badge/docs.rs-latest?color=grey)](https://docs.rs/little-kitty)

Little Kitty
============

A low-level Rust interface for the [Kitty graphics protocol](https://sw.kovidgoyal.net/kitty/graphics-protocol.html).

Terminals that support it include::

* [Ghostty](https://github.com/ghostty-org/ghostty)
* [iTerm2](https://github.com/gnachman/iterm2)
* [Kitty](https://github.com/kovidgoyal/kitty) (duh!)
* [Konsole](https://github.com/kde/konsole)
* [Warp](https://github.com/warpdotdev/Warp)
* [Wayst](https://github.com/91861/wayst)
* [WezTerm](https://github.com/wezterm/wezterm)
* [xterm.js](https://github.com/xtermjs/xterm.js)

Little Kitty supports both sprite (standard) and Unicode placeholder modes.

It also automatically uses [tmux](https://github.com/tmux/tmux) passthrough mode if it detects that it's in a tmux session. However, note that this feature is not enabled by default in tmux. To enable it from the terminal:

```sh
tmux set -g allow-passthrough on
```

Or add this to `~/.tmux.conf`:

```
set -g allow-passthrough on
```

Check out the [examples](https://codeberg.org/tliron/little-kitty/src/branch/main/examples).

For a fuller example of usage see [cursive-image](https://codeberg.org/tliron/cursive-image).

Alternatives
------------

* [kitty-graphics-protocol](https://github.com/Darkiiiiiice/kitty-graphics-protocol-rs)
* [kitty_image](https://gitlab.com/john_t/kitty-images)

License
-------

Like much of the Rust ecosystem this project is licensed under your choice of either

* [Apache License, Version 2.0](https://codeberg.org/tliron/little-kitty/src/branch/main/LICENSE-APACHE)
* [MIT license](https://codeberg.org/tliron/little-kitty/src/branch/main/LICENSE-MIT)

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

All code and documentation was written by humans. We do not accept "AI"-generated contributions.