iterm2

package module

Go to main page

Versions in this module

v0

v0.9.0

Oct 5, 2026

Changes in this version

type Conn

+ func (c *Conn) RegisterContextMenuItem(ctx context.Context, m ContextMenuItem) (*RPCRegistration, error)

+ type ContextMenuItem struct

+ DisplayName string

+ Identifier string

type Persistent

+ func (p *Persistent) RegisterContextMenuItem(ctx context.Context, m ContextMenuItem) (*RPCRegistration, error)

v0.8.0

Oct 4, 2026

Changes in this version

type Conn

+ func (c *Conn) RegisterTitleProvider(ctx context.Context, t TitleProvider) (*RPCRegistration, error)

type Persistent

+ func (p *Persistent) RegisterTitleProvider(ctx context.Context, t TitleProvider) (*RPCRegistration, error)

+ type TitleProvider struct

+ DisplayName string

+ Identifier string

v0.7.0

Oct 4, 2026

Changes in this version

type Conn

+ func (c *Conn) RegisterRPC(ctx context.Context, fn RPC) (*RPCRegistration, error)

type Persistent

+ func (p *Persistent) RegisterRPC(ctx context.Context, fn RPC) (*RPCRegistration, error)

+ type RPC struct

+ Arguments []string

+ Defaults map[string]string

+ Handler func(ctx context.Context, args map[string]json.RawMessage) (any, error)

+ Name string

+ Timeout time.Duration

+ type RPCRegistration struct

+ func (r *RPCRegistration) Unregister(ctx context.Context) error

v0.6.0

Oct 4, 2026

Changes in this version

type Conn

+ func (c *Conn) RegisterTool(ctx context.Context, t Tool) error

type Persistent

+ func (p *Persistent) RegisterTool(ctx context.Context, t Tool) error

type Reconnect

+ ToolErr error

+ type Tool struct

+ Identifier string

+ Name string

+ Reveal bool

+ URL string

v0.5.0

Oct 4, 2026

Changes in this version

+ type SplitNode struct

+ Children []*SplitNode

+ Session *Session

+ Vertical bool

+ func (n *SplitNode) Panes() []*Session

type Tab

+ func (t *Tab) SplitTree() *SplitNode

v0.4.0

Oct 3, 2026

Changes in this version

+ type Client interface

+ Activate func(ctx context.Context, opts ActivateOptions) error

+ CloseSessions func(ctx context.Context, force bool, ids ...string) error

+ CloseTabs func(ctx context.Context, force bool, ids ...string) error

+ CloseWindows func(ctx context.Context, force bool, ids ...string) error

+ CreateTab func(ctx context.Context, opts CreateTabOptions) (*NewTab, error)

+ Do func(ctx context.Context, req *apipb.ClientOriginatedMessage) (*apipb.ServerOriginatedMessage, error)

+ GetStringVariable func(ctx context.Context, scope VariableScope, identifier, name string) (value string, ok bool, err error)

+ GetVariables func(ctx context.Context, scope VariableScope, identifier string, names ...string) (map[string]json.RawMessage, error)

+ ListSessions func(ctx context.Context) (*Hierarchy, error)

+ SendText func(ctx context.Context, sessionID, text string, suppressBroadcast bool) error

+ SetStringVariable func(ctx context.Context, scope VariableScope, identifier, name, value string) error

+ SetVariables func(ctx context.Context, scope VariableScope, identifier string, ...) error

+ SplitPane func(ctx context.Context, sessionID string, opts SplitPaneOptions) ([]string, error)

type Persistent

+ func (p *Persistent) Activate(ctx context.Context, opts ActivateOptions) error

+ func (p *Persistent) CloseSessions(ctx context.Context, force bool, ids ...string) error

+ func (p *Persistent) CloseTabs(ctx context.Context, force bool, ids ...string) error

+ func (p *Persistent) CloseWindows(ctx context.Context, force bool, ids ...string) error

+ func (p *Persistent) CreateTab(ctx context.Context, opts CreateTabOptions) (*NewTab, error)

+ func (p *Persistent) GetStringVariable(ctx context.Context, scope VariableScope, identifier, name string) (value string, ok bool, err error)

+ func (p *Persistent) GetVariables(ctx context.Context, scope VariableScope, identifier string, names ...string) (map[string]json.RawMessage, error)

+ func (p *Persistent) ListSessions(ctx context.Context) (*Hierarchy, error)

+ func (p *Persistent) SendText(ctx context.Context, sessionID, text string, suppressBroadcast bool) error

+ func (p *Persistent) SetStringVariable(ctx context.Context, scope VariableScope, identifier, name, value string) error

