api

package

Go to main page

Versions in this module

v0

v0.14.0

Sep 14, 2026

Changes in this version

+ const UsageIntervalBucketMinutes

+ type ScreenLayout struct

+ PaneCount int

+ Panes []ScreenPane

+ Position int

+ type ScreenPane struct

+ Current bool

+ Index int

+ SessionID string

+ Title string

+ type ScreenPanesResult struct

+ Screens []ScreenLayout

+ SessionID string

type Session

+ CommandLine string

+ ScreenPaneCount int

+ ScreenPosition int

+ type UsageBuckets struct

+ CacheRead int64

+ CacheWrite int64

+ FreshInput int64

+ Output int64

+ Reasoning int64

+ func (b UsageBuckets) Total() int64

+ type UsageCost struct

+ Calls int64

+ NanoUSD int64

+ PricedCalls int64

+ UnmeasuredProviders []string

+ func (c UsageCost) Complete() bool

+ type UsageDayStats struct

+ Buckets UsageBuckets

+ Cost UsageCost

+ Day string

+ type UsageGroupStats struct

+ Buckets UsageBuckets

+ Cost UsageCost

+ Key string

+ Label string

+ type UsageIntervalStats struct

+ Buckets UsageBuckets

+ Cost UsageCost

+ Day string

+ Minute int

+ type UsageRebuildResult struct

+ Calls int64

+ Days int64

+ Events int64

+ Rebuilt bool

+ type UsageStatsRequest struct

+ FromDay string

+ IntervalDay string

+ ToDay string

+ type UsageStatsResult struct

+ Cost UsageCost

+ DayModels []UsageGroupStats

+ DayProjects []UsageGroupStats

+ DayProviders []UsageGroupStats

+ Days []UsageDayStats

+ DetailDay string

+ FromDay string

+ IntervalBucketMinutes int

+ Intervals []UsageIntervalStats

+ Models []UsageGroupStats

+ PricesFetchedAt string

+ Projects []UsageGroupStats

+ Providers []UsageGroupStats

+ ToDay string

+ Total UsageBuckets

v0.13.0

Sep 11, 2026

Changes in this version

type AgentEvent

+ CanonicalType string

v0.12.2

Sep 8, 2026

v0.12.1

Sep 8, 2026

v0.12.0

Sep 8, 2026

Changes in this version

+ const AttentionStreamID

+ const CapabilityAgentAttachments

+ const CapabilityAgentGoals

+ const CapabilityAgentInteractions

+ const CapabilityAgentInterrupt

+ const CapabilityAgentTimeline

+ const CapabilityAppHeartbeat

+ const CapabilityRosterDelta

+ const HealthConnected

+ const HealthDisconnected

+ const HealthError

+ const HealthReady

+ const HealthUnavailable

+ const HealthUnconfigured

+ var AgentViewCapabilities = []string

+ var ErrAgentBlocked = errors.New("agent is blocked on attention")

+ var ErrAgentBusy = errors.New("agent is currently working")

+ func AgentAttachmentChunkDigest(data []byte, length int, expectedSHA256 string) error

+ func HostCapabilities() []string

+ func NegotiateCapabilities(hostCapabilities, clientCapabilities []string) []string

+ func NormalizeCapabilityList(values []string) []string

+ func StableAgentEventID(event AgentEvent) string

+ func SupportsCapability(capabilities []string, wanted string) bool

+ type AgentAttachmentAbortCommand struct

+ UploadID string

+ type AgentAttachmentAbortRequest struct

+ Session string

+ UploadID string

+ type AgentAttachmentChunkCommand struct

+ Chunk uint64

+ Data string

+ Length int

+ SHA256 string

+ UploadID string

+ type AgentAttachmentChunkRequest struct

+ Data string

+ Length int

+ SHA256 string

+ Sequence uint64

+ Session string

+ UploadID string

+ type AgentAttachmentCompleteCommand struct

+ Length int64

+ SHA256 string

+ UploadID string

+ type AgentAttachmentCompleteRequest struct

+ Length int64

+ SHA256 string

+ Session string

+ UploadID string

+ type AgentAttachmentPrepareCommand struct

+ MIME string

+ Name string

+ SHA256 string

+ Size int64

+ type AgentAttachmentPrepareRequest struct

+ MIME string

