Capture a screenshot of the user's screen.

Returns the image so you can see what the user sees.

Parameters

monitor: Which monitor to capture. 0 = all monitors combined into one image, 1 = primary monitor, 2 = second monitor, etc. Use list_monitors first if you're unsure. max_width: Maximum width in pixels. The image is down-scaled (preserving aspect ratio) if it exceeds this. Use 0 to disable.

List available monitors and their geometry.

Returns a list of monitors with their index, position (left, top), and size (width, height). Index 0 is the virtual bounding box that spans all monitors.

Move the mouse cursor to the given screen coordinates.

Parameters

x: Horizontal pixel coordinate. y: Vertical pixel coordinate.

Click the mouse at the given coordinates.

Parameters

x: Horizontal pixel coordinate. -1 = click at current cursor position. y: Vertical pixel coordinate. -1 = click at current cursor position. button: Which button: "left", "right", or "middle". clicks: Number of clicks (1 = single, 2 = double).

Scroll the mouse wheel.

Parameters

amount: Number of scroll "clicks". Positive = scroll up, negative = scroll down. x: Horizontal pixel coordinate. -1 = scroll at current cursor position. y: Vertical pixel coordinate. -1 = scroll at current cursor position.

Get the current mouse cursor position.

Returns {"x": <int>, "y": <int>}.

Type a string of text as keyboard input.

Types the text literally -- special characters are escaped so they are sent as-is.

Parameters

text: The text to type.

Press a key or key combination.

Accepts human-friendly combos. Examples:

• Single keys: "enter", "tab", "escape", "f5", "space"

• Combos: "ctrl+c", "ctrl+shift+t", "alt+f4", "ctrl+a"

Parameters

keys: Key combination string (e.g. "ctrl+c", "enter", "alt+tab").

List all visible windows on the desktop.

Returns a list of window objects with: hwnd (window handle), title, process_name, pid, class_name, state (normal/minimized/maximized), left, top, width, height.

Use hwnd to identify a window for other window tools.

Bring a window to the foreground and give it focus.

Parameters

hwnd: The window handle (from list_windows).

Change a window's display state (minimize, maximize, restore, etc.).

Parameters

hwnd: The window handle (from list_windows). state: One of "minimize", "maximize", "restore", "hide", "show".

Move and/or resize a window.

Pass -1 for any parameter to keep its current value.

Parameters

hwnd: The window handle. x: New left edge in pixels (-1 = keep current). y: New top edge in pixels (-1 = keep current). width: New width in pixels (-1 = keep current). height: New height in pixels (-1 = keep current).

Resize a window without moving it.

Pass -1 for either dimension to keep its current value.

Parameters

hwnd: The window handle. width: New width in pixels (-1 = keep current). height: New height in pixels (-1 = keep current).

Get information about the currently focused window.

Returns hwnd, title, process_name, pid.

Gracefully close a window (sends WM_CLOSE).

The application may prompt the user to save before closing.

Parameters

hwnd: The window handle.

List running processes that have visible windows.

Returns a list with pid, process_name, title, responding (bool), and memory_mb.