ghostline

Sep 14, 2026

Changes in this version

type SessionMetadata

+ CommandLine string

Aug 30, 2026

Changes in this version

+ type AdoptReport struct

+ Adopted int

+ Skipped map[string]string

type Server

+ func (s *Server) AdoptWithReport(ctx context.Context, adminSocket string) (AdoptReport, error)

Aug 27, 2026

Changes in this version

+ const AtomicStateFormat

+ const CapabilityAtomicState

+ type AtomicState struct

+ Cursor Cursor

+ Format string

+ Payload []byte

type Session

+ func (s *Session) AtomicState(ctx context.Context) (AtomicState, error)

Aug 25, 2026

Changes in this version

+ const CapabilityRawPayload

+ const CapabilityStreams

+ const DefaultServerMaxClientConnections

+ const V0HandoffProtocolVersion

+ var ErrCursorExpired = errors.New("ghostline: output cursor expired")

+ var ErrFrameTooLarge = errors.New("ghostline: RPC frame too large")

+ var ErrInvalidCursor = errors.New("ghostline: invalid output cursor")

+ var ErrInvalidSignal = errors.New("ghostline: invalid process signal")

+ var ErrProtocolMismatch = errors.New("ghostline: RPC protocol mismatch")

type Checkpoint

+ Cursor Cursor

type Client

+ func ConnectManaged(ctx context.Context, options ManagedClientOptions) (*Client, error)

+ func (c *Client) Get(ctx context.Context, name string) (*Session, error)

+ type Cursor struct

+ func ParseCursor(value string) (Cursor, error)

+ func (c *Cursor) UnmarshalText(text []byte) error

+ func (c Cursor) MarshalText() ([]byte, error)

+ func (c Cursor) String() string

type Hub

+ func (h *Hub) Get(ctx context.Context, name string) (*Session, error)

+ type ManagedClientOptions struct

+ Env []string

+ Log io.Writer

+ ReadyTimeout time.Duration

+ Socket string

+ Spawn []string

type Options

+ ServerMaxClientConnections int

+ type OutputReader struct

+ func (r *OutputReader) Close() error

+ func (r *OutputReader) Cursor() Cursor

+ func (r *OutputReader) Read(p []byte) (int, error)

+ type ProcessSpec struct

+ Args []string

+ Directory string

+ Environment []string

+ Path string

+ ShellCommand string

+ func Shell(command string) ProcessSpec

+ type ProtocolLimits struct

+ MaxChunkBytes int

+ MaxHeaderBytes int

+ MaxPayloadBytes int

type Session

+ func (s *Session) Delete(ctx context.Context) error

+ func (s *Session) Info() SessionInfo

+ func (s *Session) Metadata(ctx context.Context) (SessionMetadata, error)

+ func (s *Session) Output(ctx context.Context, from Cursor) (*OutputReader, error)

+ func (s *Session) OutputCursor(ctx context.Context) (Cursor, error)

+ func (s *Session) PruneOutput(ctx context.Context, before Cursor) error

+ func (s *Session) Replay(ctx context.Context) ([]byte, error)

+ func (s *Session) RotateOutput(ctx context.Context) (Cursor, error)

+ func (s *Session) Signal(ctx context.Context, signal os.Signal) error

+ func (s *Session) Size(ctx context.Context) (Size, error)

+ func (s *Session) Terminate(ctx context.Context) error

+ func (s *Session) WriteInput(ctx context.Context, data []byte) error

+ type SessionInfo struct

+ CreatedAt time.Time

+ Name string

type SessionOptions

+ Process ProcessSpec

type VersionInfo

+ Capabilities []string

+ Limits ProtocolLimits

+ MaxClientConnections int

Aug 25, 2026

Changes in this version

+ const V1HandoffProtocolVersion

Aug 22, 2026

Changes in this version

+ func TagVersion() string

type Client

+ func (c *Client) VersionInfo(ctx context.Context) (VersionInfo, error)

+ type VersionInfo struct

+ ProtocolVersion string

+ TagVersion string

Aug 17, 2026

Changes in this version

+ type ColorQueryCallback func(ColorQueryKind) (color string, ok bool)

+ type ColorQueryKind uint8

+ const ColorQueryBackground

+ const ColorQueryForeground

type QueryResponder

+ func NewQueryResponderWithColorQuery(callback ColorQueryCallback) *QueryResponder

Aug 17, 2026

Changes in this version

+ const DefaultVTScrollbackMaxBytes

type Options

+ VTScrollbackMaxBytes uint64

type SessionOptions

+ VTScrollbackMaxBytes uint64

type VTTerminal

+ func NewVTTerminalWithOptions(cols, rows int, options VTTerminalOptions) (*VTTerminal, error)

+ type VTTerminalOptions struct

+ ScrollbackMaxBytes uint64

Aug 16, 2026

Changes in this version

+ type MetadataProvider interface

+ Metadata func(ctx context.Context) (SessionMetadata, error)

