detect

Documentation

Overview

Package detect identifies terminal graphics capabilities.

Index

• type Protocol
  • func Best() Protocol
  • func (p Protocol) String() string

Types

type Protocol

type Protocol int

Protocol is a terminal graphics protocol.

const (
	HalfBlock Protocol = iota // always works: Unicode ▀▄
	Sixel                     // DEC Sixel — xterm, mlterm, foot, WezTerm
	Kitty                     // Kitty graphics — kitty, WezTerm ≥0.29, Ghostty
)

func Best

func Best() Protocol

Best returns the best protocol the current terminal supports. It checks environment variables; it does NOT send ANSI queries (no TTY req).

func (Protocol) String

func (p Protocol) String() string