screenshot

package
v0.31.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 31, 2026 License: MIT Imports: 14 Imported by: 0

Documentation

Overview

Package screenshot registers the take_screenshot tool. The captured PNG is returned as an image MessagePart on ToolResult.OutputParts so memory plugins forward it to the next LLM turn alongside any text.

Capture path is platform-specific and shells out to a tool that ships with the OS or is commonly preinstalled:

  • darwin: screencapture -t png -x <tmpfile>
  • linux: gnome-screenshot -f <tmpfile>, then grim, then ImageMagick's `import -window root <tmpfile>` as fallbacks.

All other platforms surface a "screenshot not supported on this platform" error from the tool result, leaving the agent free to recover.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New() engine.Plugin

New returns a fresh screenshot plugin.

Types

type Plugin

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

Plugin implements the take_screenshot tool.

func (*Plugin) Capabilities

func (p *Plugin) Capabilities() []engine.Capability

func (*Plugin) ConfigSchema

func (p *Plugin) ConfigSchema() []byte

ConfigSchema implements engine.ConfigSchemaProvider.

func (*Plugin) Dependencies

func (p *Plugin) Dependencies() []string

func (*Plugin) Emissions

func (p *Plugin) Emissions() []string

func (*Plugin) ID

func (p *Plugin) ID() string

func (*Plugin) Init

func (p *Plugin) Init(ctx engine.PluginContext) error

func (*Plugin) LiveCalls

func (p *Plugin) LiveCalls() uint64

LiveCalls returns the count of take_screenshot invocations that survived the replay short-circuit. Tests assert zero during replay.

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) Ready

func (p *Plugin) Ready() error

func (*Plugin) Requires

func (p *Plugin) Requires() []engine.Requirement

func (*Plugin) Shutdown

func (p *Plugin) Shutdown(_ context.Context) error

func (*Plugin) Subscriptions

func (p *Plugin) Subscriptions() []engine.EventSubscription

func (*Plugin) Version

func (p *Plugin) Version() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL