Versions in this module Expand all Collapse all v0 v0.0.1 Feb 20, 2026 Changes in this version + func NormalizeSessionID(sessionID string) string + func NotificationEventTypes() []string + func NotificationEventTypesAll() []string + func NotificationEventTypesGlobal() []string + func NotificationTypeFromString(event string) (pb.NotificationType, error) + func NotificationTypeToString(notifType pb.NotificationType) string + type BroadcastDomain struct + SessionIds []string + type Client struct + func New(wsURL string) *Client + func (c *Client) ActivateSession(ctx context.Context, sessionID string, selectSession bool) (*pb.ActivateResponse, error) + func (c *Client) ActivateSessionWithOptions(ctx context.Context, sessionID string, ...) (*pb.ActivateResponse, error) + func (c *Client) ActivateTab(ctx context.Context, tabID string, selectTab bool) (*pb.ActivateResponse, error) + func (c *Client) ActivateWindow(ctx context.Context, windowID string, orderFront bool) (*pb.ActivateResponse, error) + func (c *Client) ApplyColorPreset(ctx context.Context, presetName, profileName string) error + func (c *Client) BindKey(ctx context.Context, key, action, profile string, global bool, ...) error + func (c *Client) ClearBuffer(ctx context.Context, sessionID string, scrollback, screenOnly bool) error + func (c *Client) ClearHighlights(ctx context.Context, sessionID string) error + func (c *Client) ClearSelection(ctx context.Context, sessionID string) error + func (c *Client) ClearSessionBadge(ctx context.Context, sessionID string) error + func (c *Client) ClearTabColor(ctx context.Context, tabID string) error + func (c *Client) ClearTabTitle(ctx context.Context, tabID string) error + func (c *Client) ClearWindowTitle(ctx context.Context, windowID string) error + func (c *Client) Close() error + func (c *Client) CloseSessions(ctx context.Context, sessionIDs []string, force bool) (*pb.CloseResponse, error) + func (c *Client) CloseTabs(ctx context.Context, tabIDs []string, force bool) (*pb.CloseResponse, error) + func (c *Client) CloseWindows(ctx context.Context, windowIDs []string, force bool) (*pb.CloseResponse, error) + func (c *Client) ConfirmAlert(ctx context.Context, message, title string) (interface{}, error) + func (c *Client) Connect(ctx context.Context) error + func (c *Client) CopySelection(ctx context.Context, sessionID string) error + func (c *Client) CreateTabWithOptions(ctx context.Context, profileName, windowID string, tabIndex uint32, ...) (*pb.CreateTabResponse, error) + func (c *Client) CreateWindow(ctx context.Context, profileName string) (*pb.CreateTabResponse, error) + func (c *Client) DeleteVariableWithScope(ctx context.Context, scope string, id string, name string) error + func (c *Client) ExportColorPreset(ctx context.Context, name, filePath string) error + func (c *Client) ExportKeyBindings(ctx context.Context, filename, profile string, global bool) error + func (c *Client) FindText(ctx context.Context, sessionID, pattern string, ...) ([]*FindResult, error) + func (c *Client) GetAllVariables(ctx context.Context, sessionID, tabID, windowID string) ([]*VariableInfo, error) + func (c *Client) GetBroadcastDomains(ctx context.Context) ([]*BroadcastDomain, error) + func (c *Client) GetBufferWithStyles(ctx context.Context, sessionID string, lines int32, includeStyles bool) (*pb.GetBufferResponse, error) + func (c *Client) GetColorPreset(ctx context.Context, name string) (*ColorPreset, error) + func (c *Client) GetContents(ctx context.Context, sessionID string, firstLine, numLines int32) (*pb.GetBufferResponse, error) + func (c *Client) GetContentsWithStyles(ctx context.Context, sessionID string, firstLine, numLines int32, ...) (*pb.GetBufferResponse, error) + func (c *Client) GetCursor(ctx context.Context, sessionID string) (*pb.Coord, error) + func (c *Client) GetFocus(ctx context.Context) (*FocusInfo, error) + func (c *Client) GetMultipleVariablesWithScope(ctx context.Context, scope string, id string, names []string) (map[string]string, error) + func (c *Client) GetPreference(ctx context.Context, key string) (interface{}, error) + func (c *Client) GetPreferences(ctx context.Context, keys []string) (map[string]interface{}, error) + func (c *Client) GetProfile(ctx context.Context, profileName string) (map[string]interface{}, error) + func (c *Client) GetProfileProperty(ctx context.Context, profileName, key string) (interface{}, error) + func (c *Client) GetPrompt(ctx context.Context, sessionID string) (*pb.GetPromptResponse, error) + func (c *Client) GetPromptByID(ctx context.Context, sessionID, promptID string) (*pb.GetPromptResponse, error) + func (c *Client) GetScreenContents(ctx context.Context, sessionID string) (*pb.GetBufferResponse, error) + func (c *Client) GetScreenContentsWithStyles(ctx context.Context, sessionID string, includeStyles bool) (*pb.GetBufferResponse, error) + func (c *Client) GetSelection(ctx context.Context, sessionID string) (*pb.Selection, error) + func (c *Client) GetSelectionText(ctx context.Context, sessionID string) (string, error) + func (c *Client) GetSessionBadge(ctx context.Context, sessionID string) (string, error) + func (c *Client) GetSessionProfileProperty(ctx context.Context, sessionID, key string) (interface{}, error) + func (c *Client) GetSessionProperty(ctx context.Context, sessionID, property string) (string, error) + func (c *Client) GetTabColor(ctx context.Context, tabID string) (red, green, blue float64, enabled bool, err error) + func (c *Client) GetTabTitle(ctx context.Context, tabID string) (string, error) + func (c *Client) GetVariable(ctx context.Context, sessionID, name string) (string, error) + func (c *Client) GetVariableWithScope(ctx context.Context, scope string, id string, name string) (string, error) + func (c *Client) GetWindowProperty(ctx context.Context, windowID, property string) (string, error) + func (c *Client) GetWindowTitle(ctx context.Context, windowID string) (string, error) + func (c *Client) HighlightText(ctx context.Context, sessionID, pattern string, ...) ([]*HighlightResult, error) + func (c *Client) ImportColorPreset(ctx context.Context, name, filePath string) error + func (c *Client) ImportKeyBindings(ctx context.Context, filename, profile string, global, merge bool) error + func (c *Client) InjectData(ctx context.Context, sessionID string, data []byte) error + func (c *Client) InputAlert(ctx context.Context, prompt, title, defaultText string, secure bool) (interface{}, error) + func (c *Client) InvokeFunction(ctx context.Context, invocation string, sessionID, tabID, windowID *string, ...) (interface{}, error) + func (c *Client) ListArrangements(ctx context.Context) (*pb.SavedArrangementResponse, error) + func (c *Client) ListColorPresets(ctx context.Context) ([]string, error) + func (c *Client) ListCustomControls(ctx context.Context) (interface{}, error) + func (c *Client) ListKeyBindings(ctx context.Context, profile string, global bool) ([]interface{}, error) + func (c *Client) ListProfiles(ctx context.Context, detailed bool) ([]string, error) + func (c *Client) ListProfilesDetailed(ctx context.Context) ([]*pb.ListProfilesResponse_Profile, error) + func (c *Client) ListProfilesSimple(ctx context.Context) ([]string, error) + func (c *Client) ListPrompts(ctx context.Context, sessionID string) (*pb.ListPromptsResponse, error) + func (c *Client) ListSessions(ctx context.Context) ([]*SessionInfo, error) + func (c *Client) ListSessionsRaw(ctx context.Context) (*pb.ListSessionsResponse, error) + func (c *Client) ListSessionsWithOptions(ctx context.Context, opts ListSessionsOptions) ([]*SessionInfo, error) + func (c *Client) ListTmuxConnections(ctx context.Context) ([]*TmuxConnection, error) + func (c *Client) ListVariablesWithScope(ctx context.Context, scope string, id string) ([]string, error) + func (c *Client) ListWindows(ctx context.Context) ([]*WindowInfo, error) + func (c *Client) MonitorLifecycle(ctx context.Context, sessionID string, follow bool) (interface{}, error) + func (c *Client) MonitorSession(ctx context.Context, sessionID string, events []string) (<-chan *pb.PromptNotification, error) + func (c *Client) MonitorVariable(ctx context.Context, scope, identifier, name string) (<-chan string, error) + func (c *Client) MoveSession(ctx context.Context, sourceSessionID, destSessionID string, ...) error + func (c *Client) OpenFilePanel(ctx context.Context, title, directory string, types []string, multiple bool) (interface{}, error) + func (c *Client) PasteFromClipboardWithOptions(ctx context.Context, sessionID string, restoreFocus bool) error + func (c *Client) PostNotification(ctx context.Context, message string) (interface{}, error) + func (c *Client) ReadNotification(ctx context.Context) (*pb.ServerOriginatedMessage, error) + func (c *Client) RegisterCustomControl(ctx context.Context, controlID, controlType, configStr string) (interface{}, error) + func (c *Client) RegisterRPC(ctx context.Context, rpcName, sessionID string) (interface{}, error) + func (c *Client) ReorderTabs(ctx context.Context, assignments map[string][]string) (*pb.ReorderTabsResponse, error) + func (c *Client) ReplaceText(ctx context.Context, sessionID, pattern, replacement string, ...) ([]*ReplaceResult, error) + func (c *Client) ResetSessionBadgeToProfile(ctx context.Context, sessionID string) error + func (c *Client) ResolveSessionID(ctx context.Context, sessionID string) (string, error) + func (c *Client) ResolveTabID(ctx context.Context, tabID string) (string, error) + func (c *Client) ResolveWindowID(ctx context.Context, windowID string) (string, error) + func (c *Client) RestartSession(ctx context.Context, sessionID string, onlyIfExited bool) (*pb.RestartSessionResponse, error) + func (c *Client) RestoreArrangement(ctx context.Context, name string) (*pb.SavedArrangementResponse, error) + func (c *Client) SaveArrangement(ctx context.Context, name string, windowID string) (*pb.SavedArrangementResponse, error) + func (c *Client) SaveFilePanel(ctx context.Context, title, directory, filename string, types []string) (interface{}, error) + func (c *Client) SendRequest(ctx context.Context, msg *pb.ClientOriginatedMessage) (*pb.ServerOriginatedMessage, error) + func (c *Client) SendText(ctx context.Context, sessionID, text string) error + func (c *Client) SendTmuxCommand(ctx context.Context, connectionID, command string) (string, error) + func (c *Client) SetBroadcastDomains(ctx context.Context, domains []*BroadcastDomain) error + func (c *Client) SetCursor(ctx context.Context, sessionID string, x int32, y int64) error + func (c *Client) SetGridSize(ctx context.Context, sessionID string, width, height int32) error + func (c *Client) SetPreference(ctx context.Context, key string, value interface{}) error + func (c *Client) SetPreferences(ctx context.Context, prefs map[string]interface{}) error + func (c *Client) SetProfileProperties(ctx context.Context, profileName string, properties map[string]interface{}) error + func (c *Client) SetProfileProperty(ctx context.Context, profileName, key string, value interface{}) error + func (c *Client) SetSelection(ctx context.Context, sessionID, start, end string) error + func (c *Client) SetSelectionRange(ctx context.Context, sessionID string, startX int32, startY int64, endX int32, ...) error + func (c *Client) SetSessionBadge(ctx context.Context, sessionID, badge string) error + func (c *Client) SetSessionName(ctx context.Context, sessionID, name string) error + func (c *Client) SetSessionProfileProperty(ctx context.Context, sessionID, key, value string) error + func (c *Client) SetSessionProperty(ctx context.Context, sessionID, property, value string) error + func (c *Client) SetTabColor(ctx context.Context, tabID string, red, green, blue float64) error + func (c *Client) SetTabLayout(ctx context.Context, tabID string, root *pb.SplitTreeNode) (*pb.SetTabLayoutResponse, error) + func (c *Client) SetTabTitle(ctx context.Context, tabID, title string) error + func (c *Client) SetVariable(ctx context.Context, sessionID, name, value string) error + func (c *Client) SetVariableWithScope(ctx context.Context, scope string, id string, name string, value string) error + func (c *Client) SetWindowProperty(ctx context.Context, windowID, property, value string) error + func (c *Client) SetWindowTitle(ctx context.Context, windowID, title string) error + func (c *Client) ShowAlert(ctx context.Context, message, title string) (interface{}, error) + func (c *Client) SplitPane(ctx context.Context, sessionID string, vertical bool, before bool, ...) (*pb.SplitPaneResponse, error) + func (c *Client) SubscribeToGenericNotifications(ctx context.Context, notificationType string, sessionID string) (<-chan *pb.Notification, error) + func (c *Client) SubscribeToKeystrokes(ctx context.Context, sessionID string) error + func (c *Client) SubscribeToNotification(ctx context.Context, notificationType pb.NotificationType) error + func (c *Client) SubscribeToScreenUpdates(ctx context.Context, sessionID string) error + func (c *Client) TabContainsSession(node *pb.SplitTreeNode, sessionID string) bool + func (c *Client) UnbindKey(ctx context.Context, key, profile string, global bool) error + func (c *Client) UnregisterCustomControl(ctx context.Context, controlID string) (interface{}, error) + func (c *Client) UnregisterRPC(ctx context.Context, rpcName, sessionID string) (interface{}, error) + func (c *Client) UnsubscribeFromNotifications(ctx context.Context, notificationType, sessionID string) error + func (c *Client) UpdateCustomControl(ctx context.Context, controlID string, data interface{}) (interface{}, error) + type ColorPreset struct + Name string + Settings map[string]*ColorSetting + type ColorSetting struct + Alpha float32 + Blue float32 + ColorSpace string + Green float32 + Red float32 + type Dict struct + Keys []string + Values []Value + type FindResult struct + Column int32 + Context string + Line int64 + LineText string + Text string + type FocusInfo struct + ApplicationFocused bool + SessionId string + TabId string + WindowId string + type HighlightResult struct + Color string + Column int32 + Duration int32 + HighlightID string + Line int64 + Text string + type ITerm2ColorPreset struct + Dict Dict + XMLName xml.Name + type KeyBinding struct + Action string + Description string + Global bool + Key string + Profile string + type ListSessionsOptions struct + IncludeBuried bool + IncludeJobInfo bool + type ReplaceResult struct + Column int32 + Line int64 + NewText string + OriginalText string + Success bool + type SessionInfo struct + CommandCount int32 + CurrentCommand string + ExitCode uint32 + Frame *pb.Frame + GridSize *pb.Size + JobPID int32 + ParentSessionID string + PluginData map[string]interface{} + ProcessName string + PromptState string + SessionID string + SessionName string + ShellPID int32 + ShortID string + SplitVertical *bool + TabID string + TabTitle string + WindowID string + WindowNumber int32 + WindowTitle string + WorkingDirectory string + type TmuxConnection struct + ConnectionId string + OwningSessionId string + type Value struct + Keys []string + Reals []float64 + Strings []string + type VariableInfo struct + ID string + Name string + Scope string + Value string + type WindowInfo struct + Frame string + Fullscreen string + Miniaturized string + PluginData map[string]interface{} + SessionCount int + TabCount int + Title string + WindowID string + WindowNumber int32
Go to main page