Documentation
¶
Overview ¶
Package ports defines the interfaces that decouple the engine and CLI from concrete infrastructure. Adapters (filesystem, SQLite, Vault, etc.) implement these interfaces; the engine and CLI depend only on the ports.
This is the "ports" half of ports-and-adapters (hexagonal architecture). Adding a new backend (e.g. SQLite state store, AWS Secrets Manager) means writing a new adapter — no engine changes required.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AuditEvent ¶ added in v0.1.1
type AuditEvent struct {
EventID string `json:"event_id,omitempty"`
Type string `json:"type"`
SessionID string `json:"session_id,omitempty"`
TS time.Time `json:"ts,omitempty"`
Agent string `json:"agent,omitempty"`
Model string `json:"model,omitempty"`
Tool string `json:"tool,omitempty"`
Args json.RawMessage `json:"args,omitempty"`
Outcome string `json:"outcome,omitempty"`
Error string `json:"error,omitempty"`
DurationMS int64 `json:"duration_ms,omitempty"`
InputTokens int `json:"input_tokens,omitempty"`
OutputTokens int `json:"output_tokens,omitempty"`
CostUSD float64 `json:"cost_usd,omitempty"`
Metadata map[string]any `json:"metadata,omitempty"`
HMAC string `json:"hmac,omitempty"`
}
AuditEvent is the provider-agnostic schema used by the engine and CLI.
type AuditSink ¶ added in v0.1.1
type AuditSink interface {
Emit(ctx context.Context, event AuditEvent) error
Flush(ctx context.Context) error
Close() error
}
AuditSink receives structured audit events.
type Config ¶
Config mirrors userconfig.Config but lives in the ports package so adapters don't import the CLI layer.
type ConfigSource ¶
ConfigSource loads and saves the user's CLI configuration (provider, model, base URL, default agent). The filesystem adapter is the default; a k8s operator might use a ConfigMap adapter instead.
type ContentBlock ¶
type ContentBlock struct {
Type string
Text string
MimeType string
ImageB64 string
ToolID string
ToolName string
ToolInput string
ToolUseID string
Output string
IsError bool
}
ContentBlock is a serializable content block.
type ErrNotFound ¶
type ErrNotFound struct{ ID string }
ErrNotFound is returned by StateStore when a session doesn't exist.
func (*ErrNotFound) Error ¶
func (e *ErrNotFound) Error() string
type Message ¶
type Message struct {
Role string
Content []ContentBlock
}
Message is a provider-agnostic serializable message. It mirrors llm.Message but uses plain strings so the ports package doesn't import the llm package.
type Secrets ¶
type Secrets interface {
Get(ctx context.Context, provider string) (string, error)
Set(ctx context.Context, provider, key string) error
Delete(ctx context.Context, provider string) error
}
Secrets reads and writes API keys. The default adapters use the OS keychain (macOS security CLI, Linux secret-tool). Enterprise deployments might use Vault, AWS Secrets Manager, or environment variables.
type SessionData ¶
type SessionData struct {
Provider string
Model string
Messages []Message
InputTokens int
OutputTokens int
}
SessionData is the serializable state of a conversation.
type StateStore ¶
type StateStore interface {
// SaveSession persists a named session's messages and metadata.
SaveSession(ctx context.Context, id string, data *SessionData) error
// LoadSession retrieves a previously saved session. Returns
// ErrNotFound if the session doesn't exist.
LoadSession(ctx context.Context, id string) (*SessionData, error)
// ListSessions returns the ids of all saved sessions.
ListSessions(ctx context.Context) ([]string, error)
// DeleteSession removes a saved session.
DeleteSession(ctx context.Context, id string) error
}
StateStore persists session state across invocations. The default adapter is in-memory (no persistence). A filesystem or SQLite adapter enables conversation resumption.
Source Files