olympus

Sep 23, 2026

Changes in this version

+ func ResolvedBackendOf(err error) (backend.Name, bool)

+ type ExitReading struct

+ ExitCode *int

+ Found bool

+ Warnings []Warning

type Session

+ func (s *Session) ReadExitStatus(ctx context.Context, marker string, lines int) (ExitReading, error)

Sep 19, 2026

Changes in this version

+ const DefaultScrollLines

Sep 17, 2026

Changes in this version

+ func TypedOf(err error) bool

Sep 17, 2026

Changes in this version

+ var ErrBlocked = backend.ErrBlocked

Sep 15, 2026

Changes in this version

type AttachOption — darwin/amd64, linux/amd64

+ func BareClientTag(tag string) AttachOption

+ type ClientsOption func(*clientsOpts)

+ func WithClientTag(tag string) ClientsOption

type Olympus

+ func (o *Olympus) Clients(ctx context.Context, opts ...ClientsOption) ([]backend.Client, error)

Sep 10, 2026

Changes in this version

type Olympus

+ func (o *Olympus) StartServer(ctx context.Context, name string) (StartedServer, error)

+ type StartedServer struct

+ Name string

+ Outcome string

Sep 9, 2026

Changes in this version

+ type AgentOption func(*agentOpts)

+ func WithLast() AgentOption

Sep 5, 2026

Changes in this version

+ func Kinds() []backend.AgentKind

Sep 4, 2026

Changes in this version

type Olympus

+ func (o *Olympus) Agents(ctx context.Context) ([]backend.Agent, error)

Sep 3, 2026

Changes in this version

type Info

+ Prefix string

Sep 3, 2026

Changes in this version

type Olympus

+ func (o *Olympus) Rename(ctx context.Context, target, name string) error

Sep 3, 2026

Changes in this version

type Olympus

+ func (o *Olympus) Focus(ctx context.Context, target string) error

type Session

+ func (s *Session) Focus(ctx context.Context) error

Sep 3, 2026

Changes in this version

type AttachOption — darwin/amd64, linux/amd64

+ func BareViewName(name string) AttachOption

+ func BareWithoutMouse() AttachOption

Sep 3, 2026

Changes in this version

type Olympus

+ func (o *Olympus) FocusView(ctx context.Context, view string, col, row int) (string, error)

Sep 3, 2026

Changes in this version

type Olympus

+ func (o *Olympus) Servers(ctx context.Context) ([]backend.Server, error)

+ func (o *Olympus) StopServer(ctx context.Context, name string) (StoppedServer, error)

type Option

+ func WithServer(name string) Option

+ type StoppedServer struct

+ Name string

+ Outcome string

type ViewOption

+ func WithViewWindow(window string) ViewOption

Sep 2, 2026

Changes in this version

type AttachOption — darwin/amd64, linux/amd64

+ func AsBare() AttachOption

+ func WithSessionClient() AttachOption

type Olympus

+ func (o *Olympus) OpenSessionName(name string) *Session

Sep 2, 2026

Changes in this version

type Result

+ Warnings []Warning

Aug 27, 2026

Changes in this version

type Session

+ func (s *Session) TypeAndSubmit(ctx context.Context, text string) error

Aug 17, 2026

Changes in this version

+ const BackendEnv

+ const DefaultCols

+ const DefaultLockWait

+ const DefaultRows

+ const DefaultRunPoll

+ const DefaultRunTimeout

+ const DefaultVerifyBudget

+ const DefaultVerifyPoll

+ const DefaultWaitPoll

+ const DefaultWaitTimeout

+ const LockWaitEnv

+ const WarningDegraded

+ var ErrConflict = backend.ErrConflict

+ var ErrNotFound = backend.ErrNotFound

+ var ErrTimeout = backend.ErrTimeout

+ var ErrUnavailable = backend.ErrUnavailable

+ var ErrUnsupported = backend.ErrUnsupported

+ var ErrUsage = backend.ErrUsage

+ var Version = "0.1.0-dev"

+ func CodeOf(err error) backend.Code

+ func ExitCode(code backend.Code) int

+ type AttachOption func(*backend.AttachSpec) — darwin/amd64, linux/amd64

+ func AsViewer() AttachOption

+ func AttachSize(cols, rows int) AttachOption

+ func KeepOtherClients() AttachOption

+ type BackendReport struct

+ BelowFloor bool

+ Capabilities backend.Capabilities

+ Floor string

+ Installed bool

+ Isolation string

+ Managed map[string]string

+ Name backend.Name

+ Problem string

+ Version string

+ type Diagnosis struct

+ Backends []BackendReport

+ InstallHints []string

+ Resolved ResolvedReport

+ func Diagnose(ctx context.Context, opts ...Option) Diagnosis

+ type Identity struct

+ Backend backend.Name

+ Inside bool

+ Nested []backend.Name

+ Scope string

+ Session string

+ func Self(ctx context.Context) (Identity, error)

+ type Info struct

+ Capabilities backend.Capabilities

+ Panes []backend.Pane

+ Session *backend.Session

+ State backend.State

+ Warnings []Warning

+ func (i Info) MarshalJSON() ([]byte, error)

+ type Job struct

+ func (j *Job) ID() string

+ func (j *Job) Poll(ctx context.Context, opts ...RunOption) (PollResult, error)

+ type Olympus struct

+ func Open(opts ...Option) (*Olympus, error)

+ func (o *Olympus) Backend() backend.Name

+ func (o *Olympus) Capabilities() backend.Capabilities

+ func (o *Olympus) Close() error

+ func (o *Olympus) Create(ctx context.Context, name string, opts ...SessionOption) (*Session, error)

+ func (o *Olympus) CreateView(ctx context.Context, base string, opts ...ViewOption) (backend.View, error)

