agentvisor

type Answer struct {
	Allow   bool   `json:"allow"`
	Message string `json:"message,omitempty"`
	// UpdatedInput replaces the tool input, when the harness takes it.
	UpdatedInput json.RawMessage `json:"updated_input,omitempty"`
}

type AttachOptions struct {
	View AttachView `json:"view,omitempty"`
	// Cols and Rows are the size of the client. A client that gives a size
	// takes the size lease when nobody holds it.
	Cols int `json:"cols,omitempty"`
	Rows int `json:"rows,omitempty"`
	// After is the event sequence after which the chat view starts.
	After uint64 `json:"after,omitempty"`
}

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

type AttachView string

type Attachment struct {
	MIME string `json:"mime"`
	Path string `json:"path,omitempty"`
	Data []byte `json:"data,omitempty"`
}

type AuthMode = harness.AuthMode

type AuthState = harness.AuthState

type Backend interface {
	Kind() Kind
	Caps(harness string) Caps
	Start(ctx context.Context, l Launch) (Handle, error)
	// Recover gives the sessions that lived through a visor restart.
	Recover(ctx context.Context) ([]Handle, error)
	Close(ctx context.Context) error
}

type Caps struct {
	// Structured means typed events: tools, requests, and results.
	Structured bool `json:"structured"`
	// Terminal means a terminal view that a client can attach to.
	Terminal bool `json:"terminal"`
	// Permissions means typed permission requests and answers.
	Permissions bool `json:"permissions"`
	// Steer means a send during a turn joins the turn.
	Steer bool `json:"steer"`
	// Resume means a stopped session can continue with its vendor id.
	Resume bool `json:"resume"`
	// Survives means the session lives through a visor restart.
	Survives bool `json:"survives"`
}

type Catalog interface {
	Folders(ctx context.Context) ([]string, error)
}

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

type ClientFrame struct {
	Type ClientFrameType `json:"type"`
	// View, Cols, Rows, and After belong to attach. Cols and Rows also
	// belong to control.
	View  AttachView `json:"view,omitempty"`
	Cols  int        `json:"cols,omitempty"`
	Rows  int        `json:"rows,omitempty"`
	After *uint64    `json:"after,omitempty"`
	// Seq is the binary sequence of an ack.
	Seq uint64 `json:"seq,omitempty"`
	// Text is the text of a send.
	Text string `json:"text,omitempty"`
	// Data is the bytes of an input.
	Data []byte `json:"-"`
}

type ClientFrameType string

type Delivery string

type Discoverer interface {
	// Found gives the new sessions. It closes when the backend closes.
	Found() <-chan Found
	// Adopt binds the found session with key to the visor session s.
	Adopt(ctx context.Context, s Session, key string) (Handle, error)
}

type EndReason string

type Event struct {
	Seq     uint64    `json:"seq"`
	Session string    `json:"session,omitempty"`
	At      time.Time `json:"at"`
	Type    EventType `json:"type"`
	// State is the new state of a session.state event.
	State State `json:"state,omitempty"`
	// Turn counts the finished user turns of a wire session.
	Turn     int    `json:"turn,omitempty"`
	VendorID string `json:"vendor_id,omitempty"`
	Text     string `json:"text,omitempty"`
	// Input marks a user event that the visor wrote for a send or a first
	// prompt. A vendor echo of the turn has no mark.
	Input bool `json:"input,omitempty"`
	Delta bool `json:"delta,omitempty"`
	// Status is the activity hint of a status event.
	Status  string   `json:"status,omitempty"`
	Tool    *Tool    `json:"tool,omitempty"`
	Request *Request `json:"request,omitempty"`
	// RequestID names the request of a request.closed event.
	RequestID string  `json:"request_id,omitempty"`
	Result    *Result `json:"result,omitempty"`
	Usage     *Usage  `json:"usage,omitempty"`
	Limits    *Limits `json:"limits,omitempty"`
	Error     string  `json:"error,omitempty"`
	Code      string  `json:"code,omitempty"`
	EndReason string  `json:"end_reason,omitempty"`
	ExitCode  *int    `json:"exit_code,omitempty"`
	// Harness names the harness of a harness.changed event.
	Harness string `json:"harness,omitempty"`
	// Data is the payload of a hook event, the output of a script, or the
	// build of a restart.
	Data json.RawMessage `json:"data,omitempty"`
	// contains filtered or unexported fields
}

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

type EventType string

type FileContent = harness.FileContent

type Filter struct {
	Session string            `json:"session,omitempty"`
	Project string            `json:"project,omitempty"`
	Workdir string            `json:"workdir,omitempty"`
	Key     string            `json:"key,omitempty"`
	Kind    Kind              `json:"kind,omitempty"`
	Role    Role              `json:"role,omitempty"`
	States  []State           `json:"states,omitempty"`
	Labels  map[string]string `json:"labels,omitempty"`
}