type Options

+ ProbeForeground bool

+ type SessionMetadata struct

+ Directory string

+ Process string

Aug 16, 2026

Changes in this version

type ExitError

+ Unknown bool

Aug 16, 2026

Changes in this version

+ func Adopt(ctx context.Context, adminSocket string, h *Hub) (int, error)

type Client

+ func (c *Client) PID() int

type Options

+ DefaultTerm string

type Server

+ func (s *Server) Adopt(ctx context.Context, adminSocket string) (int, error)

type VTTerminal

+ func (v *VTTerminal) EncodeState() ([]byte, error)

+ func (v *VTTerminal) RestoreState(snapshot []byte) error

Aug 16, 2026

Changes in this version

+ const ProtocolVersion

type Client

+ func (c *Client) Version(ctx context.Context) (string, error)

Aug 16, 2026

Changes in this version

type Client

+ func (c *Client) Session(name string) (Session, bool)

+ func (c *Client) Sessions() []Session

Aug 16, 2026

Changes in this version

type Client

+ func Connect(ctx context.Context, options ConnectOptions) (*Client, error)

+ func (c *Client) Close() error

+ func (c *Client) Ensure(ctx context.Context) error

+ type ConnectOptions struct

+ Env []string

+ Log io.Writer

+ ReadyTimeout time.Duration

+ Socket string

+ Spawn []string

+ type ExitError struct

+ Code int

+ Signal string

+ func (e *ExitError) Error() string

type Server

+ func (s *Server) Shutdown(ctx context.Context) error

type Session

+ Alive func() bool

+ ArchiveSpool func(ctx context.Context) error

+ CreatedAt func() time.Time

+ Done func() <-chan struct{}

+ Input func(ctx context.Context, data []byte) error

+ Recover func(ctx context.Context, offset, end int64) ([]byte, error)

+ Remove func() error

+ RemoveSpool func()

+ Resize func(ctx context.Context, size Size) error

+ Snapshot func(ctx context.Context) ([]byte, error)

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

+ TruncateSpool func(ctx context.Context) error

+ Wait func(ctx context.Context) error

+ type Status struct

+ Alive bool

+ Exit *ExitError

Aug 16, 2026

Changes in this version

+ var ErrClosed = errors.New("ghostline hub is closed")

+ var ErrInvalidSessionName = errors.New("invalid ghostline session name")

+ var ErrSessionClosed = errors.New("ghostline session is closed")

+ var ErrSessionExists = errors.New("ghostline session already exists")

+ var ErrSessionNotFound = errors.New("ghostline session not found")

+ var ErrUnavailable = errors.New("ghostline is unavailable")

+ func Ping(socketPath string) bool

+ type Checkpoint struct

+ Offset int64

+ Replay []byte

+ type Client struct

+ Socket string

+ func NewClient(socketPath string) *Client

+ func (c *Client) ArchiveSpool(ctx context.Context, name string) error

+ func (c *Client) Capture(ctx context.Context, name string) ([]byte, error)

+ func (c *Client) Check(ctx context.Context) error

+ func (c *Client) Checkpoint(ctx context.Context, name string) (Checkpoint, error)

+ func (c *Client) Create(ctx context.Context, name, directory, command string) error

+ func (c *Client) EnsurePipe(ctx context.Context, name string) error

+ func (c *Client) Exists(ctx context.Context, name string) bool

+ func (c *Client) Input(ctx context.Context, name string, data []byte) error

+ func (c *Client) Kill(ctx context.Context, name string) error

+ func (c *Client) List(ctx context.Context) (map[string]bool, error)

+ func (c *Client) ListCreated(ctx context.Context) (map[string]time.Time, error)

+ func (c *Client) Recover(ctx context.Context, name string, offset, end int64) ([]byte, error)

+ func (c *Client) RemoveSpool(name string)

+ func (c *Client) Resize(ctx context.Context, name string, columns, rows int) error

+ func (c *Client) SpoolPath(name string) string

+ func (c *Client) SpoolSize(ctx context.Context, name string) (int64, error)

+ func (c *Client) Start(ctx context.Context, options SessionOptions) (*Session, error)

+ func (c *Client) TruncateSpool(ctx context.Context, name string) error

+ func (c *Client) WaitReady(ctx context.Context, timeout time.Duration) error

+ type Hub struct

+ OutputDir string

+ func New(options Options) (*Hub, error)

+ func (p *Hub) ArchiveSpool(_ context.Context, runtimeName string) error

+ func (p *Hub) Capture(_ context.Context, runtimeName string) ([]byte, error)

+ func (p *Hub) Check(ctx context.Context) error

+ func (p *Hub) Close() error

+ func (p *Hub) Create(ctx context.Context, runtimeName, directory, command string) error

+ func (p *Hub) CreatedPath(runtimeName string) string

+ func (p *Hub) EnsurePipe(_ context.Context, runtimeName string) error

+ func (p *Hub) Exists(_ context.Context, runtimeName string) bool

