client

package
v0.31.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 20, 2026 License: MIT Imports: 26 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildHandshake added in v0.18.0 

func BuildHandshake(paths config.Paths, cols, rows uint16, cwd string) protocol.HandshakeMsg

BuildHandshake constructs a HandshakeMsg with the given paths and terminal dimensions. All code that needs to send a handshake should use this so the Profile field is always populated.

func EnsureDaemon 

func EnsureDaemon(sockPath, configFile string) (net.Conn, error)

func FetchScreenSnapshot added in v0.2.0 

func FetchScreenSnapshot(cfg *config.Config, paths config.Paths, configFile string, sessionID string) *protocol.ScreenSnapshotResponseMsg

func FetchScrollbackPreview 

func FetchScrollbackPreview(cfg *config.Config, paths config.Paths, configFile string, sessionID string) string

func RunNameInput added in v0.9.0 

func RunNameInput(title string) string

RunNameInput launches a bubbletea prompt asking for a session name. Returns the entered name, or "" if the user cancelled.

func RunShellInWorktree 

func RunShellInWorktree(worktreePath string) error

RunShellInWorktree spawns an interactive shell with its working directory set to the given worktree path, and GRAITH_WORKTREE exported in the env. A non-zero exit status from the shell is not treated as an error since interactive shells commonly inherit the status of their last command.

func ShortDuration added in v0.3.0 

func ShortDuration(d time.Duration) string

func SortSessions added in v0.5.1 

func SortSessions(sessions []protocol.SessionInfo)

func WriteScreenRestore added in v0.2.0 

func WriteScreenRestore(snap *protocol.ScreenSnapshotResponseMsg)

Types

type ApprovalResult added in v0.13.0 

type ApprovalResult struct {
	RequestID string
	Decision  string
	Reason    string
}

func RunApprovalOverlay added in v0.13.0 

func RunApprovalOverlay(approvals []protocol.ApprovalInfo) []ApprovalResult

RunApprovalOverlay launches the bubbletea approval overlay listing pending approvals. Returns the list of decisions made by the user. After each approve/deny the overlay stays open; it auto-closes when empty.

type Client 

type Client struct {
	// contains filtered or unexported fields
}

func Connect 

func Connect(cfg *config.Config, paths config.Paths, configFile string) (*Client, error)

Connect creates a new client, performs the handshake, and reads the handshake response. If the daemon is running a different version, it automatically triggers a restart and reconnects. On failure the connection is closed automatically.

func ConnectFast added in v0.11.0 

func ConnectFast(paths config.Paths) (*Client, error)

ConnectFast is a fast-path connect for hooks. It dials the daemon socket directly with a short timeout and does NOT auto-start the daemon.

func ConnectForApproval added in v0.13.0 

func ConnectForApproval(paths config.Paths, approvalTimeout time.Duration) (*Client, error)

ConnectForApproval is like ConnectFast but with a long deadline suitable for blocking on approval responses. The socket deadline is set to approvalTimeout plus a one-minute grace period (minimum one minute total) so the connection outlives the daemon's approval timer.

func New 

func New(cfg *config.Config, paths config.Paths, configFile string) (*Client, error)

func (*Client) Close 

func (c *Client) Close()

func (*Client) Handshake 

func (c *Client) Handshake() error

func (*Client) ReadControlResponse 

func (c *Client) ReadControlResponse() (protocol.Envelope, error)

func (*Client) ReadFrame 

func (c *Client) ReadFrame() (protocol.Frame, error)

func (*Client) RunPassthrough 

func (c *Client) RunPassthrough(ctx context.Context, opts PassthroughOpts) PassthroughResult

func (*Client) SendControl 

func (c *Client) SendControl(msgType string, payload any) error

func (*Client) SendData 

func (c *Client) SendData(data []byte) error

func (*Client) SendFrame added in v0.23.0 

func (c *Client) SendFrame(channel byte, data []byte) error

type DashboardModel added in v0.3.0 

type DashboardModel struct {
	// contains filtered or unexported fields
}

func NewDashboardModel added in v0.3.0 

func NewDashboardModel(sessions []protocol.SessionInfo, refresh func() []protocol.SessionInfo) DashboardModel

func (DashboardModel) Init added in v0.3.0 

func (m DashboardModel) Init() tea.Cmd

func (DashboardModel) Update added in v0.3.0 

func (m DashboardModel) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (DashboardModel) View added in v0.3.0 

func (m DashboardModel) View() tea.View

type DashboardResult added in v0.3.0 

type DashboardResult struct {
	Action    string
	SessionID string
}

func RunDashboard added in v0.3.0 

func RunDashboard(sessions []protocol.SessionInfo, refresh func() []protocol.SessionInfo) *DashboardResult

type OverlayResult 

type OverlayResult struct {
	Action    string
	SessionID string
}

OverlayResult holds the outcome of the overlay interaction.

func RunOverlay 

func RunOverlay(sessions []protocol.SessionInfo, currentSessionID string, fetchPreview func(sessionID string) string, deleteSession func(sessionID string) error, toggleStar func(sessionID string, star bool) error, profile string) *OverlayResult

RunOverlay launches the bubbletea overlay listing sessions grouped by repo. currentSessionID highlights the session the user was just attached to. fetchPreview is called asynchronously to load scrollback for the selected session.

type PassthroughKeys 

type PassthroughKeys struct {
	Prefix      byte
	NextSession byte
	PrevSession byte
	LastSession byte
	NewSession  byte
	ForkSession byte
}

type PassthroughOpts added in v0.3.0 

type PassthroughOpts struct {
	Keys            PassthroughKeys
	SessionID       string
	Info            *protocol.SessionInfo
	StatusBar       *StatusBarCfg
	AutoPopApproval bool
}

type PassthroughResult 

type PassthroughResult int
const (
	ResultDetached PassthroughResult = iota
	ResultOverlay
	ResultShell
	ResultQuit
	ResultDisconnected
	ResultRestart
	ResultNextSession
	ResultPrevSession
	ResultNewSession
	ResultForkSession
	ResultLastSession
	ResultApprovalOverlay
)

type StatusBarCfg added in v0.3.0 

type StatusBarCfg struct {
	Position string
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.