use tmux passthrough for kitty graphics protocol #3086

l4zygreed · Apr 27, 2025

Updated Ethan PR for current master

ISSUE TYPE

Improvement/feature implementation

RUNTIME ENVIRONMENT

Operating system and version: Macos sequoia 15.4
Terminal emulator and version: Ghostty 1.1.3
Python version: 3.13.3
Ranger version/commit: ranger-master v1.9.3-794-gcf51b12f
Locale: en_US.UTF-8

CHECKLIST

The CONTRIBUTING document has been read [REQUIRED]
All changes follow the code style [REQUIRED]
All new and existing tests pass [REQUIRED]
Changes require config files to be updated
- Config files have been updated

DESCRIPTION

Updated PR #2856 to be compatible with current master branch.

MOTIVATION AND CONTEXT

Want to finally see images inside tmux on my mac and outside of iterm/kitty terminal 😆
Found old Ethan PR and decided to resolve conflicts and update it for current master

TESTING

make test executed successfully
kitty without tmux
kitty with tmux and allow-passthrough not set
kitty with tmux and allow-passthrough set
ghostty without tmux
ghostty with tmux and allow-passthrough not set
ghostty with tmux and allow-passthrough set

IMAGES / VIDEOS

cleanshot.mp4

Ethsan

Hey, thanks for the keeping the pr alive and the update, it's cleaner now!

Should we separate the commit in two ? Something like :

support for virtual placement using unicode placeholder
support for tmux allow-passthrough mode

Moreover some minor changes below.

ranger/ext/img_display.py

Ethsan · May 18, 2025

Resolve #2414, Resolve #2846, Resolve #3072

toonn · May 19, 2025