+ func (p *Hub) Input(_ context.Context, runtimeName string, data []byte) error

+ func (p *Hub) Kill(_ context.Context, runtimeName string) error

+ func (p *Hub) List(context.Context) (map[string]bool, error)

+ func (p *Hub) ListCreated(context.Context) (map[string]time.Time, error)

+ func (p *Hub) PIDPath(runtimeName string) string

+ func (p *Hub) Recover(_ context.Context, runtimeName string, offset, end int64) ([]byte, error)

+ func (p *Hub) RemoveSpool(runtimeName string)

+ func (p *Hub) Resize(_ context.Context, runtimeName string, columns, rows int) error

+ func (p *Hub) Session(name string) (*Session, bool)

+ func (p *Hub) Sessions() []*Session

+ func (p *Hub) SpoolPath(runtimeName string) string

+ func (p *Hub) SpoolSize(_ context.Context, runtimeName string) (int64, error)

+ func (p *Hub) Start(ctx context.Context, options SessionOptions) (*Session, error)

+ func (p *Hub) TruncateSpool(_ context.Context, runtimeName string) error

+ type Options struct

+ DefaultSize Size

+ OutputDir string

+ type Server struct

+ func NewServer(options Options) (*Server, error)

+ func (s *Server) Close() error

+ func (s *Server) Serve(socketPath string) error

+ type Session struct

+ func (s *Session) Checkpoint(ctx context.Context) (Checkpoint, error)

+ func (s *Session) Close() error

+ func (s *Session) Name() string

+ func (s *Session) SpoolPath() string

+ func (s *Session) SpoolSize(ctx context.Context) (int64, error)

+ func (s *Session) WatchOutput(options WatchOptions) (*SpoolWatcher, error)

+ type SessionOptions struct

+ Command string

+ Directory string

+ Environment []string

+ Name string

+ Size Size

+ type Size struct

+ Columns int

+ Rows int

+ type WatchOptions struct

+ MaxBytes int64

+ Offset int64

+ OnOutput func([]byte)

+ OnOverflow func()

+ OnTruncate func()

Aug 15, 2026

Changes in this version

+ type PTY struct

+ OutputDir string

+ func NewPTY(outputDir string) *PTY

+ func (p *PTY) ArchiveSpool(_ context.Context, runtimeName string) error

+ func (p *PTY) Capture(_ context.Context, runtimeName string) ([]byte, error)

+ func (p *PTY) Check(context.Context) error

+ func (p *PTY) Create(_ context.Context, runtimeName, directory, command string) error

+ func (p *PTY) CreatedPath(runtimeName string) string

+ func (p *PTY) EnsurePipe(_ context.Context, runtimeName string) error

+ func (p *PTY) Exists(_ context.Context, runtimeName string) bool

+ func (p *PTY) Input(_ context.Context, runtimeName string, data []byte) error

+ func (p *PTY) Kill(_ context.Context, runtimeName string) error

+ func (p *PTY) List(context.Context) (map[string]bool, error)

+ func (p *PTY) ListCreated(context.Context) (map[string]time.Time, error)

+ func (p *PTY) PIDPath(runtimeName string) string

+ func (p *PTY) Recover(_ context.Context, runtimeName string, offset, end int64) ([]byte, error)

+ func (p *PTY) RemoveSpool(runtimeName string)

+ func (p *PTY) Resize(_ context.Context, runtimeName string, columns, rows int) error

+ func (p *PTY) SpoolPath(runtimeName string) string

+ func (p *PTY) SpoolSize(_ context.Context, runtimeName string) (int64, error)

+ func (p *PTY) TruncateSpool(_ context.Context, runtimeName string) error

+ type QueryResponder struct

+ func NewQueryResponder() *QueryResponder

+ func (r *QueryResponder) Feed(data []byte) [][]byte

+ func (r *QueryResponder) Resize(columns, rows int)

+ type SpoolRecoverer interface

+ Recover func(context.Context, string, int64, int64) ([]byte, error)

+ type SpoolWatcher struct

+ func NewSpoolWatcher(path string, offset int64, onBytes func([]byte), onRotate func(), ...) (*SpoolWatcher, error)

+ func (w *SpoolWatcher) Close()

+ func (w *SpoolWatcher) Offset() int64

+ func (w *SpoolWatcher) Pause()

+ func (w *SpoolWatcher) Ping()

+ func (w *SpoolWatcher) Resume()

+ func (w *SpoolWatcher) SetMaxBytes(maxBytes int64)

+ func (w *SpoolWatcher) SkipTo(offset int64) error

+ func (w *SpoolWatcher) Start()

+ type VTTerminal struct

+ func NewVTTerminal(cols, rows int) (*VTTerminal, error)

+ func (v *VTTerminal) Close()

+ func (v *VTTerminal) Feed(data []byte)

+ func (v *VTTerminal) Resize(cols, rows int)

+ func (v *VTTerminal) Snapshot() ([]byte, error)