client

package

v0.2.1 Latest Latest Go to latest Published: Apr 18, 2026 License: MIT Imports: 22 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/d0ugal/graith

Links

Open Source Insights

Documentation ¶

Index ¶

func EnsureDaemon(sockPath, configFile string) (net.Conn, error)
func FetchScreenSnapshot(cfg *config.Config, paths config.Paths, configFile string, sessionID string) *protocol.ScreenSnapshotResponseMsg
func FetchScrollbackPreview(cfg *config.Config, paths config.Paths, configFile string, sessionID string) string
func RunShellInWorktree(worktreePath string) error
func WriteScreenRestore(snap *protocol.ScreenSnapshotResponseMsg)
type Client
- func Connect(cfg *config.Config, paths config.Paths, configFile string) (*Client, error)
- func New(cfg *config.Config, paths config.Paths, configFile string) (*Client, error)
type OverlayResult
- func RunOverlay(sessions []protocol.SessionInfo, fetchPreview func(sessionID string) string) *OverlayResult
type PassthroughKeys
type PassthroughResult

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

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 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.

func WriteScreenRestore ¶ added in v0.2.0

func WriteScreenRestore(snap *protocol.ScreenSnapshotResponseMsg)

Types ¶

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. On failure the connection is closed automatically.

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, keys PassthroughKeys) PassthroughResult

func (*Client) SendControl ¶

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

func (*Client) SendData ¶

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

type OverlayResult ¶

type OverlayResult struct {
	Action    string
	SessionID string
}

OverlayResult holds the outcome of the overlay interaction.

func RunOverlay ¶

func RunOverlay(sessions []protocol.SessionInfo, fetchPreview func(sessionID string) string) *OverlayResult

RunOverlay launches the bubbletea overlay listing sessions grouped by repo. fetchPreview is called asynchronously to load scrollback for the selected session. It may be nil, in which case no preview is shown.

type PassthroughKeys ¶

type PassthroughKeys struct {
	Prefix      byte
	NextSession byte
	PrevSession byte
}

type PassthroughResult ¶

type PassthroughResult int

const (
	ResultDetached PassthroughResult = iota
	ResultOverlay
	ResultShell
	ResultQuit
	ResultDisconnected
	ResultRestart
	ResultNextSession
	ResultPrevSession
)

Source Files ¶

View all Source files

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