screentracker

Documentation

Index

• Variables
• type AgentIO
• type AgentState
• type Conversation
• type ConversationMessage
• type ConversationRole
  • func (c ConversationRole) Schema(r huma.Registry) *huma.Schema
• type ConversationStatus
• type Emitter
• type ErrorLevel
  • func (e ErrorLevel) Schema(r huma.Registry) *huma.Schema
• type LoadStateStatus
• type MessagePart
• type MessagePartText
  • func (p MessagePartText) Do(writer AgentIO) error
  • func (p MessagePartText) String() string
• type PTYConversation
  • func NewPTY(ctx context.Context, cfg PTYConversationConfig, emitter Emitter) *PTYConversation
  • func (c *PTYConversation) Messages() []ConversationMessage
  • func (c *PTYConversation) SaveState() error
  • func (c *PTYConversation) Send(messageParts ...MessagePart) error
  • func (c *PTYConversation) Start(ctx context.Context)
  • func (c *PTYConversation) Status() ConversationStatus
  • func (c *PTYConversation) Text() string
• type PTYConversationConfig
• type RingBuffer
  • func NewRingBuffer[T any](size int) *RingBuffer[T]
  • func (r *RingBuffer[T]) Add(item T)
  • func (b *RingBuffer[T]) Capacity() int
  • func (b *RingBuffer[T]) GetAll() []T
• type StatePersistenceConfig

Variables

var (
	ErrMessageValidationWhitespace = xerrors.New("message must be trimmed of leading and trailing whitespace")
	ErrMessageValidationEmpty      = xerrors.New("message must not be empty")
	ErrMessageValidationChanging   = xerrors.New("message can only be sent when the agent is waiting for user input")
)

var ConversationRoleValues = []ConversationRole{
	ConversationRoleUser,
	ConversationRoleAgent,
}

var ErrorLevelValues = []ErrorLevel{
	ErrorLevelWarning,
	ErrorLevelError,
}

Types

type AgentIO

type AgentIO interface {
	Write(data []byte) (int, error)
	ReadScreen() string
}

type AgentState

type AgentState struct {
	Version           int                   `json:"version"`
	Messages          []ConversationMessage `json:"messages"`
	InitialPrompt     string                `json:"initial_prompt"`
	InitialPromptSent bool                  `json:"initial_prompt_sent"`
}

type Conversation

type Conversation interface {
	Messages() []ConversationMessage
	Send(...MessagePart) error
	Start(context.Context)
	Status() ConversationStatus
	Text() string
	SaveState() error
}

Conversation represents a conversation between a user and an agent. It is intended as the primary interface for interacting with a session. Implementations must support the following capabilities:

• Fetching all messages between the user and agent,
• Sending a message to the agent,
• Starting a background loop to update the conversation state, if required,
• Fetching the status of the conversation,
• Returning a textual representation of the conversation "screen" (used for notifying subscribers of updates to the conversation).

type ConversationMessage

type ConversationMessage struct {
	Id      int              `json:"id"`
	Message string           `json:"message"`
	Role    ConversationRole `json:"role"`
	Time    time.Time        `json:"time"`
}

type ConversationRole

type ConversationRole string

const (
	ConversationRoleUser  ConversationRole = "user"
	ConversationRoleAgent ConversationRole = "agent"
)

func (ConversationRole) Schema

func (c ConversationRole) Schema(r huma.Registry) *huma.Schema

type ConversationStatus

type ConversationStatus string

const (
	ConversationStatusChanging     ConversationStatus = "changing"
	ConversationStatusStable       ConversationStatus = "stable"
	ConversationStatusInitializing ConversationStatus = "initializing"
)

type Emitter

type Emitter interface {
	EmitMessages([]ConversationMessage)
	EmitStatus(ConversationStatus)
	EmitScreen(string)
	EmitError(message string, level ErrorLevel)
}

Emitter receives conversation state updates.

type ErrorLevel

type ErrorLevel string

const (
	ErrorLevelWarning ErrorLevel = "warning"
	ErrorLevelError   ErrorLevel = "error"
)

func (ErrorLevel) Schema

func (e ErrorLevel) Schema(r huma.Registry) *huma.Schema

type LoadStateStatus

type LoadStateStatus int

LoadStateStatus represents the state of loading persisted conversation state.

const (
	// LoadStatePending indicates state loading has not been attempted yet.
	LoadStatePending LoadStateStatus = iota
	// LoadStateSucceeded indicates state was successfully loaded.
	LoadStateSucceeded
	// LoadStateFailed indicates state loading was attempted but failed.
	LoadStateFailed
)

type MessagePart

type MessagePart interface {
	Do(writer AgentIO) error
	String() string
}

type MessagePartText

type MessagePartText struct {
	Content string
	Alias   string
	Hidden  bool
}

func (MessagePartText) Do

func (p MessagePartText) Do(writer AgentIO) error

func (MessagePartText) String

func (p MessagePartText) String() string

type PTYConversation

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

PTYConversation is a conversation that uses a pseudo-terminal (PTY) for communication. It uses a combination of polling and diffs to detect changes in the screen.

func NewPTY

func NewPTY(ctx context.Context, cfg PTYConversationConfig, emitter Emitter) *PTYConversation

func (*PTYConversation) Messages

func (c *PTYConversation) Messages() []ConversationMessage

func (*PTYConversation) SaveState

func (c *PTYConversation) SaveState() error

func (*PTYConversation) Send

func (c *PTYConversation) Send(messageParts ...MessagePart) error

func (*PTYConversation) Start

func (c *PTYConversation) Start(ctx context.Context)

func (*PTYConversation) Status

func (c *PTYConversation) Status() ConversationStatus

func (*PTYConversation) Text

func (c *PTYConversation) Text() string

type PTYConversationConfig

type PTYConversationConfig struct {
	AgentType msgfmt.AgentType
	AgentIO   AgentIO
	// Clock provides time operations for the conversation
	Clock quartz.Clock
	// How often to take a snapshot for the stability check
	SnapshotInterval time.Duration
	// How long the screen should not change to be considered stable
	ScreenStabilityLength time.Duration
	// Function to format the messages received from the agent
	// userInput is the last user message
	FormatMessage func(message string, userInput string) string
	// ReadyForInitialPrompt detects whether the agent has initialized and is ready to accept the initial prompt
	ReadyForInitialPrompt func(message string) bool
	// FormatToolCall removes the coder report_task tool call from the agent message and also returns the array of removed tool calls
	FormatToolCall func(message string) (string, []string)
	// InitialPrompt is the initial prompt to send to the agent once ready
	InitialPrompt          []MessagePart
	Logger                 *slog.Logger
	StatePersistenceConfig StatePersistenceConfig
}

PTYConversationConfig is the configuration for a PTYConversation.

type RingBuffer

type RingBuffer[T any] struct {
	// contains filtered or unexported fields
}

RingBuffer is a generic circular buffer that can store items of any type

func NewRingBuffer

func NewRingBuffer[T any](size int) *RingBuffer[T]

NewRingBuffer creates a new ring buffer with the specified size

func (*RingBuffer[T]) Add

func (r *RingBuffer[T]) Add(item T)

Add adds an item to the ring buffer

func (*RingBuffer[T]) Capacity

func (b *RingBuffer[T]) Capacity() int

Capacity returns the capacity of the ring buffer

func (*RingBuffer[T]) GetAll

func (b *RingBuffer[T]) GetAll() []T

GetAll returns all items in the buffer, oldest first

type StatePersistenceConfig

type StatePersistenceConfig struct {
	StateFile string
	LoadState bool
	SaveState bool
}