Documentation
¶
Index ¶
- Constants
- type Ack
- type ArtifactFinish
- type ArtifactPart
- type ArtifactStart
- type CodexAccountUsage
- type CodexCredits
- type CodexMetadata
- type CodexModel
- type CodexRateLimit
- type CodexRateLimitWindow
- type CodexRateLimits
- type CodexReasoningEffort
- type CodexServiceTier
- type Dispatch
- type Envelope
- type EventPayload
- type Heartbeat
- type Hello
- type Result
- type Snapshot
- type SnapshotCommand
- type SnapshotTask
- type SnapshotWorkspace
- type Welcome
Constants ¶
View Source
const ( RunnerHello = "runner.hello" RunnerWelcome = "runner.welcome" RunnerHeartbeat = "runner.heartbeat" RunnerSnapshot = "runner.snapshot" CommandDispatch = "command.dispatch" CommandAck = "command.ack" CommandResult = "command.result" EventAppend = "event.append" ArtifactBegin = "artifact.begin" ArtifactChunk = "artifact.chunk" ArtifactComplete = "artifact.complete" ProtocolError = "protocol.error" )
View Source
const Version = "1.0"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ArtifactFinish ¶
type ArtifactPart ¶
type ArtifactStart ¶
type ArtifactStart struct {
UploadID uuid.UUID `json:"uploadId"`
ArtifactID uuid.UUID `json:"artifactId"`
TaskID uuid.UUID `json:"taskId"`
Name string `json:"name"`
Kind string `json:"kind"`
SHA256 string `json:"sha256"`
Size int64 `json:"size"`
MIME string `json:"mime"`
Compression string `json:"compression"`
}
type CodexAccountUsage ¶
type CodexAccountUsage struct {
LifetimeTokens *int64 `json:"lifetimeTokens,omitempty"`
PeakDailyTokens *int64 `json:"peakDailyTokens,omitempty"`
CurrentStreakDays *int64 `json:"currentStreakDays,omitempty"`
LongestStreakDays *int64 `json:"longestStreakDays,omitempty"`
LongestRunningTurnSec *int64 `json:"longestRunningTurnSec,omitempty"`
}
type CodexCredits ¶
type CodexMetadata ¶
type CodexMetadata struct {
Available bool `json:"available"`
RefreshedAt time.Time `json:"refreshedAt"`
Models []CodexModel `json:"models"`
RateLimits *CodexRateLimits `json:"rateLimits,omitempty"`
Usage *CodexAccountUsage `json:"usage,omitempty"`
Message string `json:"message,omitempty"`
}
type CodexModel ¶
type CodexModel struct {
ID string `json:"id"`
Model string `json:"model"`
DisplayName string `json:"displayName"`
Description string `json:"description"`
IsDefault bool `json:"isDefault"`
DefaultReasoningEffort string `json:"defaultReasoningEffort"`
SupportedReasoningEfforts []CodexReasoningEffort `json:"supportedReasoningEfforts"`
DefaultServiceTier *string `json:"defaultServiceTier,omitempty"`
ServiceTiers []CodexServiceTier `json:"serviceTiers"`
}
type CodexRateLimit ¶
type CodexRateLimit struct {
LimitID *string `json:"limitId,omitempty"`
LimitName *string `json:"limitName,omitempty"`
PlanType *string `json:"planType,omitempty"`
Primary *CodexRateLimitWindow `json:"primary,omitempty"`
Secondary *CodexRateLimitWindow `json:"secondary,omitempty"`
Credits *CodexCredits `json:"credits,omitempty"`
}
type CodexRateLimitWindow ¶
type CodexRateLimits ¶
type CodexRateLimits struct {
Default CodexRateLimit `json:"default"`
ByLimitID map[string]CodexRateLimit `json:"byLimitId,omitempty"`
}
type CodexReasoningEffort ¶
type CodexServiceTier ¶
type Envelope ¶
type EventPayload ¶
type Hello ¶
type Hello struct {
RunnerID uuid.UUID `json:"runnerId"`
NodeID string `json:"nodeId"`
Name string `json:"name"`
Hostname string `json:"hostname"`
Platform string `json:"platform"`
Arch string `json:"arch"`
Version string `json:"version"`
CodexVersion string `json:"codexVersion"`
CodexStatus string `json:"codexStatus"`
Capabilities map[string]any `json:"capabilities"`
LastAckCommandID *uuid.UUID `json:"lastAckCommandId,omitempty"`
}
type Snapshot ¶
type Snapshot struct {
Tasks []SnapshotTask `json:"tasks"`
Commands []SnapshotCommand `json:"commands"`
Workspaces []SnapshotWorkspace `json:"workspaces"`
}
Snapshot is sent immediately after hello and again after a reconnect. It lets the Control Plane reconcile durable Runner state when either side lost the final ACK/result during a network or process restart. All identifiers are still scoped by the credential-derived tenant on the server.
type SnapshotCommand ¶
type SnapshotTask ¶
type SnapshotWorkspace ¶
Click to show internal directories.
Click to hide internal directories.