+ Name string

+ SHA256 string

+ Session string

+ Size int64

+ type AgentAttachmentPrepareResult struct

+ AttachmentID string

+ ChunkSize int

+ ExpiresAt time.Time

+ UploadID string

+ type AgentAttachmentRef struct

+ AttachmentID string

+ MIME string

+ Name string

+ Size int64

+ type AgentAttachmentResult struct

+ Accepted bool

+ AttachmentID string

+ Error string

+ Received int64

+ State string

+ UploadID string

+ type AgentCommand struct

+ CommandID string

+ ExecutionID string

+ ExpectedVersion uint64

+ LeaseID string

+ type AgentCommandReceipt struct

+ Accepted bool

+ CommandID string

+ type AgentDiagnostic struct

+ Code string

+ Column int

+ EndColumn int

+ EndLine int

+ File string

+ Line int

+ Message string

+ Severity string

+ Source string

+ type AgentDiff struct

+ Additions int

+ CallID string

+ Deletions int

+ Diff string

+ File string

+ Files []string

type AgentEvent

+ Payload map[string]any

+ ToolDetail string

+ ToolKind string

+ type AgentEventOrigin struct

+ Channel string

+ Confidence string

+ Driver string

+ Kind string

+ Provider string

+ type AgentEventsHistoryRequest struct

+ AfterSequence uint64

+ BeforeSequence uint64

+ Limit uint32

+ StreamID string

+ type AgentEventsHistoryResult struct

+ Events []CanonicalAgentEvent

+ ExecutionID string

+ HasMore bool

+ HeadSequence uint64

+ NextAfterSequence uint64

+ RetainedFrom uint64

+ StreamID string

+ type AgentEventsSubscriptionRequest struct

+ AfterSequence uint64

+ Limit uint32

+ StreamID string

+ type AgentEventsSubscriptionResult struct

+ Checkpoint AgentProjectionCheckpoint

+ Events []CanonicalAgentEvent

+ ExecutionID string

+ HasMore bool

+ HeadSequence uint64

+ Live bool

+ NextAfterSequence uint64

+ RetainedFrom uint64

+ StreamID string

+ type AgentExecution struct

+ ActiveTurn *AgentTurn

+ Capabilities []string

+ Conversation AgentProviderConversationRef

+ Driver string

+ HeadSequence uint64

+ ID string

+ Interactions []AgentInteraction

+ Provider string

+ State AgentExecutionState

+ Status AgentStatus

+ StreamID string

+ Target AgentTargetRef

+ type AgentExecutionState string

+ const AgentExecutionBlocked

+ const AgentExecutionClosed

+ const AgentExecutionCompleted

+ const AgentExecutionFailed

+ const AgentExecutionReady

+ const AgentExecutionStarting

+ const AgentExecutionWorking

+ type AgentGoalClearCommand struct

+ type AgentGoalClearRequest struct

+ CommandID string

+ Session string

+ type AgentGoalResult struct

+ Accepted bool

+ Objective string

+ Session string

+ type AgentGoalSetCommand struct

+ Objective string

+ ReplaceExisting bool

+ Status string

+ TokenBudget *int64

+ type AgentGoalSetRequest struct

+ CommandID string

+ Objective string

+ ReplaceExisting bool

+ Session string

+ Status string

+ TokenBudget *int64

+ type AgentInteraction struct

+ ID string

+ Kind string

+ Options []AgentInteractionOption

+ Schema map[string]any

+ State string

+ Title string

+ TurnID string

+ Version uint64

+ type AgentInteractionOption struct

+ Description string

+ ID string

+ Label string

+ type AgentInteractionResolveCommand struct

+ InteractionID string

+ Resolution map[string]any

+ Version uint64

+ type AgentInteractionResponse struct

+ CommandID string

+ Kind string

+ RequestID string

+ Response map[string]any

+ Session string

+ type AgentInteractionResult struct

+ Accepted bool

+ Kind string

+ RequestID string

+ Session string

+ type AgentMessageSendRequest struct

+ Attachments []AgentAttachmentRef

+ ClientMessageID string

+ Session string

+ Text string

+ type AgentMessageSendResult struct

+ Accepted bool

+ ClientMessageID string

+ Session string

+ type AgentProjectionCheckpoint struct

