harness

type AuthMode string

type AuthState string

type Facts struct {
	Recipe          func(h agentwire.Harness) (agentwire.InstallRecipe, bool)
	LoginCommand    func(h agentwire.Harness, o agentwire.LoginOptions) ([]string, error)
	LogoutCommand   func(h agentwire.Harness) []string
	LoginEnv        func(h agentwire.Harness, home string) map[string]string
	CredentialFiles func(h agentwire.Harness) []string
	AuthStatus      func(ctx context.Context, h agentwire.Harness, home string) (agentwire.AuthState, error)
	// Binary finds the program of a harness that agent-wire does not find,
	// such as a test harness of the product. Nil finds none.
	Binary func(h agentwire.Harness) string
}

type FileContent struct {
	Key     string `json:"key"`
	Side    string `json:"side"`
	Content string `json:"content"`
	ETag    string `json:"etag"`
}

type Harness struct {
	Name      string `json:"name"`
	Installed bool   `json:"installed"`
	Version   string `json:"version,omitempty"`
	// Latest is the newest vendor release, when known.
	Latest string `json:"latest,omitempty"`
	Path   string `json:"path,omitempty"`
	Source Source `json:"source,omitempty"`
	// Installs are the versions that the visor installed, oldest first.
	Installs []string `json:"installs,omitempty"`
	// Installable means that the visor can install its own copy.
	Installable bool `json:"installable"`
	// Supported means that the installed version meets the agent-wire floor.
	Supported bool `json:"supported"`
	// Detail tells why the harness is not usable.
	Detail   string    `json:"detail,omitempty"`
	AuthMode AuthMode  `json:"auth_mode"`
	Auth     AuthState `json:"auth"`
	// EnvKeys lists the harness env keys. The values never leave the visor.
	EnvKeys []string `json:"env_keys,omitempty"`
	Limits  *Limits  `json:"limits,omitempty"`
	// Updates is the update mode. KeptAt is when keep mode started.
	Updates UpdateMode `json:"updates"`
	KeptAt  *time.Time `json:"kept_at,omitempty"`
	// Pending means that an update waits for the end of the live sessions.
	Pending  bool `json:"pending,omitempty"`
	Updating bool `json:"updating,omitempty"`
	// History holds the last version changes, oldest first.
	History []Update `json:"history,omitempty"`
	// Models is the fixed model list. Manager.Models gives the live list.
	Models []Model `json:"models,omitempty"`
	// Login is the login that runs now, or nil.
	Login *Login `json:"login,omitempty"`
}

type HomeFile struct {
	Key    string                 `json:"key"`
	Kind   agentwire.HomeFileKind `json:"kind"`
	Format string                 `json:"format,omitempty"`
	// Shared means that the home uses the user file. Else the home keeps
	// its own copy.
	Shared bool `json:"shared"`
	// Login marks a login file. The auth mode decides its share.
	Login bool `json:"login,omitempty"`
	// Hooks marks a file that holds user hooks.
	Hooks bool `json:"hooks,omitempty"`
	// Locked means that the policy or the auth mode decides the share.
	Locked bool `json:"locked,omitempty"`
	// Blocked means that the home holds a real file where a shared file
	// links to the user file. The home uses its own copy until the user
	// removes it.
	Blocked    bool       `json:"blocked,omitempty"`
	UserPath   string     `json:"user_path"`
	HomePath   string     `json:"home_path"`
	UserExists bool       `json:"user_exists"`
	UserModAt  *time.Time `json:"user_modified_at,omitempty"`
	// OwnSince is when the home made its own copy.
	OwnSince *time.Time `json:"own_since,omitempty"`
	// UserChanged means that the user file changed after OwnSince.
	UserChanged bool `json:"user_changed_since_own,omitempty"`
	// BackupUntil is when the newest backup of an own copy expires.
	BackupUntil *time.Time `json:"backup_until,omitempty"`
}

type Launch struct {
	// Binary is the visor copy. Empty searches PATH.
	Binary string
	// Home is the harness home that the visor builds. Empty uses the user
	// home of the harness.
	Home string
	// Env is the harness env layer.
	Env map[string]string
	// Args are launch args that the harness needs, before the session args.
	Args []string
}

type LimitWindow struct {
	Key         string    `json:"key"`
	Scope       string    `json:"scope,omitempty"`
	Minutes     int       `json:"minutes,omitempty"`
	UsedPercent float64   `json:"used_percent"`
	ResetsAt    time.Time `json:"resets_at,omitzero"`
}

type Limits struct {
	Plan     string        `json:"plan,omitempty"`
	Rejected bool          `json:"rejected,omitempty"`
	Windows  []LimitWindow `json:"windows,omitempty"`
}

