Versions in this module Expand all Collapse all v0 v0.14.0 Nov 8, 2026 Changes in this version + const CapDescribe + const CapDeviceLogin + const CapNewSessions + const CapPush + const CapQueue + const CapSearch + const CapSendNow + const CapSessions + const CapTerminalInput + const KindApproval + const KindApprovalResolved + const KindQueue + const KindTurnDone + const KindTurnError + const KindTurnStarted + const OutcomeAllowed + const OutcomeDenied + const OutcomeExpired + const StateBusy + const StateIdle + const StateOpenInTerminal + const StateUnavailable + var ErrHandoffTimeout = errors.New("the terminal did not pick up the session in time") + var ErrInvalidOption = errors.New("that option was not offered for this approval") + var ErrNoSuchApproval = errors.New("no pending approval with that id") + var ErrNoTerminal = errors.New("no terminal app to open the session in") + var ErrNotAuthorized = errors.New("aimux may not control the terminal app") + var ErrNotStarted = errors.New("the session has no messages yet") + func LoginFrom(ctx context.Context) string + func RequireTailnetUser(allowed, trustedHosts []string, next http.Handler) http.Handler + type API struct + AutoName bool + Broker *Broker + Client http.Handler + Create func(ctx context.Context, cwd, text string) (string, error) + DeviceLogin *devicelogin.Server + Folder func(path string) folders.Folder + Handoff *Handoff + LastOnMac func() (id string, at time.Time, ok bool) + Links *Links + Log io.Writer + Naming Naming + Places func(ctx context.Context) map[string]terminput.MacPlace + Projects func(ctx context.Context) ([]Project, error) + Queue *chatqueue.Store + QueueKick func() + QueueNote func(session string) string + QueueSentNow func(session, text string) (forget func()) + Record func(ctx context.Context, id string) (history.Session, error) + RegisterDevice func(push.Device) error + Search func(ctx context.Context, query string, limit int) ([]SearchHit, error) + Session func(ctx context.Context, id string, turns int) (SessionDetail, error) + SessionExists func(ctx context.Context, id string) error + Sessions func(ctx context.Context, limit int, includeAutomated bool) ([]Session, error) + SessionsAt func(ctx context.Context, limit int, includeAutomated bool, ...) ([]Session, error) + States *sessionstate.Service + TerminalEnabled bool + TerminalInput TerminalInput + TerminalTyped func(sessionID string) + UnregisterDevice func(token string) error + Version string + func (a *API) Handler(allowedLogins, trustedHosts []string) http.Handler + func (a *API) PublishQueue(session string) + func (a *API) QueueEvents(ctx context.Context) + type ApprovalData struct + ApprovalID string + Options []acp.PermissionOption + Title string + ToolCall acp.ToolCallUpdate + type ApprovalNotice struct + ApprovalID string + Expires time.Time + Outcome string + Session string + Title string + type ApprovalResolvedData struct + ApprovalID string + Outcome string + type Broker struct + func NewBroker(deps BrokerDeps, opt BrokerOptions) *Broker + func (b *Broker) Answer(approvalID, option string) error + func (b *Broker) Approver() acprun.Approver + func (b *Broker) AwaitingApproval(session string) bool + func (b *Broker) Busy(session string) bool + func (b *Broker) Cancel(session string) error + func (b *Broker) Events(session string, after int64) []Event + func (b *Broker) Hold(session string) (release func(), err error) + func (b *Broker) LogID() string + func (b *Broker) Publish(session, kind string, data any) + func (b *Broker) Start(session, text, key string) (string, error) + func (b *Broker) Subscribe(session string, after int64) (<-chan Event, func()) + func (b *Broker) TurnEnded(session, turn string) (ended, failed bool) + type BrokerDeps struct + Cancel func(session string) error + Check func(session string) error + Send func(ctx context.Context, session, text string, onEvent func(acprun.Event)) (string, error) + type BrokerOptions struct + ApprovalTimeout time.Duration + OnApproval func(ApprovalNotice) + OnApprovalResolved func(ApprovalNotice) + OnTurnEnd func(session string) + type CreatedSession = catalog.CreatedSession + type CreatedStore = catalog.CreatedStore + type DescribeResult struct + Changed []string + Description string + Kept []string + Title string + type ErrorBody struct + Code string + Error string + type Event struct + Data json.RawMessage + Kind string + Seq int64 + Time time.Time + Turn string + type EventPage struct + Events []Event + Log string + type Handoff struct + Drop func(session string) error + Hold func(session string) (release func(), err error) + Open func(ctx context.Context, title string, argv []string, dir string) error + Poll time.Duration + State func(ctx context.Context, session string) (state string, err error) + Target func(ctx context.Context, session string) (title string, argv []string, dir string, err error) + Wait time.Duration + func (h *Handoff) Run(ctx context.Context, session string) error + type Health struct + ACPProtocolVersion int + Capabilities []string + Links *Links + Login string + Naming *NamingHealth + OpenOnMac bool + Session string + Status string + Version string + type LastOnMac struct + At time.Time + ID string + type Links struct + JiraBase string + JiraProjects []string + type LocalIndex struct + Broker *Broker + Created *CreatedStore + NewProvider string + Owned func(pid int) bool + Providers []Provider + Repo func(dir string) (web, branch, root string, ok bool) + Running func(id string) bool + SearchIndex func(ctx context.Context, query string, limit int, ids []string) ([]search.Result, error) + Terminal TerminalStatusReader + func (x *LocalIndex) Catalog() *catalog.Catalog + func (x *LocalIndex) Lookup(id string) (history.Session, bool) + func (x *LocalIndex) Projects(ctx context.Context) ([]Project, error) + func (x *LocalIndex) Record(_ context.Context, id string) (history.Session, error) + func (x *LocalIndex) RegistryStatus(sessionID string) string + func (x *LocalIndex) Search(ctx context.Context, query string, limit int) ([]SearchHit, error) + func (x *LocalIndex) Session(ctx context.Context, id string, turns int) (SessionDetail, error) + func (x *LocalIndex) SessionExists(_ context.Context, id string) error + func (x *LocalIndex) Sessions(ctx context.Context, limit int, includeAutomated bool) ([]Session, error) + func (x *LocalIndex) SessionsAt(_ context.Context, limit int, includeAutomated bool, ...) ([]Session, error) + func (x *LocalIndex) TerminalPID(sessionID string) (int, bool) + func (x *LocalIndex) TerminalPIDs() map[string]int + func (x *LocalIndex) Title(ctx context.Context, id string) (string, error) + type MetaResult struct + Description string + Pinned bool + Title string + type Naming interface + Status func() history.NamingStatus + UpdateSummary func(ctx context.Context, s history.Session) (history.SummaryResult, error) + Want func(ids []string) + type NamingHealth struct + Failing bool + Limit int + Paused bool + Reason string + Today int + type OpenOnMacResult struct + State string + type Project struct + LastActive time.Time + Name string + Path string + type ProjectList struct + Projects []Project + type Provider = catalog.Provider + type QueueACP struct + Broker *Broker + func (q QueueACP) Busy(session string) bool + func (q QueueACP) Start(session, text, key string) (string, error) + func (q QueueACP) TurnEnded(session, turn string) (bool, bool) + type QueueInput interface + LeftInBox func(sessionID string) bool + Send func(ctx context.Context, sessionID, text, idemKey string) error + Status func(ctx context.Context, sessionID, registryStatus string) terminput.Status + Submit func(ctx context.Context, sessionID, text string) error + type QueueItem struct + Created time.Time + ID string + State string + Text string + type QueueStatus struct + Items []QueueItem + Note string + Reason string + State string + type QueueTerminal struct + Index *LocalIndex + Input QueueInput + func (q QueueTerminal) LeftInBox(session string) bool + func (q QueueTerminal) Open(session string) (string, bool) + func (q QueueTerminal) Send(ctx context.Context, session, text, key string) error + func (q QueueTerminal) Status(ctx context.Context, session, registryStatus string) terminput.Status + func (q QueueTerminal) Submit(ctx context.Context, session, text string) error + func (q QueueTerminal) Turns(ctx context.Context, session string) ([]chatqueue.Turn, error) + type Repo struct + Branch string + Root string + Web string + type SearchHit struct + Snippet string + type SearchResults struct + Results []SearchHit + type Session struct + Activity sessionstate.Activity + Description string + Folder *folders.Folder + ID string + LastActive time.Time + LastPrompt string + Mac *terminput.MacPlace + Pinned bool + Project string + Provider string + State string + Title string + Waiting *waiting.Waiting + Working bool + type SessionDetail struct + Queue *QueueStatus + Repo *Repo + Stats *SessionStats + Terminal *TerminalStatus + Turns []Turn + type SessionList struct + LastOnMac *LastOnMac + Sessions []Session + type SessionStats struct + CacheReadTokens int64 + CacheWriteTokens int64 + CostUSD float64 + DurationMin float64 + GitBranch string + Model string + StartTime *time.Time + TokensIn int64 + TokensOut int64 + Turns int + type Status struct + Status string + type StatusCache struct + func NewStatusCache(inner TerminalStatusReader, ttl time.Duration) *StatusCache + func (c *StatusCache) Invalidate(sessionID string) + func (c *StatusCache) Status(ctx context.Context, sessionID, registryStatus string) terminput.Status + type Store = catalog.Store + type TerminalInput interface + Press func(ctx context.Context, sessionID, promptID string, option terminput.Key, ...) error + Send func(ctx context.Context, sessionID, text, idemKey string) error + SendNow func(ctx context.Context, sessionID, text, idemKey string) error + SendReplacing func(ctx context.Context, sessionID, text, idemKey string) error + type TerminalOption struct + Key string + Label string + type TerminalPrompt struct + Detail string + Options []TerminalOption + PromptID string + Question string + type TerminalStatus struct + BoxHasText bool + CanType bool + Prompt *TerminalPrompt + Reason string + Status string + Working bool + WorkingSeconds int + type TerminalStatusReader interface + Status func(ctx context.Context, sessionID, registryStatus string) terminput.Status + type ToolDetail struct + Error string + Input string + New string + Old string + type Turn struct + Number int + Reply string + Time time.Time + Tools []TurnTool + User string + type TurnAccepted struct + After int64 + Events string + ID string + Turn string + type TurnDoneData struct + StopReason string + type TurnErrorData struct + Error string + type TurnStartedData struct + Text string + type TurnTool struct + Detail *ToolDetail + Name string + OK bool + Snippet string