terminal

package module

Go to main page

Versions in this module

v0

v0.7.12

Jul 24, 2026

Changes in this version

+ const ClipboardMaxUploadSize

+ func LoadUploadLimit(dataDir string) error

+ func SetUploadLimitMB(mb int) (int, error)

+ func UploadLimitBytes() int64

type Config

+ Tunnel bool

type Option

+ func WithTunnel(enabled bool) Option

v0.7.8

Jul 11, 2026

v0.7.7

Jul 10, 2026

v0.7.6

Jul 10, 2026

Changes in this version

+ type TmuxWindowSelector interface

+ SelectWindow func(ctx context.Context, shellPID, index int) error

v0.7.5

Jul 6, 2026

v0.7.4

Jul 5, 2026

v0.7.3

Jul 5, 2026

v0.7.2

Jul 5, 2026

v0.7.1

Jul 5, 2026

v0.7.0

Jul 5, 2026

Changes in this version

+ type TmuxOverviewToggler interface

+ SetOverviewActive func(v bool)

v0.6.0

Jul 4, 2026

Changes in this version

type Server

+ func (s *Server) SetAuthCode(code string)

+ type TmuxRefresher interface

+ RefreshClient func(ctx context.Context, shellPID int) error

v0.5.1

Jun 24, 2026

v0.5.0

Jun 22, 2026

Changes in this version

type Config

+ Version string

v0.4.0

Jun 21, 2026

v0.3.2

Jun 21, 2026

v0.3.1

Jun 21, 2026

v0.3.0

Jun 21, 2026

v0.2.0

Jun 21, 2026

Changes in this version

+ const MsgTypeTmuxState

type Config

+ VapidSubscriber string

type Option

+ func WithTmuxProvider(p TmuxStateProvider) Option

type Server

+ func (s *Server) Service() TerminalSessionService

+ type TmuxCopyMotioner interface

+ CopyMotion func(ctx context.Context, session, motion string) error

+ type TmuxSessionMaker interface

+ NewSession func(ctx context.Context, shellPID int) (string, error)

+ type TmuxStateProvider interface

+ TmuxState func(ctx context.Context, shellPID int) (json.RawMessage, error)

v0.1.0

May 17, 2026

Changes in this version

+ const AdapterStateFailed

+ const AdapterStateRunning

+ const AdapterStateSpawning

+ const AdapterStateStopped

+ const AdapterStateStopping

+ const ClosedReasonCrashed

+ const ClosedReasonNormal

+ const ClosedReasonStopCalled

+ const DefaultBufferCapacity

+ const MsgClosed

+ const MsgInput

+ const MsgOutput

+ const MsgPing

+ const MsgPong

+ const MsgResize

+ const MsgTypeAgentState

+ const MsgTypeAuthRefresh

+ const MsgTypeError

+ const MsgTypeHeartbeat

+ const MsgTypeHeartbeatAck

+ const MsgTypeInput

+ const MsgTypePing

+ const MsgTypePong

+ const MsgTypePreempted

+ const MsgTypeResize

+ const MsgTypeSessionMeta

+ const MsgTypeShellExit

+ const MsgTypeTmuxNav

+ func DefaultPTYFactory(opts PTYStartOptions) (*os.File, *exec.Cmd, error)

+ func DialTestWS(t *testing.T, server *httptest.Server, sessionID string, token string) *websocket.Conn

+ func NewTestCLIServer(t *testing.T) (*httptest.Server, *SessionManager, *SafeWriteEnds)

+ func NewTestCLIServerWithAuth(t *testing.T, authCode string) (*httptest.Server, *SessionManager, *SafeWriteEnds)

+ func WaitForBinaryContaining(t *testing.T, ws *websocket.Conn, substr string, timeout time.Duration) []byte

+ func WaitForPTYReady(t *testing.T, sm *SessionManager, sessionID string, timeout time.Duration)

+ type AgentDetectFunc func(ctx context.Context, shellPID int, cwd string) (tool, status string)

