Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Auto-detect Ghostty and Konsole as supporting the Kitty protocol #24

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Auto-detect Ghostty and Konsole as supporting the Kitty protocol #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6fe1c96
Auto-detect other terminals supporting the Kitty protocol
uncenter Aug 2, 2024
d4459df
docs: update readme for new supported terminals
uncenter Aug 2, 2024
e215df9
Add Ghostty to supported terminal graphics protocol terminals
uncenter Aug 2, 2024
21ecbb0
Use `TERM_PROGRAM` to match Ghostty, remove Konsole mentions/support
uncenter Aug 2, 2024
b8ccbc0
Add Konsole detection and mention support in readme
uncenter Aug 2, 2024
bd70ce9
Merge branch 'master' into pr-baa41156
uncenter Aug 7, 2024
b240894
Fix typo from merge
uncenter Aug 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Options:

A protocol type for rendering images of commit graphs.
By default `auto` will guess the best supported protocol for the current terminal.
Kitty terminals are detected as `kitty` via an environment variable, and all others are assumed to support `iterm`.
Kitty, Ghostty, and Konsole terminals are detected as `kitty` via environment variables, and all others are assumed to support `iterm`.

Refer to [Compatibility](#compatibility) for details.

Expand Down Expand Up @@ -249,6 +249,8 @@ The terminals on which each has been confirmed to work are listed below.
| Terminal emulator | Support | Note |
| ----------------------------------------- | ------- | ---- |
| [kitty](https://sw.kovidgoyal.net/kitty/) | ○ | |
| [Ghostty](https://github.com/ghostty-org) | ○ | |
| [Konsole](https://konsole.kde.org/) | ○ | |

### Reporting Compatibility

Expand Down
5 changes: 4 additions & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,10 @@ fn initialize_panic_handler() {
// By default assume the Iterm2 is the best protocol to use for all terminals *unless* an env
// variable is set that suggests the terminal is probably Kitty.
fn auto_detect_best_protocol() -> protocol::ImageProtocol {
if env::var("KITTY_WINDOW_ID").is_ok() {
if env::var("KITTY_WINDOW_ID").is_ok()
|| env::var("TERM_PROGRAM").is_ok_and(|t| t == "ghostty")
|| env::var("KONSOLE_VERSION").is_ok()
{
protocol::ImageProtocol::Kitty
} else {
protocol::ImageProtocol::Iterm2
Expand Down