type Found struct {
	// Key names the session in the backend.
	Key     string
	Harness string
	// Dir is the absolute working folder.
	Dir    string
	Title  string
	Labels map[string]string
}

type Frame struct {
	Type FrameType `json:"type"`
	// Op, Seq, and Data belong to a binary frame. Seq counts the binary
	// bytes that the attachment sent, and an ack gives it back.
	Op   FrameOp `json:"-"`
	Seq  uint64  `json:"-"`
	Data []byte  `json:"-"`
	// View, Source, Writable, Resizable, and Title belong to attached.
	View      AttachView `json:"view,omitempty"`
	Source    Kind       `json:"source,omitempty"`
	Cols      int        `json:"cols,omitempty"`
	Rows      int        `json:"rows,omitempty"`
	Writable  bool       `json:"writable,omitempty"`
	Resizable bool       `json:"resizable,omitempty"`
	Title     string     `json:"title,omitempty"`
	// Holder belongs to lease.
	Holder LeaseHolder `json:"holder,omitempty"`
	// From, To, and Turns belong to turns.
	From  uint64 `json:"from,omitempty"`
	To    uint64 `json:"to,omitempty"`
	Turns []Turn `json:"turns,omitempty"`
	// Reason belongs to ended.
	Reason EndReason `json:"reason,omitempty"`
	// Code and Message belong to error.
	Code    string `json:"code,omitempty"`
	Message string `json:"message,omitempty"`
}

type FrameOp byte

type FrameType string

type Handle interface {
	Session() string
	VendorID() string
	PID() int
	Send(ctx context.Context, in Input) (Delivery, error)
	Interrupt(ctx context.Context) error
	Answer(ctx context.Context, requestID string, a Answer) error
	Close(ctx context.Context) error
	Events() <-chan Event
}

type Harness = harness.Harness

type HarnessFacts = harness.Facts

type HarnessOptions = harness.Options

type HarnessPolicy = harness.Policy

type HarnessSource = harness.Source

type HarnessUpdate = harness.Update

type Hello struct {
	Client   string `json:"client"`
	Build    string `json:"build"`
	Protocol string `json:"protocol"`
	// Binary is the product binary that contains the visor build of Build.
	Binary string `json:"binary,omitempty"`
}

type HomeFile = harness.HomeFile

type HookCall struct {
	Harness string `json:"harness"`
	// Session is the AGENT_VISOR_SESSION value of the hook process, or empty
	// for a session that started outside the visor.
	Session string `json:"session,omitempty"`
	// Labels find the session when Session is empty, for example the
	// terminal of another app. A new observed session gets them.
	Labels  map[string]string `json:"labels,omitempty"`
	Payload json.RawMessage   `json:"payload"`
	// At is when the hook ran. Zero is now.
	At time.Time `json:"at,omitzero"`
}

type HookSpec struct {
	Harnesses []string `json:"harnesses,omitempty"`
	// Auth selects the login home: shared is the user login, separate is
	// the login of the visor. Empty selects both, and the visor login only
	// when its folder exists.
	Auth AuthMode `json:"auth,omitempty"`
	// Dir is a vendor home that replaces the login homes.
	Dir string `json:"dir,omitempty"`
}

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

type HookState = hooks.State

type HookStatus struct {
	Harness string `json:"harness"`
	// Auth is empty when HookSpec.Dir selects the home.
	Auth  AuthMode  `json:"auth,omitempty"`
	Dir   string    `json:"dir"`
	State HookState `json:"state"`
}

type Info struct {
	Build    string `json:"build"`
	Protocol string `json:"protocol"`
	Client   string `json:"client,omitempty"`
	Home     string `json:"home"`
	Seq      uint64 `json:"seq"`
	Upgrade  string `json:"upgrade,omitempty"`
	PID      int    `json:"pid"`
}

type Input struct {
	Text string `json:"text"`
	// Kind is an opaque origin tag that the visor passes to the harness.
	Kind        string       `json:"kind,omitempty"`
	Attachments []Attachment `json:"attachments,omitempty"`
}

type Kind string

type Labeler interface {
	Labels() map[string]string
}

type Launch struct {
	Session Session
	Spec    StartSpec
	// Dir is the working folder.
	Dir string
	// Env is the merged env: visor, harness, session, and the visor values.
	Env map[string]string
	// Binary is the harness program. Empty searches PATH.
	Binary string
	// Home is the harness home for a separate login. Empty uses the login of
	// the user.
	Home string
	// Resume continues the vendor session in Session.VendorID.
	Resume bool
	// Prompt is the first turn, or nil.
	Prompt *Input
}

type LeaseHolder string

type LimitWindow = harness.LimitWindow

type Limits = harness.Limits