+ func (p *Persistent) SetVariables(ctx context.Context, scope VariableScope, identifier string, ...) error

+ func (p *Persistent) SplitPane(ctx context.Context, sessionID string, opts SplitPaneOptions) ([]string, error)

+ func (p *Persistent) SubscribeFocusChanges(ctx context.Context) (*DurableSubscription, error)

+ func (p *Persistent) SubscribeLayoutChanges(ctx context.Context) (*DurableSubscription, error)

+ func (p *Persistent) SubscribeVariableChanges(ctx context.Context, scope VariableScope, identifier, name string) (*DurableSubscription, error)

v0.3.0

Oct 3, 2026

Changes in this version

+ var ErrReconnecting = fmt.Errorf("iterm2: reconnecting to iTerm2: %w", ErrClosed)

+ type DurableSubscription struct

+ func (d *DurableSubscription) C() <-chan *apipb.Notification

+ func (d *DurableSubscription) Dropped() uint64

+ func (d *DurableSubscription) Err() error

+ func (d *DurableSubscription) Unsubscribe(ctx context.Context) error

type Option

+ func WithReconnectBackoff(min, max time.Duration) Option

+ type Persistent struct

+ func ConnectPersistent(ctx context.Context, opts ...Option) (*Persistent, error)

+ func (p *Persistent) Close() error

+ func (p *Persistent) Conn() (*Conn, error)

+ func (p *Persistent) Do(ctx context.Context, req *apipb.ClientOriginatedMessage) (*apipb.ServerOriginatedMessage, error)

+ func (p *Persistent) Reconnects() <-chan Reconnect

+ func (p *Persistent) Subscribe(ctx context.Context, req *apipb.NotificationRequest) (*DurableSubscription, error)

+ func (p *Persistent) SubscribeNewSessions(ctx context.Context) (*DurableSubscription, error)

+ func (p *Persistent) SubscribeTerminatedSessions(ctx context.Context) (*DurableSubscription, error)

+ type Reconnect struct

+ At time.Time

+ Cause error

+ Count int

v0.2.0

Sep 28, 2026

Changes in this version

type Conn

+ func (c *Conn) Done() <-chan struct{}

+ func (c *Conn) Err() error

v0.1.0

Sep 26, 2026

Changes in this version

+ const AllVariables

+ const LegacyTCPAddress

+ const LibraryVersion

+ const SessionActive

+ const SessionAll

+ const Subprotocol

+ var ErrClosed = errors.New("iterm2: connection closed")

+ var ErrNoCredentials = errors.New("iterm2: ITERM2_COOKIE and ITERM2_KEY are not set")

+ var ErrNotSupported = errors.New("iterm2: not supported by this iTerm2")

+ var ErrUnauthorized = errors.New("iterm2: unauthorized")

+ func DefaultSocketPath() string

+ type APIError struct

+ Message string

+ func (e *APIError) Error() string

+ type ActivateOptions struct

+ ActivateApp bool

+ IgnoringOtherApps bool

+ OrderWindowFront bool

+ RaiseAllWindows bool

+ SelectSession bool

+ SelectTab bool

+ type Conn struct

+ func Connect(ctx context.Context, opts ...Option) (*Conn, error)

+ func (c *Conn) Activate(ctx context.Context, opts ActivateOptions) error

+ func (c *Conn) Close() error

+ func (c *Conn) CloseSessions(ctx context.Context, force bool, ids ...string) error

+ func (c *Conn) CloseTabs(ctx context.Context, force bool, ids ...string) error

+ func (c *Conn) CloseWindows(ctx context.Context, force bool, ids ...string) error

+ func (c *Conn) CreateTab(ctx context.Context, opts CreateTabOptions) (*NewTab, error)

+ func (c *Conn) Do(ctx context.Context, req *apipb.ClientOriginatedMessage) (*apipb.ServerOriginatedMessage, error)

+ func (c *Conn) GetStringVariable(ctx context.Context, scope VariableScope, identifier, name string) (value string, ok bool, err error)

+ func (c *Conn) GetVariables(ctx context.Context, scope VariableScope, identifier string, names ...string) (map[string]json.RawMessage, error)

+ func (c *Conn) ListSessions(ctx context.Context) (*Hierarchy, error)

+ func (c *Conn) SendText(ctx context.Context, sessionID, text string, suppressBroadcast bool) error

+ func (c *Conn) SetStringVariable(ctx context.Context, scope VariableScope, identifier, name, value string) error

+ func (c *Conn) SetVariables(ctx context.Context, scope VariableScope, identifier string, ...) error

