shumengya/sproutclaw
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

feat(tui): detect Warp terminal and enable Kitty image protocol (#5841)

Browse Source 
Warp supports the Kitty graphics protocol and OSC 8 hyperlinks,
but pi's terminal-image capability detection did not recognize it.
Add detection via TERM_PROGRAM=WarpTerminal, WARP_SESSION_ID,
and WARP_TERMINAL_SESSION_UUID so images render inline without
requiring the TERM_PROGRAM=kitty workaround.

Fixes #5827
This commit is contained in:
Diego de Oliveira
2026-06-18 05:45:51 -03:00
committed by GitHub
parent 51f7523587
commit 7a14325b24
3 changed files with 50 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
packages/coding-agent/docs/tui.md
View File

@@ -257,7 +257,7 @@ md.setText("Updated markdown");
### Image
Renders images in supported terminals (Kitty, iTerm2, Ghostty, WezTerm).
Renders images in supported terminals (Kitty, iTerm2, Ghostty, WezTerm, Warp).
```typescript
const image = new Image(

5
packages/tui/src/terminal-image.ts
View File

@@ -92,6 +92,11 @@ export function detectCapabilities(tmuxForwardsHyperlink: () => boolean = probeT
return { images: "kitty", trueColor: true, hyperlinks: true };
}
// Warp supports the Kitty graphics protocol and OSC 8 hyperlinks.
if (termProgram === "warpterminal" || process.env.WARP_SESSION_ID || process.env.WARP_TERMINAL_SESSION_UUID) {
return { images: "kitty", trueColor: true, hyperlinks: true };
}
if (process.env.ITERM_SESSION_ID || termProgram === "iterm.app") {
return { images: "iterm2", trueColor: true, hyperlinks: true };
}

44
packages/tui/test/terminal-image.test.ts
View File

@@ -30,6 +30,8 @@ const ENV_KEYS = [
"ITERM_SESSION_ID",
"WT_SESSION",
"CMUX_WORKSPACE_ID",
"WARP_SESSION_ID",
"WARP_TERMINAL_SESSION_UUID",
] as const;
function withEnv(overrides: Record<string, string | undefined>, fn: () => void): void {
@@ -271,6 +273,48 @@ describe("detectCapabilities", () => {
});
});
it("enables images and hyperlinks for Warp via TERM_PROGRAM", () => {
withEnv({ TERM_PROGRAM: "WarpTerminal" }, () => {
const caps = detectCapabilities();
assert.strictEqual(caps.images, "kitty");
assert.strictEqual(caps.trueColor, true);
assert.strictEqual(caps.hyperlinks, true);
});
});
it("enables images and hyperlinks for Warp via WARP_SESSION_ID", () => {
withEnv({ WARP_SESSION_ID: "some-session-id" }, () => {
const caps = detectCapabilities();
assert.strictEqual(caps.images, "kitty");
assert.strictEqual(caps.trueColor, true);
assert.strictEqual(caps.hyperlinks, true);
});
});
it("enables images and hyperlinks for Warp via WARP_TERMINAL_SESSION_UUID", () => {
withEnv({ WARP_TERMINAL_SESSION_UUID: "d0e1a2e5-7ca7-44cd-9037-ac7222011161" }, () => {
const caps = detectCapabilities();
assert.strictEqual(caps.images, "kitty");
assert.strictEqual(caps.trueColor, true);
assert.strictEqual(caps.hyperlinks, true);
});
});
it("disables images for Warp inside tmux", () => {
withEnv(
{
TERM_PROGRAM: "WarpTerminal",
TMUX: "/tmp/tmux-1000/default,1234,0",
TERM: "tmux-256color",
},
() => {
const caps = detectCapabilities(() => true);
assert.strictEqual(caps.images, null);
assert.strictEqual(caps.hyperlinks, true);
},
);
});
it("enables hyperlinks for iTerm2", () => {
withEnv({ TERM_PROGRAM: "iterm.app" }, () => {
const caps = detectCapabilities();