Google IDX Live icon

Google IDX Live

Google IDX Live

Overview

This node, named "Google IDX Live," interacts with Google IDX workspaces through browser automation using Puppeteer. It supports multiple operations related to managing and interacting with Google IDX workspaces, including running commands inside a workspace, creating new workspaces, checking live status, resetting workspaces, listing all workspaces, and running workspaces with optional screenshot capture.

A key feature is the ability to connect to a remote browser instance via WebSocket endpoints, automate UI interactions, and capture screenshots of workspace states. This makes it useful for scenarios such as:

  • Automating command execution in Google IDX environments.
  • Monitoring workspace statuses and live device information.
  • Managing workspace lifecycle (create, reset).
  • Capturing visual snapshots of workspace states for auditing or reporting.

Practical examples:

  • Running a shell command inside a specific Google IDX workspace remotely.
  • Checking which devices are currently online/offline in a workspace.
  • Creating a new workspace programmatically.
  • Resetting one or more workspaces and confirming their reset status.
  • Taking screenshots of workspaces for documentation or troubleshooting.

Properties

Name Meaning
WorkSpace Name The name of the Google IDX workspace to target. Required for createWorkSpace and runCommand operations.
Cookie WebSocket Endpoint The WebSocket endpoint URL used for cookie-based authentication when running commands. Required for runCommand.
Command The command string to execute inside the targeted workspace. Required for runCommand.
Options Additional options as a collection:
- Browser WebSocket Endpoint The WebSocket endpoint URL to connect to a remote browser instance. Used for most operations except checkLive.

Output

The node outputs JSON data describing the results of the selected operation. The structure varies by operation:

  • For runCommand, the output includes the profile info and may include a screenshot image of the workspace terminal session in binary form.
  • For workspace management operations (newWorkSpace, resetWorkSpace, runWorkSpace), the output contains details about workspaces such as IDs, names, URLs, tokens, account info, and optionally screenshots.
  • For checkLive, the output provides arrays of device statuses, hostnames, IPs, last seen timestamps, grouped according to user parameters.
  • For other operations like allWorkSpaces, the output lists available workspaces with metadata.

If screenshots are captured, they are provided as binary data with MIME type image/png.

Dependencies

  • Requires an API key credential for authenticating with Google IDX services.
  • Uses Puppeteer Extra with the Stealth plugin to automate Chromium browsers.
  • Requires access to remote browser WebSocket endpoints for connecting to browser instances.
  • Network access to Google IDX URLs and related Google services.
  • Node environment must support Puppeteer and its dependencies.

Troubleshooting

  • Failed to launch/connect to browser: Indicates issues connecting to the specified browser WebSocket endpoint. Verify the endpoint URL and network connectivity.
  • Timeouts waiting for page elements: May occur if Google IDX pages change or load slowly. Adjust wait times or verify selectors.
  • Errors capturing screenshots or detached frames: Can happen if the browser page closes unexpectedly or loses connection. Retrying the operation often helps.
  • Missing credentials or tokens: The node requires valid API credentials and cookies; ensure these are configured correctly.
  • WebSocket disconnections during long operations: The node attempts reconnects but persistent failures require checking the stability of the remote browser service.

Links and References

Discussion