+ Sequence uint64

+ State map[string]any

+ type AgentProviderConversationRef struct

+ ID string

+ TranscriptPath string

+ type AgentQueueItem struct

+ Action string

+ Attachments []AgentAttachmentRef

+ Content string

+ CreatedAt time.Time

+ ID string

+ Order int

+ Prompt string

+ SessionID string

+ State string

+ type AgentTargetRef struct

+ ID string

+ Kind string

+ type AgentTurnCancelCommand struct

+ Reason string

+ TurnID string

+ type AgentTurnInterruptRequest struct

+ CommandID string

+ Reason string

+ Replacement *AgentMessageSendRequest

+ Session string

+ Turn uint64

+ type AgentTurnInterruptResult struct

+ Accepted bool

+ ClientMessageID string

+ Session string

+ Status string

+ Turn uint64

+ type AgentTurnStartCommand struct

+ Attachments []AgentAttachmentRef

+ Text string

type AgentTurnStatus

+ const AgentTurnCancelled

+ const AgentTurnInterrupted

+ type AgentTurnSteerCommand struct

+ Attachments []AgentAttachmentRef

+ Text string

+ TurnID string

type AgentWaitResult

+ ExecutionID string

+ type CanonicalAgentEvent struct

+ CausedBy string

+ EventID string

+ ExecutionID string

+ OccurredAt time.Time

+ Origin AgentEventOrigin

+ Payload map[string]any

+ RecordedAt time.Time

+ Sequence uint64

+ StreamID string

+ TurnID string

+ Type string

+ func CanonicalAgentEventFromObservation(event AgentEvent, streamID, executionID string, sequence uint64, ...) CanonicalAgentEvent

+ type CanonicalAgentEventsMessage struct

+ Events []CanonicalAgentEvent

+ ExecutionID string

+ Replay bool

+ StreamID string

+ Type string

type GhostlineMigration

+ SkipReasons map[string]string

+ SkippedSessions []string

+ type HealthStatus struct

+ Build string

+ OK bool

+ Ready bool

+ Status HealthSubsystems

+ Version string

+ type HealthSubsystems struct

+ Relay RelayHealth

+ Store string

type Project

+ SetupScript string

type PublicAccessEnableRequest

+ PathPrefix *string

+ PublicHostname *string

type PublicAccessStatus

+ AuthMode string

+ HostID string

+ PathPrefix string

+ PublicHostname string

+ RelayURL string

+ RouteID string

type PublicAccessTestRequest

+ PathPrefix *string

+ PublicHostname *string

+ type RelayHealth struct

+ Configured bool

+ Connected bool

+ LastError string

+ State string

type Response

+ Code string

+ Details any

type Session

+ AgentCapabilities []string

+ AgentExecutionID string

+ AgentHandler string

+ AgentProvider string

+ type WelcomeMessage struct

+ AccessScopeID string

+ Capabilities []string

+ Host Host

+ Type string

+ Version string

v0.11.3

Aug 29, 2026

v0.11.2

Aug 29, 2026

Changes in this version

type State

+ Tasks []Task

+ type Task struct

+ CreatedAt time.Time

+ CreationRequestHash string

+ CreationRequestID string

+ ExternalID string

+ ID string

+ Name string

+ Order int

+ Pinned bool

+ Source string

+ URL string

type Workspace

+ CreationRequestHash string

+ CreationRequestID string

+ TaskID string

v0.11.1

Aug 28, 2026

v0.11.0

Aug 28, 2026

Changes in this version

type State

+ WarrenVersion string

v0.10.1

Aug 27, 2026

v0.10.0

Aug 27, 2026

Changes in this version

type AgentEvent

+ ContentDelta bool

type Envelope

+ TerminalStateFormats []string

type Session

+ AgentTurn *AgentTurn

v0.9.1

Aug 25, 2026

v0.9.0

Aug 25, 2026

Changes in this version

+ const GhostlineMigrationCommitted

+ const GhostlineMigrationPrepared

+ const GhostlineMigrationPreparing

+ const GhostlineMigrationRetired

+ const GhostlineMigrationRouted

+ type AgentTranscriptChunk struct

+ Data string

+ EOF bool

+ Next int64

type Envelope

+ Capabilities []string

+ type GhostlineMigration struct