type Login = harness.Login

type LoginPhase = harness.LoginPhase

type LoginSpec = harness.LoginSpec

type MCPServer struct {
	Name    string            `json:"name"`
	Command string            `json:"command,omitempty"`
	Args    []string          `json:"args,omitempty"`
	Env     map[string]string `json:"env,omitempty"`
	URL     string            `json:"url,omitempty"`
	Headers map[string]string `json:"headers,omitempty"`
}

type Model = harness.Model

type Options struct {
	// Home owns every path of the visor.
	Home string
	// Client is the product name that the harnesses see.
	Client        string
	ClientVersion string
	// Build is the build of this visor. Empty reads the module build info.
	Build string
	// Socket is the socket path that sessions get in AGENT_VISOR_SOCKET.
	Socket string
	// Env is the default env of each session.
	Env map[string]string
	// Backends are extra backends, for example an optional host of sessions.
	Backends []Backend
	// HolderCommand runs a holder for a pty or a wire session; the visor
	// adds the session id. Empty is this program with the argument hold.
	HolderCommand []string
	// HookCommand runs a vendor hook; the visor adds the harness name. Empty
	// is this program with the home and the argument hook.
	HookCommand []string
	// TerminalCommand builds the command of an agent session in a PTY. Nil
	// uses the harness program with ExtraArgs and has no resume command.
	TerminalCommand TerminalCommand
	// Drivers replace agent-wire drivers, for tests (for example the fake
	// harness with a script). A wire session of such a harness runs in the
	// visor process, not in a holder, so it does not survive a restart.
	Drivers map[string]agentwire.Driver
	// Harness configures the harness inventory. The visor sets its InUse,
	// OnChange, and Logger.
	Harness HarnessOptions
	Logger  *slog.Logger
	// KeepExited is how long the visor keeps an exited session and its
	// events. Zero keeps them for 7 days.
	KeepExited time.Duration
	// KeepFragments is how long the visor keeps the stream fragments of a
	// failed wire session. Zero keeps them for 30 days.
	KeepFragments time.Duration
	// UpgradeWait is how long an upgrade waits for a quiet visor. Zero is
	// 24 hours. A new protocol major waits 10 minutes at most.
	UpgradeWait time.Duration
	// Exec replaces the process with the upgrade binary. Nil is
	// syscall.Exec.
	Exec func(binary string, args, env []string) error
	// Now is the clock of the upgrade deadline. Nil is time.Now.
	Now func() time.Time
	// contains filtered or unexported fields
}

type OwnStart = harness.OwnStart

type Permissions struct {
	// Mode is ask, auto_edit, auto, or inherit. Empty is ask.
	Mode agentwire.PermissionMode `json:"mode,omitempty"`
	// AllowTools are tools that need no answer. A pattern can end in "*".
	AllowTools []string `json:"allow_tools,omitempty"`
}

type Project = workdir.Project

type PurgeSpec struct {
	Session  string `json:"session,omitempty"`
	Harness  string `json:"harness,omitempty"`
	VendorID string `json:"vendor_id,omitempty"`
}

type Request struct {
	ID        string   `json:"id"`
	Tool      string   `json:"tool,omitempty"`
	Kind      string   `json:"kind,omitempty"`
	Question  string   `json:"question,omitempty"`
	Input     string   `json:"input,omitempty"`
	Options   []string `json:"options,omitempty"`
	ToolUseID string   `json:"tool_use_id,omitempty"`
}

type RestartMode string

type RestartPolicy struct {
	Mode RestartMode `json:"mode,omitempty"`
	// Prompt is the first turn after a resume.
	Prompt string `json:"prompt,omitempty"`
}

type Result struct {
	Subtype   string `json:"subtype,omitempty"`
	IsError   bool   `json:"is_error,omitempty"`
	Text      string `json:"text,omitempty"`
	VendorID  string `json:"vendor_id,omitempty"`
	Usage     Usage  `json:"usage"`
	EndReason string `json:"end_reason,omitempty"`
	Code      string `json:"code,omitempty"`
}

type Role string

type Screen struct {
	Cols      int      `json:"cols"`
	Rows      int      `json:"rows"`
	Lines     []string `json:"lines"`
	CursorRow int      `json:"cursor_row"`
	CursorCol int      `json:"cursor_col"`
}

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