type Login struct {
	Harness string     `json:"harness"`
	Phase   LoginPhase `json:"phase"`
	// URL is the address that the user opens.
	URL string `json:"url,omitempty"`
	// Code is the device code that the user types on that page.
	Code string `json:"code,omitempty"`
	// AwaitCode means that the vendor asks for a pasted code. A terminal
	// login takes it with LoginCode; a pipe login cannot.
	AwaitCode bool `json:"await_code,omitempty"`
	// InApp means that the harness logs in only inside its own terminal
	// view. No login process runs.
	InApp bool   `json:"in_app,omitempty"`
	Error string `json:"error,omitempty"`
	Hint  string `json:"hint,omitempty"`
	// Session is the terminal session of the login, when the visor runs
	// it in a terminal. A client can attach to it.
	Session string `json:"session,omitempty"`
	// Screen is the end of the login screen.
	Screen string `json:"screen,omitempty"`
	// Done means that the login process ended.
	Done      bool      `json:"done,omitempty"`
	StartedAt time.Time `json:"started_at,omitzero"`
	EndedAt   time.Time `json:"ended_at,omitzero"`
}

type LoginPhase string

type LoginSpec struct {
	// Provider is the model provider of a harness with many providers.
	Provider string `json:"provider,omitempty"`
}

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

type Model struct {
	ID          string `json:"id"`
	Name        string `json:"name,omitempty"`
	Description string `json:"description,omitempty"`
	Default     bool   `json:"default,omitempty"`
	// Efforts are the effort levels, from low to high.
	Efforts []string `json:"efforts,omitempty"`
}

type Options struct {
	// Names are the harnesses that the manager knows. Empty means each
	// agent-wire harness with an install recipe.
	Names []string
	// Path is the search path for the install tools, such as npm. Empty
	// uses PATH.
	Path  string
	Facts Facts
	// LoginWait is how long Login waits for a URL or a code. Zero is 20 s.
	LoginWait time.Duration
	// LoginTimeout stops a login that does not end. Zero is 10 min.
	LoginTimeout time.Duration
	// InUse reports that a live session uses the harness. The visor sets it.
	InUse func(name string) bool
	// Enabled reports that the visor checks and updates a harness, also a
	// binary that the visor did not install. Nil checks only the visor
	// copies.
	Enabled func(name string) bool
	// CheckEvery is the time between two looks for a new release. Zero is
	// 6 h.
	CheckEvery time.Duration
	// Terminal runs the logins in terminal sessions. Nil runs them with a
	// pipe, which cannot take a pasted code.
	Terminal Terminal
	// OnChange gets the name of a harness that changed. The visor sets it.
	OnChange func(name string)
	// Policy is the product policy for the harness homes.
	Policy Policy
	// UserHome is the home folder of the user. Empty uses the home of the
	// process user.
	UserHome string
	Logger   *slog.Logger
}

type OwnStart string

type Policy struct {
	// MCPServers go into the MCP file of each harness home.
	MCPServers []agentwire.MCPServer
	// NoUserHooks keeps the user hooks out of the harness homes.
	NoUserHooks bool
	// Share changes the default share of a home file, by harness and key.
	Share map[string]map[string]bool
	// Keys are values that the home files must hold, by harness.
	Keys map[string][]agentwire.HomeKey
	// Files gives the product files of a harness home, by path relative to
	// the home. The visor writes a file when its content changes. The
	// function can read the home. It runs on each launch.
	Files func(name, home string) map[string][]byte
}

type Source string

type Terminal interface {
	Start(ctx context.Context, name string, argv []string, dir string, env map[string]string) (string, error)
	// Screen gives the screen text and whether the session still runs.
	Screen(ctx context.Context, id string) (string, bool, error)
	Send(ctx context.Context, id, text string) error
	Stop(ctx context.Context, id string) error
}

type Update struct {
	At    time.Time `json:"at"`
	From  string    `json:"from,omitempty"`
	To    string    `json:"to,omitempty"`
	OK    bool      `json:"ok"`
	Error string    `json:"error,omitempty"`
	// Outside means that the harness changed outside the visor.
	Outside bool `json:"outside,omitempty"`
}

type UpdateMode string

type Wire interface {
	Detect(ctx context.Context, h agentwire.Harness) (agentwire.Detection, error)
	Version(ctx context.Context, bin string) string
	Models(ctx context.Context, h agentwire.Harness, q agentwire.ModelQuery) ([]agentwire.ModelInfo, error)
	LatestVersion(ctx context.Context, h agentwire.Harness) (string, error)
	InvalidateModels(h agentwire.Harness)
}