Do the resolve comments work in comments or should they be part of commit messages?
(Since this seems to work for both of you I think it's had enough testing. Feel free to pester me once a week until I review and merge.)

Ethsan · May 19, 2025

Hi,

Do the resolve comments work in comments or should they be part of commit messages?

From what I read, the resolve don't work in comment, so they should be part of the commit message. I have commented them so we don't have to search them later.

(Since this seems to work for both of you I think it's had enough testing. Feel free to pester me once a week until I review and merge.)

Ok, the PR seems good for me.

Ethsan · May 22, 2025

Hi,
@toonn do you prefer something like that ? or should we revert ?

ranger/ext/img_display.py

toonn

FWIW in the future I'd prefer if people tried to PR to the PR branch of the original PR author, possibly linking to the downstream PR in our PR comments. It's inconvenient to keep track of things if people keep opening new PRs that are really the same thing. Rebasing on master is usually quite trivial so you can rest assured that that is not what holds back a PR from getting merged.

In this case Ethsan seems perfectly happy with the situation but it can come across as trying to take credit for someone else's work. All of this is easily avoided by opening the PR against their PR branch.

ranger/data/rowcolumn-diacritics.txt

ranger/ext/img_display.py

l4zygreed · Jul 4, 2025

Sorry, been busy. (War and busy work - great combination, lol 🤣)
Thought Ethsan would add the fixes. But I can work on PR a little bit now.

Ethsan · Jul 4, 2025

I wanted too but I was busy and then completely forgot the PR. Sorry about that

ranger/ext/img_display.py

l4zygreed · Aug 24, 2025

@toonn Hello, can you review new commits? 🙃

l4zygreed · Sep 8, 2025

@toonn 👋🏻😪

l4zygreed · Sep 20, 2025

@toonn Notice me, senpai 😢

l4zygreed · Oct 4, 2025

@toonn

l4zygreed · Oct 25, 2025

@toonn

l4zygreed · Oct 31, 2025

@toonn check the commits, senpai

toonn

Some minor things I wanted to ask, let me know what you think.

ranger/ext/img_display.py

toonn · Oct 31, 2025

ranger/ext/img_display.py

+                self.tmux_protocol_start,
+                self.protocol_start,
+                msg,
+                self.tmux_protocol_end,


I think I see what you're doing with tmux_protocol_{start,end} but that seems confusing honestly, because of the interleaving.

And couldn't the msg contain \x1b? I think being explicit about doubling the \x1bs would be more straightforward code.

messages containing \x1b doesn't use wrap function.

but updated anyway, now should be less confusing.

toonn · Oct 31, 2025

ranger/ext/img_display.py

+        # Wrap bite string into protocol.
+        # With tmux passthrough if inside tmux.
+        if self.is_tmux:
+            return b'%s%s%s%s%s' % (


Let's use "".format() syntax, % is really old.

Bytes doesn't have format attribute, so this syntax AFAIK is the only formatting syntax for them.

Workarounds are:

possible double conversion - convert bytes into strings (because otherwise they'll be formatted as b'b"msg"'), format as string and then encode into bytes. (Or remove all encodes before that.)

do something like b''.join(protocal_start, msg, protocol_end)

ranger/ext/img_display.py

Updated Ethan PR for current master Co-authored-by: Ethan <milonthan@gmail.com>

In some apps code 027 should be used instead of 033, but x1b is universal value

Wrote protocol wrap, read, and write functions for kitty class. Also replaced string concatenation with formatting to decrease a little amount of operations and memory allocations.

Ethsan reviewed May 17, 2025

View reviewed changes

ranger/ext/img_display.py Show resolved Hide resolved

ranger/ext/img_display.py Outdated Show resolved Hide resolved

ranger/ext/img_display.py Outdated Show resolved Hide resolved

Ethsan reviewed May 17, 2025

View reviewed changes

ranger/ext/img_display.py Outdated Show resolved Hide resolved

l4zygreed force-pushed the feat/kitty_in_tmux branch from 3608676 to 3ac971f Compare May 18, 2025 04:55

Ethsan mentioned this pull request May 19, 2025

Fix image display with tmux + kitty #2856

Closed

5 tasks

Ethsan force-pushed the feat/kitty_in_tmux branch 2 times, most recently from 153c40b to 62c8d89 Compare May 22, 2025 23:00

l4zygreed commented May 23, 2025

View reviewed changes

ranger/ext/img_display.py Outdated Show resolved Hide resolved

toonn reviewed May 23, 2025

View reviewed changes

l4zygreed force-pushed the feat/kitty_in_tmux branch from 519e4f1 to c9c4776 Compare July 4, 2025 17:19

Ethsan reviewed Jul 4, 2025

View reviewed changes

ranger/ext/img_display.py Show resolved Hide resolved

l4zygreed force-pushed the feat/kitty_in_tmux branch from c9c4776 to fa64967 Compare July 13, 2025 20:52

eMPee584 reviewed Jul 19, 2025

View reviewed changes

ranger/ext/img_display.py Outdated Show resolved Hide resolved

l4zygreed force-pushed the feat/kitty_in_tmux branch from e26c319 to 0e10248 Compare August 15, 2025 10:18

l4zygreed requested a review from toonn August 15, 2025 10:29

l4zygreed force-pushed the feat/kitty_in_tmux branch from 0e10248 to 59634bc Compare August 28, 2025 23:47

l4zygreed force-pushed the feat/kitty_in_tmux branch from 59634bc to 7076abb Compare September 12, 2025 23:33

l4zygreed force-pushed the feat/kitty_in_tmux branch from 7076abb to fbce1e0 Compare October 25, 2025 14:33

l4zygreed force-pushed the feat/kitty_in_tmux branch from e5e0508 to 9f9e4b7 Compare October 31, 2025 15:25

toonn reviewed Oct 31, 2025

View reviewed changes

Jagholin reviewed Nov 2, 2025

View reviewed changes

ranger/ext/img_display.py Outdated Show resolved Hide resolved

l4zygreed force-pushed the feat/kitty_in_tmux branch 6 times, most recently from 5aa71e9 to cf07846 Compare November 9, 2025 22:49

l4zygreed and others added 15 commits December 6, 2025 06:38

support for virtual placement using unicode placeholder

17fc045

Updated Ethan PR for current master Co-authored-by: Ethan <milonthan@gmail.com>

fixup! support for virtual placement using unicode placeholder

13f6c77

support for tmux allow-passthrough mode

9d3641b

Updated Ethan PR for current master Co-authored-by: Ethan <milonthan@gmail.com>

Update comments and error messages to requested

d04caf3

Update diacritics path to correct one

66ef7f1

Replace slice comparison with endswith

c69287f

Replace diacritics csv parsing with python code

dd2f1db

Replace 033 code with x1b

9824e28

In some apps code 027 should be used instead of 033, but x1b is universal value

Do not change response_end if launched inside vim/nvim terminal

bb5f7e3

Replace tmux show with tmux show-options

b22f2f1

refactor: unify kitty write and read

e9c7c49

Wrote protocol wrap, read, and write functions for kitty class. Also replaced string concatenation with formatting to decrease a little amount of operations and memory allocations.

Add KeyboardInterrupt to KIP read loop

af50728

fix typo in function name

ebce310

move KITTY_PLACEHOLDER to diacritics file

de90fc9

update tmux wrapping in kitty protocol

4d948cb

l4zygreed force-pushed the feat/kitty_in_tmux branch from cf07846 to 4d948cb Compare December 6, 2025 04:38

Search code, repositories, users, issues, pull requests...

use tmux passthrough for kitty graphics protocol #3086

Are you sure you want to change the base?

use tmux passthrough for kitty graphics protocol #3086

Uh oh!

Conversation

l4zygreed commented Apr 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

ISSUE TYPE

RUNTIME ENVIRONMENT

CHECKLIST

DESCRIPTION

MOTIVATION AND CONTEXT

TESTING

IMAGES / VIDEOS

Uh oh!

Ethsan left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Ethsan commented May 18, 2025

Uh oh!

toonn commented May 19, 2025

Uh oh!

Ethsan commented May 19, 2025

Uh oh!

Ethsan commented May 22, 2025

Uh oh!

Uh oh!

toonn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

l4zygreed commented Jul 4, 2025

Uh oh!

Ethsan commented Jul 4, 2025

Uh oh!

Uh oh!

Uh oh!

l4zygreed commented Aug 24, 2025

Uh oh!

l4zygreed commented Sep 8, 2025

Uh oh!

l4zygreed commented Sep 20, 2025

Uh oh!

l4zygreed commented Oct 4, 2025

Uh oh!

l4zygreed commented Oct 25, 2025

Uh oh!

l4zygreed commented Oct 31, 2025

Uh oh!

toonn left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

toonn Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

l4zygreed Nov 2, 2025

Choose a reason for hiding this comment

Uh oh!

toonn Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

l4zygreed Nov 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

l4zygreed commented Apr 27, 2025 •

edited

Loading

Ethsan left a comment •

edited

Loading

l4zygreed Nov 2, 2025 •

edited

Loading