+ type AgentStatePushFunc func(ctx context.Context, sessionID string) (<-chan json.RawMessage, func(), error)

+ type Config struct

+ Addr string

+ AuthCode string

+ BufferSize int

+ DataDir string

+ DefaultShell string

+ MaxSessions int

+ func DefaultConfig() Config

+ type CreateOptions struct

+ CWD string

+ Engine string

+ Name string

+ Shell string

+ Title string

+ type ErrorPayload struct

+ Code string

+ Message string

+ type Hooks struct

+ AgentDetect AgentDetectFunc

+ AgentStatePush AgentStatePushFunc

+ OnCommand func(ctx context.Context, id string, cmd string) (handled bool, err error)

+ OnOutput func(ctx context.Context, id string, data []byte) error

+ OnSessionEnd func(ctx context.Context, id string, exitCode int) error

+ OnSessionStart func(ctx context.Context, id string, meta SessionMeta) error

+ Store SessionStore

+ type HudLogRequest struct

+ Events json.RawMessage

+ Screen json.RawMessage

+ SessionID string

+ Snapshot json.RawMessage

+ Timestamp string

+ UserAgent string

+ type InProcessService struct

+ func NewInProcessService(manager *SessionManager) *InProcessService

+ func (s *InProcessService) Close() error

+ func (s *InProcessService) Create(_ context.Context, opts CreateOptions) (*SessionInfo, error)

+ func (s *InProcessService) Delete(_ context.Context, id string) error

+ func (s *InProcessService) Get(_ context.Context, id string) (*SessionInfo, error)

+ func (s *InProcessService) Input(_ context.Context, id string, data []byte) error

+ func (s *InProcessService) List(_ context.Context) ([]SessionInfo, error)

+ func (s *InProcessService) PasteUpload(_ context.Context, id string, filename string, content io.Reader, ...) (string, error)

+ func (s *InProcessService) Resize(_ context.Context, id string, cols, rows int) error

+ func (s *InProcessService) TailOutput(_ context.Context, id string, lines int) ([]string, error)

+ type InputPayload struct

+ Data []byte

+ type Option func(*Server)

+ func WithAddr(addr string) Option

+ func WithAuthCode(code string) Option

+ func WithConfig(c Config) Option

+ func WithHooks(h Hooks) Option

+ type PTYFactory func(opts PTYStartOptions) (master *os.File, cmd *exec.Cmd, err error)

+ type PTYStartOptions struct

+ CWD string

+ Shell string

+ type PreemptedPayload struct

+ Message string

+ type ResizePayload struct

+ Cols int

+ Rows int

+ type RingBuffer struct

+ func NewRingBuffer(capacity int) *RingBuffer

+ func (rb *RingBuffer) IsFull() bool

+ func (rb *RingBuffer) Len() int

+ func (rb *RingBuffer) Read() []byte

+ func (rb *RingBuffer) ReadTail(n int) []byte

+ func (rb *RingBuffer) Reset()

+ func (rb *RingBuffer) Write(p []byte) (int, error)

+ type SafeWriteEnds struct

+ func (s *SafeWriteEnds) CloseAt(index int)

+ func (s *SafeWriteEnds) Get(index int) *os.File

+ type Server struct

+ func NewServer(opts ...Option) (*Server, error)

+ func (s *Server) Close() error

+ func (s *Server) Handler() http.Handler

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

+ func (s *Server) Port() int

+ type Session struct

+ Buffer *RingBuffer

+ CWD string

+ Cmd *exec.Cmd

+ CreatedAt time.Time

+ Engine string

+ ID string

+ LastActive time.Time

+ Name string

+ PTY *os.File

+ ShellPath string

+ Status SessionStatus

+ Title string

+ TmuxDetected bool

+ func (s *Session) Done() <-chan struct{}

+ func (s *Session) GetExitCode() int

+ func (s *Session) GetLastActive() time.Time

+ func (s *Session) GetStatus() SessionStatus