+ CreatedAt time.Time

+ HandoffVersion string

+ Phase string

+ SessionID string

+ SourceProtocol string

+ SourceSocket string

+ TargetSocket string

+ UpdatedAt time.Time

type Session

+ OutputCursor string

type State

+ GhostlineMigration *GhostlineMigration

+ Revision uint64

v0.8.2

Aug 23, 2026

v0.8.1

Aug 22, 2026

v0.8.0

Aug 22, 2026

Changes in this version

+ const SessionScopeTerminalGroup

+ const SessionScopeWorkspace

+ const Version

+ type AgentActivity string

+ const AgentActivityBlocked

+ const AgentActivityExited

+ const AgentActivityFailed

+ const AgentActivityReady

+ const AgentActivityStalled

+ const AgentActivityWorking

+ type AgentAttention struct

+ Kind AgentAttentionKind

+ Reason string

+ RequestID string

+ Since time.Time

+ type AgentAttentionKind string

+ const AgentAttentionApproval

+ const AgentAttentionInput

+ const AgentAttentionWarning

+ type AgentEvent struct

+ CallID string

+ Content string

+ DurationMs int64

+ Error string

+ Files []string

+ ID string

+ Model string

+ Output string

+ Provider string

+ Role string

+ Sequence uint64

+ Sidechain bool

+ StopReason string

+ Timestamp time.Time

+ ToolInput any

+ ToolName string

+ ToolStatus string

+ Turn uint64

+ Type string

+ Usage *AgentUsage

+ type AgentHistoryResult struct

+ Cursor uint64

+ Epoch uint64

+ Events []AgentEvent

+ HasMore bool

+ type AgentMessage struct

+ Epoch uint64

+ Events []AgentEvent

+ Session string

+ Type string

+ type AgentSnapshotResult struct

+ Epoch uint64

+ Sequence uint64

+ Turn AgentTurn

+ type AgentStatus struct

+ Activity AgentActivity

+ Attention *AgentAttention

+ func (s AgentStatus) Equal(other AgentStatus) bool

+ type AgentStatusMessage struct

+ Epoch uint64

+ Session string

+ Status AgentStatus

+ Type string

+ type AgentSubscriptionResult struct

+ Session Session

+ Snapshot AgentSnapshotResult

+ type AgentTurn struct

+ ID uint64

+ Status AgentTurnStatus

+ type AgentTurnMessage struct

+ Epoch uint64

+ Session string

+ Status AgentTurnStatus

+ Turn uint64

+ Type string

+ type AgentTurnStatus string

+ const AgentTurnAborted

+ const AgentTurnCompleted

+ const AgentTurnFailed

+ const AgentTurnIdle

+ const AgentTurnStarted

+ type AgentUsage struct

+ CacheCreationInputTokens int64

+ CacheReadInputTokens int64

+ InputTokens int64

+ OutputTokens int64

+ ReasoningOutputTokens int64

+ TotalTokens int64

+ type AgentWaitResult struct

+ Epoch uint64

+ Events []AgentEvent

+ Session string

+ Status AgentTurnStatus

+ Turn uint64

+ type Envelope struct

+ Cols int

+ Command string

+ Data string

+ Epoch uint64

+ ID string

+ Kind string

+ Method string

+ Params map[string]any

+ Project string

+ Rows int

+ Sequence uint64

+ Session string

+ Title string

+ Token string

+ Type string

+ Version string

+ Workspace string

+ type GitBranch struct

+ Name string

+ Remote bool

+ type GitChange struct

+ Added int

+ Deleted int

+ Path string

+ RenameFrom string

+ Staged bool

+ Status string

+ type GitCommandResult struct

+ Message string

+ type GitCommit struct

+ Author string

+ Email string

+ Files []GitChange

+ Hash string

+ Short string

+ Subject string

+ Time time.Time

+ type GitDiff struct

+ Content string

+ ContentTruncated bool

+ Diff string

+ DiffTruncated bool

+ type GitPanel struct

+ Ahead int

+ AheadOfMain int

+ Behind int

+ Branch string

+ Branches []GitBranch

+ Changes []GitChange

+ Commits []GitCommit

+ MainBranch string

+ Merged bool

+ Operation string

+ PullRequest *GitPullRequest

+ PullRequestError string

+ Refreshing bool

