cyrus-and/chrome-remote-interface
Chrome Remote Interface
This project is a Node.js library and browser automation framework that provides a JavaScript interface for the Chrome DevTools Protocol. It functions as a headless browser controller, enabling the programmatic management of browser targets, the execution of scripts, and the monitoring of network activity via WebSocket connections.
The interface includes an interactive shell and REPL for real-time command execution and event binding. It also provides utilities for retrieving protocol descriptors and inspecting embedded documentation to identify available commands and parameter types.
The library covers a broad range of automation capabilities, including remote browser debugging, headless browser testing, and real-time web application monitoring. It manages the full lifecycle of browser interaction, from HTTP-based target discovery to event-driven notification routing and promise-wrapped command dispatching.
Features
- Chrome Debugging Interfaces - A JavaScript wrapper for interacting with the Chrome Debugging Protocol to manage browser targets and inspect state.
- Browser Debugging Protocols - Provides a programmatic interface for manipulating and inspecting browser engine states via the Chrome Debugging Protocol.
- DevTools Protocol Clients - Implements a client that communicates with browsers via the Chrome DevTools Protocol to control page behavior and network traffic.
- System Command Dispatchers - Implements a system for dispatching parameterized commands to remote browser instances and handling responses.
- Protocol Event Handlers - Provides mechanisms to bind custom logic to specific domain events and notifications from the remote browser.
- Browser Automation Frameworks - Provides a framework for programmatic control of browser navigation, script execution, and network monitoring.
- Browser Event Listeners - Provides a subscription system to monitor and react to native browser state and protocol events.
- Headless Browser Controllers - Acts as a control layer for managing headless browser instances and their tabs using the standard debugging protocol.
- Remote Browser Connections - Establishes WebSocket connections to browsers or applications implementing the Chrome Debugging Protocol.
- RPC Over WebSocket - Implements RPC-style command invocation over persistent WebSocket connections to control browser instances.
- Browser - Enables connecting an external Node.js environment to a live browser to inspect state and trigger commands.
- Browser REPLs - Includes a real-time REPL for executing commands and debugging live browser state.
- Interactive Shells - Ships an interactive command-line shell for sending manual protocol messages and evaluating code in real time.
- Protocol Descriptor Retrievals - Includes utilities to retrieve protocol descriptors from remote instances or local files for command inspection.
- Protocol Metadata Inspection - Provides utilities for loading protocol descriptors to inspect available commands and expected parameter types.
- Browser Target Discovery - Provides utilities to discover and select active browser tabs and workers via the browser's HTTP frontend.
- Target Lifecycle Management - Enables programmatic creation and management of multiple browser tabs and targets through a single connection.
- Host-to-Instance Command Execution - Provides an interactive shell to execute commands and bind events within a running browser instance.
- Headless Browser Controllers - Provides the runtime control needed to execute automated tests against headless browser instances.
- Web Monitoring - Allows real-time tracking of web page behavior by subscribing to browser events and network notifications.
- Chromium Drivers - Node.js interface for the Chrome Debugging Protocol.
- Protocol Infrastructure - Library for interacting with the browser via the protocol.
