has_tgp_support: Determine if terminal supports Terminal Graphics Protocol

View source: R/has_tgp_support.R

has_tgp_supportR Documentation

Determine if terminal supports Terminal Graphics Protocol

Description

Determine if terminal supports Terminal Graphics Protocol

Usage

has_tgp_support(warn = FALSE, throw = FALSE)

Arguments

warn

show warnings when the protocol is not supported.

throw

throw an error when we are running in a kitty terminal.

Value

Returns TRUE if the current terminal supports the Terminal Graphics Protocol and FALSE otherwise. Will also return FALSE when not running in a terminal.

Examples

if (has_tgp_support()) {
  cat("Yeeh, your terminal supports the terminal graphics protocol!")
}


terminalgraphics documentation built on Aug. 28, 2025, 9:09 a.m.