+ Remote string

+ UnmergedCommits []GitCommit

+ Upstream string

+ WorkspaceID string

+ type GitPullRequest struct

+ Author string

+ Base string

+ Body string

+ Draft bool

+ Head string

+ Number int

+ State string

+ Title string

+ URL string

+ type Host struct

+ ID string

+ Name string

+ OS string

+ User string

+ Version string

+ type MergeState string

+ const MergeStateMerged

+ const MergeStateUnmerged

+ type OperationAudit struct

+ AfterTerminalGroupID string

+ AfterWorkspaceID string

+ AgentSessionID string

+ BeforeTerminalGroupID string

+ BeforeWorkspaceID string

+ CreatedAt time.Time

+ ID string

+ Kind string

+ Resource string

+ ResourceID string

+ RevertedAt *time.Time

+ RevertsOperationID string

+ type Project struct

+ AutoImportGitWorktrees bool

+ CreatedAt time.Time

+ ID string

+ Name string

+ Order int

+ Path string

+ Pinned bool

+ type PublicAccessEnableRequest struct

+ AccountName *string

+ ApprovalKey string

+ EdgeURL *string

+ EnrollmentKey string

+ InviteKey string

+ type PublicAccessStatus struct

+ AccountName string

+ Authenticated bool

+ ConfiguredAccountName string

+ ConfiguredEdgeURL string

+ DefaultEdgeURL string

+ EdgeURL string

+ Enabled bool

+ Error string

+ PublicEndpoint string

+ Running bool

+ UsingDefaultAccount bool

+ UsingDefaultEdge bool

+ type PublicAccessTestRequest struct

+ AccountName *string

+ ApprovalKey string

+ EdgeURL *string

+ EnrollmentKey string

+ InviteKey string

+ type Response struct

+ Error string

+ ID string

+ OK bool

+ Result any

+ Type string

+ type Session struct

+ AgentSessionID string

+ AgentStatus *AgentStatus

+ Command string

+ CreatedAt time.Time

+ CustomTitle string

+ Directory string

+ EndedAt *time.Time

+ Epoch uint64

+ ID string

+ Kind string

+ Lifecycle string

+ OperationID string

+ Pinned bool

+ Process string

+ Runtime string

+ RuntimeKind string

+ Scope string

+ Sequence uint64

+ TerminalGroupID string

+ Title string

+ TranscriptPath string

+ WorkspaceID string

+ func (session Session) ScopeKind() string

+ type SessionMovePreflight struct

+ Allowed bool

+ DestinationTerminalGroupID string

+ DestinationWorkspaceID string

+ ExpectedAgentSessionID string

+ ExpectedWorkspaceID string

+ Session Session

+ SourceTerminalGroupID string

+ SourceWorkspaceID string

+ type State struct

+ Host Host

+ Operations []OperationAudit

+ Projects []Project

+ Schema int

+ Sessions []Session

+ TerminalGroups []TerminalGroup

+ Workspaces []Workspace

+ WorktreeOwnershipMigrated bool

+ type TerminalGroup struct

+ CreatedAt time.Time

+ Home string

+ ID string

+ Name string

+ Order int

+ type Workspace struct

+ Branch string

+ CreatedAt time.Time

+ ID string

+ Kind string

+ ManagedWorktree bool

+ MergeState MergeState

+ Name string

+ Order int

+ Path string

+ Pinned bool

+ ProjectID string

+ WorktreeLocked bool

+ type WorkspaceCreateResult struct

+ Created bool

+ GitWorktree bool

+ type WorktreeCandidate struct

+ Branch string

+ Imported bool

+ Locked bool

+ Name string

+ Path string

+ WorkspaceID string

v0.7.0

Aug 20, 2026

v0.6.3

Aug 20, 2026

v0.6.2

Aug 20, 2026

v0.6.1

Aug 20, 2026

v0.6.0

Aug 20, 2026

v0.5.2

Aug 20, 2026

v0.5.1

Aug 19, 2026

v0.5.0

Aug 19, 2026

v0.4.0

Aug 19, 2026

v0.3.1

Aug 19, 2026

v0.3.0

Aug 19, 2026

v0.2.0

Aug 19, 2026

v0.1.1

Aug 18, 2026

v0.1.0

Aug 18, 2026

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