leeguooooo
61060486f4
Release binaries / Build macOS ARM64 (push) Has been cancelled
Release binaries / Build macOS x64 (push) Has been cancelled
Release binaries / Build Linux ARM64 (push) Has been cancelled
Release binaries / Build Linux musl ARM64 (push) Has been cancelled
Release binaries / Build Linux musl x64 (push) Has been cancelled
Release binaries / Build Linux x64 (push) Has been cancelled
Release binaries / Build Windows x64 (push) Has been cancelled
Release binaries / Attach binaries to GitHub Release (push) Has been cancelled
Standalone product rename across the whole repo (issue: project identity): - Binary/package/repo/skill/docs: agent-browser[-stealth] → chrome-use (single binary name `chrome-use`; old aliases agent-browser/abs dropped). - Version: 0.27.0-fork.51 → 1.0.0 (drop the upstream-fork counter). - Native-messaging host: com.agent_browser.connect → com.leeguoo.chrome_use (CLI + ab-connect extension in lockstep — this is a breaking handshake change, extension bumped 0.4.2 → 0.5.0, needs a Web Store republish). - Config dir: ~/.agent-browser → ~/.chrome-use. - README/zh: reframed from "stealth fork of agent-browser" to a standalone product with a small `originally based on vercel-labs/agent-browser` credit. - Kept AGENT_BROWSER_* env vars working (63 vars across the codebase; renaming them would break every existing script/skill for no user-facing gain). Build green, 802 unit tests pass, fmt + clippy clean. Upstream attribution to vercel-labs/agent-browser preserved.
237 lines
6.5 KiB
Markdown
237 lines
6.5 KiB
Markdown
---
|
|
name: electron
|
|
description: Automate Electron desktop apps (VS Code, Slack, Discord, Figma, Notion, Spotify, etc.) using chrome-use via Chrome DevTools Protocol. Use when the user needs to interact with an Electron app, automate a desktop app, connect to a running app, control a native app, or test an Electron application. Triggers include "automate Slack app", "control VS Code", "interact with Discord app", "test this Electron app", "connect to desktop app", or any task requiring automation of a native Electron application.
|
|
allowed-tools: Bash(chrome-use:*), Bash(chrome-use:*), Bash(abs:*), Bash(npx chrome-use:*), Bash(npx chrome-use:*)
|
|
---
|
|
|
|
# Electron App Automation
|
|
|
|
Automate any Electron desktop app using chrome-use. Electron apps are built on Chromium and expose a Chrome DevTools Protocol (CDP) port that chrome-use can connect to, enabling the same snapshot-interact workflow used for web pages.
|
|
|
|
## Core Workflow
|
|
|
|
1. **Launch** the Electron app with remote debugging enabled
|
|
2. **Connect** chrome-use to the CDP port
|
|
3. **Snapshot** to discover interactive elements
|
|
4. **Interact** using element refs
|
|
5. **Re-snapshot** after navigation or state changes
|
|
|
|
```bash
|
|
# Launch an Electron app with remote debugging
|
|
open -a "Slack" --args --remote-debugging-port=9222
|
|
|
|
# Connect chrome-use to the app
|
|
chrome-use connect 9222
|
|
|
|
# Standard workflow from here
|
|
chrome-use snapshot -i
|
|
chrome-use click @e5
|
|
chrome-use screenshot slack-desktop.png
|
|
```
|
|
|
|
## Launching Electron Apps with CDP
|
|
|
|
Every Electron app supports the `--remote-debugging-port` flag since it's built into Chromium.
|
|
|
|
### macOS
|
|
|
|
```bash
|
|
# Slack
|
|
open -a "Slack" --args --remote-debugging-port=9222
|
|
|
|
# VS Code
|
|
open -a "Visual Studio Code" --args --remote-debugging-port=9223
|
|
|
|
# Discord
|
|
open -a "Discord" --args --remote-debugging-port=9224
|
|
|
|
# Figma
|
|
open -a "Figma" --args --remote-debugging-port=9225
|
|
|
|
# Notion
|
|
open -a "Notion" --args --remote-debugging-port=9226
|
|
|
|
# Spotify
|
|
open -a "Spotify" --args --remote-debugging-port=9227
|
|
```
|
|
|
|
### Linux
|
|
|
|
```bash
|
|
slack --remote-debugging-port=9222
|
|
code --remote-debugging-port=9223
|
|
discord --remote-debugging-port=9224
|
|
```
|
|
|
|
### Windows
|
|
|
|
```bash
|
|
"C:\Users\%USERNAME%\AppData\Local\slack\slack.exe" --remote-debugging-port=9222
|
|
"C:\Users\%USERNAME%\AppData\Local\Programs\Microsoft VS Code\Code.exe" --remote-debugging-port=9223
|
|
```
|
|
|
|
**Important:** If the app is already running, quit it first, then relaunch with the flag. The `--remote-debugging-port` flag must be present at launch time.
|
|
|
|
## Connecting
|
|
|
|
```bash
|
|
# Connect to a specific port
|
|
chrome-use connect 9222
|
|
|
|
# Or use --cdp on each command
|
|
chrome-use --cdp 9222 snapshot -i
|
|
|
|
# Auto-discover a running Chromium-based app
|
|
chrome-use --auto-connect snapshot -i
|
|
```
|
|
|
|
After `connect`, all subsequent commands target the connected app without needing `--cdp`.
|
|
|
|
## Tab Management
|
|
|
|
Electron apps often have multiple windows or webviews. Use tab commands to list and switch between them:
|
|
|
|
```bash
|
|
# List all available targets (windows, webviews, etc.)
|
|
chrome-use tab
|
|
|
|
# Switch to a specific tab by id (t1, t2, …; integers not accepted)
|
|
chrome-use tab t2
|
|
|
|
# Switch by URL pattern
|
|
chrome-use tab --url "*settings*"
|
|
```
|
|
|
|
## Webview Support
|
|
|
|
Electron `<webview>` elements are automatically discovered and can be controlled like regular pages. Webviews appear as separate targets in the tab list with `type: "webview"`:
|
|
|
|
```bash
|
|
# Connect to running Electron app
|
|
chrome-use connect 9222
|
|
|
|
# List targets -- webviews appear alongside pages
|
|
chrome-use tab
|
|
# Example output:
|
|
# 0: [page] Slack - Main Window https://app.slack.com/
|
|
# 1: [webview] Embedded Content https://example.com/widget
|
|
|
|
# Switch to a webview
|
|
chrome-use tab t1
|
|
|
|
# Interact with the webview normally
|
|
chrome-use snapshot -i
|
|
chrome-use click @e3
|
|
chrome-use screenshot webview.png
|
|
```
|
|
|
|
**Note:** Webview support works via raw CDP connection.
|
|
|
|
## Common Patterns
|
|
|
|
### Inspect and Navigate an App
|
|
|
|
```bash
|
|
open -a "Slack" --args --remote-debugging-port=9222
|
|
sleep 3 # Wait for app to start
|
|
chrome-use connect 9222
|
|
chrome-use snapshot -i
|
|
# Read the snapshot output to identify UI elements
|
|
chrome-use click @e10 # Navigate to a section
|
|
chrome-use snapshot -i # Re-snapshot after navigation
|
|
```
|
|
|
|
### Take Screenshots of Desktop Apps
|
|
|
|
```bash
|
|
chrome-use connect 9222
|
|
chrome-use screenshot app-state.png
|
|
chrome-use screenshot --full full-app.png
|
|
chrome-use screenshot --annotate annotated-app.png
|
|
```
|
|
|
|
### Extract Data from a Desktop App
|
|
|
|
```bash
|
|
chrome-use connect 9222
|
|
chrome-use snapshot -i
|
|
chrome-use get text @e5
|
|
chrome-use snapshot --json > app-state.json
|
|
```
|
|
|
|
### Fill Forms in Desktop Apps
|
|
|
|
```bash
|
|
chrome-use connect 9222
|
|
chrome-use snapshot -i
|
|
chrome-use fill @e3 "search query"
|
|
chrome-use press Enter
|
|
chrome-use wait 1000
|
|
chrome-use snapshot -i
|
|
```
|
|
|
|
### Run Multiple Apps Simultaneously
|
|
|
|
Use named sessions to control multiple Electron apps at the same time:
|
|
|
|
```bash
|
|
# Connect to Slack
|
|
chrome-use --session slack connect 9222
|
|
|
|
# Connect to VS Code
|
|
chrome-use --session vscode connect 9223
|
|
|
|
# Interact with each independently
|
|
chrome-use --session slack snapshot -i
|
|
chrome-use --session vscode snapshot -i
|
|
```
|
|
|
|
## Color Scheme
|
|
|
|
The default color scheme when connecting via CDP may be `light`. To preserve dark mode:
|
|
|
|
```bash
|
|
chrome-use connect 9222
|
|
chrome-use --color-scheme dark snapshot -i
|
|
```
|
|
|
|
Or set it globally:
|
|
|
|
```bash
|
|
AGENT_BROWSER_COLOR_SCHEME=dark chrome-use connect 9222
|
|
```
|
|
|
|
## Troubleshooting
|
|
|
|
### "Connection refused" or "Cannot connect"
|
|
|
|
- Make sure the app was launched with `--remote-debugging-port=NNNN`
|
|
- If the app was already running, quit and relaunch with the flag
|
|
- Check that the port isn't in use by another process: `lsof -i :9222`
|
|
|
|
### App launches but connect fails
|
|
|
|
- Wait a few seconds after launch before connecting (`sleep 3`)
|
|
- Some apps take time to initialize their webview
|
|
|
|
### Elements not appearing in snapshot
|
|
|
|
- The app may use multiple webviews. Use `chrome-use tab` to list targets and switch to the right one
|
|
|
|
### Cannot type in input fields
|
|
|
|
- Try `chrome-use keyboard type "text"` to type at the current focus without a selector
|
|
- Some Electron apps use custom input components; use `chrome-use keyboard inserttext "text"` to bypass key events
|
|
|
|
## Supported Apps
|
|
|
|
Any app built on Electron works, including:
|
|
|
|
- **Communication:** Slack, Discord, Microsoft Teams, Signal, Telegram Desktop
|
|
- **Development:** VS Code, GitHub Desktop, Postman, Insomnia
|
|
- **Design:** Figma, Notion, Obsidian
|
|
- **Media:** Spotify, Tidal
|
|
- **Productivity:** Todoist, Linear, 1Password
|
|
|
|
If an app is built with Electron, it supports `--remote-debugging-port` and can be automated with chrome-use.
|