type Session struct {
	ID         string            `json:"id"`
	Project    string            `json:"project"`
	Workdir    string            `json:"workdir"`
	Kind       Kind              `json:"kind"`
	Role       Role              `json:"role"`
	Title      string            `json:"title,omitempty"`
	Harness    string            `json:"harness,omitempty"`
	Model      string            `json:"model,omitempty"`
	Effort     string            `json:"effort,omitempty"`
	WorkingDir string            `json:"working_dir"`
	State      State             `json:"state"`
	VendorID   string            `json:"vendor_id,omitempty"`
	PID        int               `json:"pid,omitempty"`
	Labels     map[string]string `json:"labels,omitempty"`
	// Pending holds the open permissions and questions.
	Pending []Request     `json:"pending,omitempty"`
	Restart RestartPolicy `json:"restart"`
	// EnvKeys lists the session env keys. The values never leave the visor.
	EnvKeys []string `json:"env_keys,omitempty"`
	// Seq is the sequence number of the last event of the session.
	Seq       uint64    `json:"seq"`
	Turns     int       `json:"turns,omitempty"`
	ExitCode  *int      `json:"exit_code,omitempty"`
	Error     string    `json:"error,omitempty"`
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
}

type Skill struct {
	// Name replaces the name in the SKILL.md front matter.
	Name string `json:"name,omitempty"`
	// Dir is the folder that holds SKILL.md.
	Dir string `json:"dir"`
}

type StartSpec struct {
	// Kind is empty for wire when the harness has a driver, else pty.
	Kind Kind `json:"kind,omitempty"`
	// Role is empty for agent, or shell when there is no harness.
	Role    Role   `json:"role,omitempty"`
	Title   string `json:"title,omitempty"`
	Harness string `json:"harness,omitempty"`
	Model   string `json:"model,omitempty"`
	Effort  string `json:"effort,omitempty"`
	// Binary is the harness program. Empty uses the visor install, else
	// PATH.
	Binary string `json:"binary,omitempty"`
	// Workdir is a workdir id. Empty finds or makes it from WorkingDir.
	Workdir string `json:"workdir,omitempty"`
	// WorkingDir is a folder in the workdir. Empty is the workdir path.
	WorkingDir string `json:"working_dir,omitempty"`
	// Command is the shell or script command. Empty is the login shell.
	Command []string `json:"command,omitempty"`
	// Env wins over the harness env and the visor env.
	Env          map[string]string `json:"env,omitempty"`
	Instructions string            `json:"instructions,omitempty"`
	// Prompt is the first turn. Empty starts the session idle.
	Prompt      string      `json:"prompt,omitempty"`
	Permissions Permissions `json:"permissions"`
	MCPServers  []MCPServer `json:"mcp_servers,omitempty"`
	Skills      []Skill     `json:"skills,omitempty"`
	ExtraArgs   []string    `json:"extra_args,omitempty"`
	// ResumeID is a vendor session id to resume.
	ResumeID string            `json:"resume_id,omitempty"`
	Labels   map[string]string `json:"labels,omitempty"`
	Restart  RestartPolicy     `json:"restart"`
	Raw      map[string]any    `json:"raw,omitempty"`
	// LogFragments writes every stream fragment to the frame log of a wire
	// session. By default the frame log keeps fragments only when the
	// stream fails, in fragments/<id>.ndjson.
	LogFragments bool `json:"log_fragments,omitempty"`
}

type State string

type TerminalCommand func(l Launch) ([]string, error)

type TextTerminal interface {
	Screen(ctx context.Context) (Screen, error)
	Keys(ctx context.Context, data []byte) error
	Paste(ctx context.Context, text string) error
	// Output gives the end of the terminal output as plain text.
	Output(ctx context.Context) (string, error)
}

type Tool struct {
	ID       string   `json:"id"`
	Name     string   `json:"name"`
	Kind     string   `json:"kind,omitempty"`
	Input    string   `json:"input,omitempty"`
	Output   string   `json:"output,omitempty"`
	Status   string   `json:"status,omitempty"`
	Paths    []string `json:"paths,omitempty"`
	ExitCode *int     `json:"exit_code,omitempty"`
}

type Turn struct {
	Seq  uint64    `json:"seq"`
	Role TurnRole  `json:"role"`
	At   time.Time `json:"at"`
	Text string    `json:"text,omitempty"`
	Tool *Tool     `json:"tool,omitempty"`
}

type TurnRole string

type UpdateMode = harness.UpdateMode

type UpgradeSpec struct {
	// Binary is the program of the new build. The visor runs it with its
	// own arguments and env.
	Binary   string `json:"binary"`
	Build    string `json:"build,omitempty"`
	Protocol string `json:"protocol,omitempty"`
}

type Usage struct {
	Input         int64   `json:"input,omitempty"`
	Output        int64   `json:"output,omitempty"`
	CacheRead     int64   `json:"cache_read,omitempty"`
	CacheCreation int64   `json:"cache_creation,omitempty"`
	Model         string  `json:"model,omitempty"`
	CostUSD       float64 `json:"cost_usd,omitempty"`
}

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

type Workdir = workdir.Workdir

type WorkdirKind = workdir.Kind

type WorkdirSpec = workdir.Spec

type WorkdirState = workdir.State