+ func (o *Olympus) Info(ctx context.Context, target string) (Info, error)

+ func (o *Olympus) Open(ctx context.Context, target string) (*Session, error)

+ func (o *Olympus) PaneWarnings() []Warning

+ func (o *Olympus) Panes(ctx context.Context, target string) ([]backend.Pane, error)

+ func (o *Olympus) Raw() backend.Backend

+ func (o *Olympus) Resolution() Resolution

+ func (o *Olympus) RunOnce(ctx context.Context, command string, opts ...SessionOption) (Result, []Warning, error)

+ func (o *Olympus) Screens(ctx context.Context, targets []string, opts ...ScreenOption) (Screens, error)

+ func (o *Olympus) ScrollView(ctx context.Context, view string, lines int) error

+ func (o *Olympus) ServerEnv(ctx context.Context, key string) (string, bool, error)

+ func (o *Olympus) Session(ctx context.Context, name string, opts ...SessionOption) (*Session, error)

+ func (o *Olympus) Sessions(ctx context.Context) ([]backend.Session, error)

+ func (o *Olympus) SizeWarnings() []Warning

+ func (o *Olympus) Stop(ctx context.Context, target string, opts ...StopOption) (Stopped, error)

+ func (o *Olympus) Views(ctx context.Context, base string) ([]backend.View, error)

+ type Option func(*config)

+ func WithBackend(name string) Option

+ func WithLockWait(d time.Duration) Option

+ func WithSocket(name string) Option

+ func WithSocketPath(path string) Option

+ func WithZmxDir(dir string) Option

+ func WithoutLock() Option

+ type PollResult struct

+ ExitCode *int

+ Output string

+ Reason string

+ State string

+ Status backend.Liveness

+ Warnings []Warning

+ type Reason string

+ const ReasonDefault

+ const ReasonEnv

+ const ReasonFallback

+ const ReasonFlag

+ type Resolution struct

+ Backend backend.Name

+ Reason Reason

+ type ResolvedReport struct

+ Backend backend.Name

+ Effective map[string]string

+ Pinned bool

+ Problem string

+ Reason Reason

+ Scope string

+ type Result struct

+ ExitCode int

+ Output string

+ type RunOption func(*engine.Runner)

+ func PollWindow(lines int) RunOption

+ func RunInterval(d time.Duration) RunOption

+ func RunTimeout(d time.Duration) RunOption

+ type Screen struct

+ Line string

+ Matched bool

+ Meta backend.ScreenMeta

+ Text string

+ Warnings []Warning

+ type ScreenOption func(*backend.ScreenOpts)

+ func WithColors() ScreenOption

+ func WithHistory(lines int) ScreenOption

+ type Screens struct

+ Meta map[string]backend.ScreenMeta

+ Screens map[string]string

+ Warnings []Warning

+ func (s Screens) MarshalJSON() ([]byte, error)

+ type SendOption func(*sendConfig)

+ func VerifyBudget(d time.Duration) SendOption

+ func WithoutSubmit() SendOption

+ type Session struct

+ func (s *Session) Attach(ctx context.Context, in, out *os.File, errOut *os.File, opts ...AttachOption) (int, error)

+ func (s *Session) Exec(ctx context.Context, command string, opts ...RunOption) (Result, error)

+ func (s *Session) ExitStatus(ctx context.Context, marker string, lines int) (int, bool, error)

+ func (s *Session) Name() string

+ func (s *Session) Outcome() backend.Outcome

+ func (s *Session) Paste(ctx context.Context, text string) error

+ func (s *Session) PasteAndSubmit(ctx context.Context, text string) error

+ func (s *Session) Poll(ctx context.Context, id string, opts ...RunOption) (PollResult, error)

+ func (s *Session) Press(ctx context.Context, keys ...backend.Key) error

+ func (s *Session) Row() backend.Session

+ func (s *Session) Screen(ctx context.Context, opts ...ScreenOption) (Screen, error)

+ func (s *Session) Send(ctx context.Context, text string, opts ...SendOption) error

+ func (s *Session) SendAtomic(ctx context.Context, text string) error

+ func (s *Session) SetStatus(ctx context.Context, status string) error

+ func (s *Session) Start(ctx context.Context, command string, opts ...RunOption) (*Job, error)

+ func (s *Session) Status(ctx context.Context) (string, error)

+ func (s *Session) Stop(ctx context.Context, opts ...StopOption) (Stopped, error)

+ func (s *Session) Submit(ctx context.Context) error

+ func (s *Session) Type(ctx context.Context, text string) error

+ func (s *Session) WaitFor(ctx context.Context, pattern string, opts ...WaitOption) (Screen, error)

+ func (s *Session) WaitForStatus(ctx context.Context, want string, opts ...WaitOption) (string, error)

+ func (s *Session) Watch(ctx context.Context, out io.Writer) error

+ type SessionOption func(*backend.CreateSpec)

+ func Command(argv ...string) SessionOption

+ func In(dir string) SessionOption

+ func KeepCorpse() SessionOption

+ func Size(cols, rows int) SessionOption

+ type Started struct

+ CommandID string

+ type StopOption func(*engine.KillPolicy)

+ func Force() StopOption

+ func InterruptTimeout(d time.Duration) StopOption

+ func Presses(n int) StopOption

+ type Stopped struct

+ Outcome string

+ Warnings []Warning

+ type ViewOption func(*backend.ViewSpec)

+ func WithViewName(name string) ViewOption

+ func WithoutMouse() ViewOption

+ type WaitOption func(*waitConfig)

+ func WaitInterval(d time.Duration) WaitOption

+ func WaitTimeout(d time.Duration) WaitOption

+ type Warning struct

+ Code string

+ Message string