+ func (s *Session) GetTmuxDetected() bool

+ func (s *Session) ShellPID() int

+ func (s *Session) TailOutput(n int) []string

+ func (s *Session) WorkingDir() string

+ type SessionInfo struct

+ CWD string

+ CreatedAt string

+ Engine string

+ ExitCode int

+ ID string

+ LastActive string

+ Name string

+ ShellPID int

+ Status SessionStatus

+ Title string

+ TmuxDetected bool

+ type SessionManager struct

+ func NewSessionManager(bufferSize int, defaultShell string) *SessionManager

+ func NewSessionManagerWithFactory(bufferSize int, defaultShell string, factory PTYFactory) *SessionManager

+ func (m *SessionManager) ClearActiveConn(sessionID string, conn *websocket.Conn)

+ func (m *SessionManager) CloseAll() error

+ func (m *SessionManager) Create(name string) (*Session, error)

+ func (m *SessionManager) CreateWithOptions(opts CreateOptions) (*Session, error)

+ func (m *SessionManager) Destroy(id string) error

+ func (m *SessionManager) DestroyAll()

+ func (m *SessionManager) Get(id string) (*Session, error)

+ func (m *SessionManager) List() []*Session

+ func (m *SessionManager) SetActiveConn(sessionID string, conn *websocket.Conn, cancel context.CancelFunc)

+ func (m *SessionManager) Subscribe(sess *Session, subID string) (<-chan []byte, func())

+ type SessionMeta struct

+ CWD string

+ Shell string

+ type SessionMetaPayload struct

+ TmuxDetected bool

+ type SessionSnapshot struct

+ CWD string

+ ID string

+ Name string

+ Shell string

+ Status string

+ type SessionStatus string

+ const StatusExited

+ const StatusRunning

+ type SessionStore interface

+ ListSessions func(ctx context.Context) ([]SessionSummary, error)

+ SaveSession func(ctx context.Context, s *SessionSnapshot) error

+ type SessionSummary struct

+ ID string

+ Name string

+ Status string

+ type SessionV2 struct

+ Cmd *exec.Cmd

+ Pty *os.File

+ Ring *RingBuffer

+ RootDir string

+ SessionID int64

+ State string

+ WSConn *websocket.Conn

+ WorkspaceID int64

+ func (cs *SessionV2) GetState() string

+ func (cs *SessionV2) Lock()

+ func (cs *SessionV2) SetState(s string)

+ func (cs *SessionV2) SetWSConn(conn *websocket.Conn) bool

+ func (cs *SessionV2) Unlock()

+ func (cs *SessionV2) WriteWS(data []byte)

+ type ShellExitPayload struct

+ ExitCode int

+ type TermMsg struct

+ Cols int

+ Data string

+ ExitCode int

+ Reason string

+ Rows int

+ Type string

+ type TerminalSessionService interface

+ Close func() error

+ Create func(ctx context.Context, opts CreateOptions) (*SessionInfo, error)

+ Delete func(ctx context.Context, id string) error

+ Get func(ctx context.Context, id string) (*SessionInfo, error)

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

+ List func(ctx context.Context) ([]SessionInfo, error)

+ PasteUpload func(ctx context.Context, id string, filename string, content io.Reader, ...) (string, error)

+ Resize func(ctx context.Context, id string, cols, rows int) error

+ TailOutput func(ctx context.Context, id string, lines int) ([]string, error)

+ type TmuxNavPayload struct

+ Action string

+ type Tunnel struct

+ func NewTunnel(dataDir string) *Tunnel

+ func (t *Tunnel) IsRunning() bool

+ func (t *Tunnel) PublicURL() string

+ func (t *Tunnel) Start(ctx context.Context, localAddr string) (string, error)

+ func (t *Tunnel) Stop()

+ type WSControlMessage struct

+ Payload json.RawMessage

+ Type string

+ func WaitForControlMessage(t *testing.T, ws *websocket.Conn, msgType string, timeout time.Duration) WSControlMessage

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