skills/actionbook__actionbook
1
0
Fork 0
mirror of https://github.com/actionbook/actionbook.git synced 2026-09-19 03:28:06 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: expand auto-connect into step-by-step usage guide

Browse Source 
Add Chrome startup commands (macOS/Linux/Windows), attach workflow,
detach semantics, and troubleshooting to browser.mdx, cli.mdx, and
command-reference.md. Emphasizes that auto-connect is attach-to-existing,
not auto-launch.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Asen's Agent
2026-04-17 23:40:47 +08:00
parent 309828efb9
commit c7766c8da8
3 changed files with 74 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api-reference/cli.mdx
+6 -1
View File
@@ -142,7 +142,12 @@ actionbook browser start --auto-connect --session s1
``` ```
<Note> <Note>
`--auto-connect` discovers a locally running Chrome by reading Chrome's `DevToolsActivePort` file, then probing ports `[9222, 9229]`. It is mutually exclusive with `--cdp-endpoint`, `-p/--provider`, `--mode cloud`, and `--mode extension`. `browser close` only detaches the session — it does not kill the external Chrome process. Error codes: `CHROME_AUTO_CONNECT_NOT_FOUND`, `CHROME_CDP_UNREACHABLE`. `--auto-connect` attaches to a Chrome you've started with remote debugging enabled:
```bash
google-chrome --remote-debugging-port=9222 # Linux
# macOS: /Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --remote-debugging-port=9222
```
Actionbook discovers Chrome by reading the `DevToolsActivePort` file, then probing ports `[9222, 9229]`. Mutually exclusive with `--cdp-endpoint`, `-p/--provider`, `--mode cloud`, and `--mode extension`. `browser close` only detaches — it does not kill the external Chrome. Error codes: `CHROME_AUTO_CONNECT_NOT_FOUND`, `CHROME_CDP_UNREACHABLE`. See [Attach to a Running Chrome](/guides/browser#attach-to-a-running-chrome-auto-connect) for a step-by-step guide.
</Note> </Note>
<Note> <Note>
docs/guides/browser.mdx
+45 -7
View File
@@ -42,17 +42,55 @@ When done, close the browser:
actionbook browser close --session s1 actionbook browser close --session s1
``` ```
### Attach to a Running Chrome ### Attach to a Running Chrome (Auto-Connect)
If Chrome is already running with remote debugging enabled, use `--auto-connect` to attach without launching a new instance: Use `--auto-connect` to attach to a Chrome instance you've already started — useful when you need your existing login sessions, extensions, or a specific Chrome configuration.
```bash <Steps>
actionbook browser start --auto-connect --session s1 <Step title="Start Chrome with remote debugging enabled">
actionbook browser snapshot --session s1 --tab t1 ```bash
``` # macOS
/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --remote-debugging-port=9222
# Linux
google-chrome --remote-debugging-port=9222
# Windows
"C:\Program Files\Google\Chrome\Application\chrome.exe" --remote-debugging-port=9222
```
You can also add `--user-data-dir=/tmp/chrome-debug` for a clean profile, or omit it to use your default profile with all your logged-in sessions.
</Step>
<Step title="Attach Actionbook to the running Chrome">
```bash
actionbook browser start --auto-connect --session s1
```
Actionbook auto-discovers the running Chrome by reading the `DevToolsActivePort` file, then probing ports `[9222, 9229]`. No manual endpoint configuration needed.
</Step>
<Step title="Use browser commands as usual">
```bash
actionbook browser list-tabs --session s1
actionbook browser snapshot --session s1 --tab t1
actionbook browser click @e5 --session s1 --tab t1
```
All browser commands work the same way. Existing tabs in Chrome are available immediately.
</Step>
<Step title="Detach when done">
```bash
actionbook browser close --session s1
```
This only detaches the Actionbook session — it does **not** kill the external Chrome process. Your Chrome stays running with all tabs intact.
</Step>
</Steps>
<Note> <Note>
`--auto-connect` (env: `ACTIONBOOK_AUTO_CONNECT`) discovers Chrome by reading the `DevToolsActivePort` file, then probing ports `[9222, 9229]`. It is mutually exclusive with `--cdp-endpoint`, `-p/--provider`, `--mode cloud`, and `--mode extension`. `browser close` only detaches the session — it does not kill the external Chrome process. `--auto-connect` (env: `ACTIONBOOK_AUTO_CONNECT`) is mutually exclusive with `--cdp-endpoint`, `-p/--provider`, `--mode cloud`, and `--mode extension`. Error codes: `CHROME_AUTO_CONNECT_NOT_FOUND` (no running Chrome found), `CHROME_CDP_UNREACHABLE` (Chrome found but CDP unreachable — verify `--remote-debugging-port` was set).
</Note> </Note>
## Cloud Providers ## Cloud Providers
skills/actionbook/references/command-reference.md
+23 -1
View File
@@ -56,7 +56,29 @@ actionbook browser restart --session s1 # Restart a session
Supported cloud providers: `driver` (`DRIVER_API_KEY`), `hyperbrowser` (`HYPERBROWSER_API_KEY`), `browseruse` (`BROWSER_USE_API_KEY`). `-p` is mutually exclusive with `--cdp-endpoint` and `--mode local/extension`. Supported cloud providers: `driver` (`DRIVER_API_KEY`), `hyperbrowser` (`HYPERBROWSER_API_KEY`), `browseruse` (`BROWSER_USE_API_KEY`). `-p` is mutually exclusive with `--cdp-endpoint` and `--mode local/extension`.
`--auto-connect` (env: `ACTIONBOOK_AUTO_CONNECT`) auto-discovers a locally running Chrome with remote debugging enabled. Discovery order: Chrome's `DevToolsActivePort` file, then probe ports `[9222, 9229]`. Mutually exclusive with `--cdp-endpoint`, `-p/--provider`, `--mode cloud`, and `--mode extension`. `browser close` only detaches — it does not kill the external Chrome. Error codes: `CHROME_AUTO_CONNECT_NOT_FOUND` (no Chrome found), `CHROME_CDP_UNREACHABLE` (port found but CDP unreachable). `--auto-connect` (env: `ACTIONBOOK_AUTO_CONNECT`) attaches to a Chrome you've started with remote debugging enabled. **Prerequisite**: start Chrome with `--remote-debugging-port`:
```bash
# macOS
/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --remote-debugging-port=9222
# Linux
google-chrome --remote-debugging-port=9222
# Windows
"C:\Program Files\Google\Chrome\Application\chrome.exe" --remote-debugging-port=9222
```
Then attach:
```bash
actionbook browser start --auto-connect --session s1
actionbook browser list-tabs --session s1 # See existing Chrome tabs
actionbook browser snapshot --session s1 --tab t1
actionbook browser close --session s1 # Detach only — Chrome stays running
```
Discovery order: Chrome's `DevToolsActivePort` file, then probe ports `[9222, 9229]`. Mutually exclusive with `--cdp-endpoint`, `-p/--provider`, `--mode cloud`, and `--mode extension`. Error codes: `CHROME_AUTO_CONNECT_NOT_FOUND` (no Chrome found), `CHROME_CDP_UNREACHABLE` (port found but CDP unreachable).
## Tab ## Tab