+ func (c *Conn) SplitPane(ctx context.Context, sessionID string, opts SplitPaneOptions) ([]string, error)

+ func (c *Conn) Subscribe(ctx context.Context, req *apipb.NotificationRequest) (*Subscription, error)

+ func (c *Conn) SubscribeFocusChanges(ctx context.Context) (*Subscription, error)

+ func (c *Conn) SubscribeLayoutChanges(ctx context.Context) (*Subscription, error)

+ func (c *Conn) SubscribeNewSessions(ctx context.Context) (*Subscription, error)

+ func (c *Conn) SubscribeTerminatedSessions(ctx context.Context) (*Subscription, error)

+ func (c *Conn) SubscribeVariableChanges(ctx context.Context, scope VariableScope, identifier, name string) (*Subscription, error)

+ type CreateTabOptions struct

+ CustomProfileProperties map[string]string

+ ProfileName string

+ SelectTab *bool

+ TabIndex *uint32

+ WindowID string

+ type CredentialSource interface

+ Credentials func(ctx context.Context) (Credentials, error)

+ func AppleScriptCredentials(advisoryName string) CredentialSource

+ func DefaultCredentials(advisoryName string) CredentialSource

+ func EnvCredentials() CredentialSource

+ func StaticCredentials(cookie, key string) CredentialSource

+ type CredentialSourceFunc func(ctx context.Context) (Credentials, error)

+ func (f CredentialSourceFunc) Credentials(ctx context.Context) (Credentials, error)

+ type Credentials struct

+ Cookie string

+ Key string

+ type Hierarchy struct

+ BuriedSessions []*Session

+ Windows []*Window

+ func (h *Hierarchy) Session(id string) *Session

+ func (h *Hierarchy) Sessions() []*Session

+ func (h *Hierarchy) Tab(id string) *Tab

+ func (h *Hierarchy) Tabs() []*Tab

+ func (h *Hierarchy) Window(id string) *Window

+ type NewTab struct

+ SessionID string

+ TabID string

+ WindowID string

+ type Option func(*config)

+ func ForceTCP() Option

+ func WithAdvisoryName(name string) Option

+ func WithCredentialSource(src CredentialSource) Option

+ func WithCredentials(cookie, key string) Option

+ func WithSocketPath(path string) Option

+ func WithSubscriptionBuffer(n int) Option

+ func WithTCPAddress(addr string) Option

+ type Rect struct

+ Height int32

+ Width int32

+ X int32

+ Y int32

+ type Session struct

+ Buried bool

+ Frame Rect

+ GridSize Size

+ ID string

+ Title string

+ func (s *Session) Activate(ctx context.Context, opts ActivateOptions) error

+ func (s *Session) Close(ctx context.Context, force bool) error

+ func (s *Session) SendText(ctx context.Context, text string) error

+ func (s *Session) SetVariable(ctx context.Context, name, value string) error

+ func (s *Session) SplitPane(ctx context.Context, opts SplitPaneOptions) ([]string, error)

+ func (s *Session) Variable(ctx context.Context, name string) (string, bool, error)

+ type Size struct

+ Height int32

+ Width int32

+ type SplitDirection int32

+ const SplitHorizontal

+ const SplitVertical

+ type SplitPaneOptions struct

+ Before bool

+ CustomProfileProperties map[string]string

+ Direction SplitDirection

+ ProfileName string

+ type StatusError struct

+ Code int32

+ Op string

+ Status string

+ func (e *StatusError) Error() string

+ type Subscription struct

+ func (s *Subscription) C() <-chan *apipb.Notification

+ func (s *Subscription) Dropped() uint64

+ func (s *Subscription) Unsubscribe(ctx context.Context) error

+ type Tab struct

+ ActiveSessionID string

+ Group *TabGroup

+ ID string

+ MinimizedSessions []*Session

+ Sessions []*Session

+ TmuxConnectionID string

+ TmuxWindowID string

+ WindowID string

+ func (t *Tab) Activate(ctx context.Context, opts ActivateOptions) error

+ func (t *Tab) ActiveSession() *Session

+ func (t *Tab) Close(ctx context.Context, force bool) error

+ type TabGroup struct

+ Collapsed bool

+ Color string

+ ID string

+ Name string

+ type VariableScope int32

+ const ScopeApp

+ const ScopeSession

+ const ScopeTab

+ const ScopeWindow

+ func (s VariableScope) String() string

+ type Window struct

+ Frame Rect

+ ID string

+ Number int32

+ SelectedTabID string

+ Tabs []*Tab

+ func (w *Window) Activate(ctx context.Context, opts ActivateOptions) error

+ func (w *Window) Close(ctx context.Context, force bool) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL