Versions in this module Expand all Collapse all v1 v1.0.0 Sep 23, 2026 Changes in this version + func Render(s *Session, opts Options) *image.RGBA + func Schemes() []string + type C0 rune + func (seq C0) String() string + type CSI struct + Final rune + Intermediate []rune + Parameters []int + func (seq CSI) String() string + type Cell struct + Combining []rune + Overline bool + Protected bool + Rune rune + Style tcell.Style + Width int + Wrapped bool + func (c Cell) String() string + type DCS struct + Final rune + Intermediate []rune + Parameters []int + type DCSData rune + type DCSEndOfData struct + type DeltaCell struct + Rune rune + Style tcell.Style + X int + Y int + type Drawable interface + Set func(x, y int, c color.Color) + type EOF struct + func (seq EOF) String() string + type ESC struct + Final rune + Intermediate []rune + func (seq ESC) String() string + type EventBell struct + type EventClipboard struct + func (ev *EventClipboard) Data() string + func (ev *EventClipboard) Selection() string + type EventClosed struct + type EventColour struct + Index int + Value string + type EventDCS struct + Final rune + Parameters []int + type EventDCSData struct + Data rune + type EventDefaultColour struct + IsForeground bool + Value string + type EventLogEntry struct + Args interface{} + Sequence string + Time time.Time + Type string + type EventMouseMode struct + func (ev *EventMouseMode) Flags() []tcell.MouseFlags + type EventPanic struct + Error error + type EventRedraw struct + type EventTerminal struct + func (ev *EventTerminal) Session() *Session + func (ev *EventTerminal) When() time.Time + type EventTitle struct + func (ev *EventTitle) Title() string + type Font struct + func NewFont(w, h uint8, cm map[rune]uint16, d []uint32) *Font + func (p *Font) DrawRune(dr Drawable, x, y int, r rune, clr color.Color) (bool, int) + func (p *Font) GetHeight() int + func (p *Font) GetWidth() int + func (p *Font) MeasureRune(r rune) (bool, int) + func (p *Font) SetVariableWidth(isVar bool) + type Frame struct + EventType string + Input []byte + Output []byte + ScreenSnapshot string + Timestamp time.Duration + type LineType int + const LineTypeBlank + const LineTypeCommand + const LineTypeError + const LineTypeOutput + const LineTypePrompt + const LineTypeStatusBar + const LineTypeUnknown + func (lt LineType) String() string + type MockTerminal struct + func NewMockTerminal(t testingT, width, height int) *MockTerminal + func (m *MockTerminal) AssertBackground(x, y int, want tcellcolor.Color) + func (m *MockTerminal) AssertBold(x, y int) + func (m *MockTerminal) AssertCell(x, y int, want rune) + func (m *MockTerminal) AssertCombining(x, y int, want ...rune) + func (m *MockTerminal) AssertContains(substr string) + func (m *MockTerminal) AssertCursor(col, row int) + func (m *MockTerminal) AssertForeground(x, y int, want tcellcolor.Color) + func (m *MockTerminal) AssertItalic(x, y int) + func (m *MockTerminal) AssertLine(y int, want string) + func (m *MockTerminal) AssertOutput(want string) + func (m *MockTerminal) AssertScrollbackLine(n int, want string) + func (m *MockTerminal) AssertStyle(x, y int, want tcell.Style) + func (m *MockTerminal) AssertUnderline(x, y int) + func (m *MockTerminal) Dump() string + func (m *MockTerminal) Feed(s string) int + func (m *MockTerminal) SendKey(key tcell.Key, str string, mod tcell.ModMask) + func (m *MockTerminal) SendRune(r rune) + func (m *MockTerminal) Snapshot() string + type Modes struct + AltScreen bool + Autowrap bool + BracketedPaste bool + CursorKeyMode bool + CursorVisible bool + FocusEvents bool + InsertMode bool + MouseMode TrackingMode + OriginMode bool + ReverseVideo bool + SynchronizedOutput bool + type OSC struct + Payload []rune + func (seq OSC) String() string + type Options struct + BgDefault color.Color + BoldAsBright bool + CellHeight int + CellWidth int + CursorColour color.Color + CursorStyle tcell.CursorStyle + DimFactor float64 + DrawBoxChars bool + FgDefault color.Color + Font font.Face + FontBold font.Face + FontBoldItalic font.Face + FontItalic font.Face + Padding int + RenderCursor bool + Scale int + Scheme *Scheme + func DefaultRenderOptions() Options + type Parser struct + func NewParser(r io.Reader) *Parser + func (p *Parser) Next() Sequence + func (p *Parser) SetExitFunc(f func()) + type Player struct + func NewPlayer(data []byte) (*Player, error) + func NewPlayerFromReader(r io.Reader) (*Player, error) + func (p *Player) Current() Frame + func (p *Player) Elapsed() time.Duration + func (p *Player) Metadata() map[string]string + func (p *Player) Next() (*Frame, error) + func (p *Player) Pos() (current, total int) + func (p *Player) Seek(offset time.Duration) error + type Print rune + func (seq Print) String() string + type Recording struct + Frames []Frame + Metadata map[string]string + Start time.Time + func NewRecorder(h *Terminal) *Recording + func (r *Recording) Close() error + func (r *Recording) ExportAsciinema() ([]byte, error) + func (r *Recording) ExportRaw() ([]byte, error) + func (r *Recording) Feed(b []byte) (int, error) + func (r *Recording) FeedString(s string) (int, error) + func (r *Recording) Snapshot() + type Scheme struct + Background color.Color + Cursor color.Color + Foreground color.Color + Name string + Palette [256]color.Color + func SchemeByName(name string) (*Scheme, bool) + func (s *Scheme) Color(i int) (color.Color, bool) + type SchemeSpec struct + Background string + Cursor string + Foreground string + Name string + Palette []string + func (spec SchemeSpec) Build() *Scheme + type Screen interface + SetContent func(x int, y int, ch rune, comb []rune, style tcell.Style) + Size func() (int, int) + type ScreenDelta struct + Changed []DeltaCell + CursorChanged bool + CursorCol int + CursorRow int + CursorVisible bool + type ScreenLine struct + Styles []tcell.Style + Text string + Type LineType + type Sequence interface + type Session struct + Logger *log.Logger + MaxClipboardLen int + OSC8 bool + TERM string + func New() *Session + func NewWithSize(width, height int) *Session + func (s *Session) Attach(fn func(ev tcell.Event)) + func (s *Session) ClearEventLog() + func (s *Session) Close() + func (s *Session) Cursor() (int, int, tcell.CursorStyle, bool) + func (s *Session) Detach() + func (s *Session) Draw() + func (s *Session) EventLog(limit int) []EventLogEntry + func (s *Session) GetActiveCharset() string + func (s *Session) GetClipboard(selection string) (string, bool) + func (s *Session) GetCursorStyle() tcell.CursorStyle + func (s *Session) GetDimensions() (width, height int) + func (s *Session) GetMargins() (top, bottom, left, right int) + func (s *Session) GetModes() Modes + func (s *Session) GetTabStops() []int + func (s *Session) HandleEvent(e tcell.Event) bool + func (s *Session) HasSurface() bool + func (s *Session) IsAltScreen() bool + func (s *Session) Resize(w int, h int) + func (s *Session) ScrollBy(n int) + func (s *Session) ScrollOffset() int + func (s *Session) SendSignal(sig os.Signal) error + func (s *Session) SetClipboard(selection, data string) + func (s *Session) SetLogger(logger *log.Logger) + func (s *Session) SetMaxClipboardLen(n int) + func (s *Session) SetOSC8(enabled bool) + func (s *Session) SetRedrawHandler(fn func()) + func (s *Session) SetSurface(srf Screen) + func (s *Session) SetTERM(term string) + func (s *Session) Start(cmd *exec.Cmd) error + func (s *Session) StartWithPty(p io.ReadWriteCloser) error + func (s *Session) String() string + func (s *Session) Write(p []byte) (int, error) + type Terminal struct + func NewTerminal(width, height int) (*Terminal, error) + func (t *Terminal) AnalyzeScreen() []ScreenLine + func (t *Terminal) Cell(x, y int) Cell + func (t *Terminal) Close() error + func (t *Terminal) Cursor() (col, row int, visible bool) + func (t *Terminal) ExpectEcho(input string, timeout time.Duration) (echoed string, ok bool) + func (t *Terminal) Feed(b []byte) (int, error) + func (t *Terminal) FeedString(s string) (int, error) + func (t *Terminal) FindPrompt() int + func (t *Terminal) GetDelta() ScreenDelta + func (t *Terminal) GetErrorLine() (text string, line int, ok bool) + func (t *Terminal) GetLastOutput() string + func (t *Terminal) GetModes() Modes + func (t *Terminal) HandleEvent(ev tcell.Event) bool + func (t *Terminal) Lines() []string + func (t *Terminal) Output() []byte + func (t *Terminal) RenderImage(opts Options) *image.RGBA + func (t *Terminal) Resize(width, height int) + func (t *Terminal) ScrollbackLen() int + func (t *Terminal) ScrollbackLine(n int) (string, bool) + func (t *Terminal) SendCommandAndWait(cmd string, prompts []string, timeout time.Duration) (output string, err error) + func (t *Terminal) Session() *Session + func (t *Terminal) Size() (int, int) + func (t *Terminal) String() string + func (t *Terminal) WaitForCursor(col, row int, timeout time.Duration) error + func (t *Terminal) WaitForPattern(re *regexp.Regexp, timeout time.Duration) (line string, y int, err error) + func (t *Terminal) WaitForStable(quietTime, maxWait time.Duration) error + func (t *Terminal) WaitForText(text string, timeout time.Duration) (col, row int, err error) + type TrackingMode int + const MouseModeNone + const MouseModeSGR + const MouseModeURXVT + const MouseModeUTF8 + const MouseModeVT200 + const MouseModeVT200Drag + const MouseModeVT200Motion + const MouseModeX10 + func (m TrackingMode) String() string