agentic-browser 1.0.3 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/AGENTS.md +6 -2
- package/README.md +87 -0
- package/dist/cli/index.mjs +7 -3
- package/dist/index.mjs +1 -1
- package/dist/mcp/index.mjs +1 -1
- package/dist/{runtime-4pX1c4Cs.mjs → runtime-B_7vsUma.mjs} +48 -4
- package/package.json +1 -1
package/AGENTS.md
CHANGED
|
@@ -59,8 +59,10 @@ AgenticBrowserCore → ControlApi → SessionManager → BrowserController (CDP)
|
|
|
59
59
|
```
|
|
60
60
|
|
|
61
61
|
1. `createAgenticBrowserCore()` builds AppContext + ChromeCdpBrowserController
|
|
62
|
-
2.
|
|
63
|
-
3.
|
|
62
|
+
2. `createSession` either launches a new Chrome (`browser.launch()`) or connects to existing one (`browser.connect(cdpUrl)`) based on config
|
|
63
|
+
3. Commands execute via CDP `Runtime.evaluate` on the browser page
|
|
64
|
+
4. Results are recorded as evidence, indexed per-domain for memory search
|
|
65
|
+
5. Connected sessions (pid=0) skip `process.kill` on terminate — the user's browser stays open
|
|
64
66
|
|
|
65
67
|
## Code Conventions
|
|
66
68
|
|
|
@@ -108,6 +110,8 @@ AgenticBrowserCore → ControlApi → SessionManager → BrowserController (CDP)
|
|
|
108
110
|
|
|
109
111
|
- `AGENTIC_BROWSER_LOG_DIR` — base dir for sessions/memory/events (default: `.agentic-browser`)
|
|
110
112
|
- `AGENTIC_BROWSER_CHROME_EXECUTABLE_PATH` — explicit Chrome path (auto-discovered if not set)
|
|
113
|
+
- `AGENTIC_BROWSER_CDP_URL` — connect to an already-running Chrome via CDP (e.g. `http://127.0.0.1:9222`)
|
|
114
|
+
- `AGENTIC_BROWSER_USER_PROFILE` — use real Chrome profile (`default`, `true`, or absolute path)
|
|
111
115
|
|
|
112
116
|
## MCP Server
|
|
113
117
|
|
package/README.md
CHANGED
|
@@ -37,12 +37,72 @@ npm run lint
|
|
|
37
37
|
npm test
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
+
## Connect to Existing Chrome / Use Your Profile
|
|
41
|
+
|
|
42
|
+
By default, agentic-browser launches a fresh Chrome instance with an isolated profile. You can instead **connect to an already-running Chrome** or **launch Chrome with your real profile** (bookmarks, cookies, extensions, saved passwords).
|
|
43
|
+
|
|
44
|
+
### Connect to a running Chrome
|
|
45
|
+
|
|
46
|
+
Start Chrome yourself with remote debugging enabled:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
# macOS
|
|
50
|
+
/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --remote-debugging-port=9222
|
|
51
|
+
|
|
52
|
+
# Linux
|
|
53
|
+
google-chrome --remote-debugging-port=9222
|
|
54
|
+
|
|
55
|
+
# Windows
|
|
56
|
+
chrome.exe --remote-debugging-port=9222
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Then connect agentic-browser to it:
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
agentic-browser agent start --cdp-url http://127.0.0.1:9222
|
|
63
|
+
# or low-level:
|
|
64
|
+
agentic-browser session:start --cdp-url http://127.0.0.1:9222
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
When connected this way, stopping the session will **not** kill your Chrome process.
|
|
68
|
+
|
|
69
|
+
### Launch Chrome with your real profile
|
|
70
|
+
|
|
71
|
+
```bash
|
|
72
|
+
# Use your default Chrome profile
|
|
73
|
+
agentic-browser agent start --user-profile default
|
|
74
|
+
|
|
75
|
+
# Use a specific profile directory
|
|
76
|
+
agentic-browser agent start --user-profile /path/to/chrome/profile
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
The default profile path is resolved per platform:
|
|
80
|
+
- **macOS:** `~/Library/Application Support/Google/Chrome`
|
|
81
|
+
- **Linux:** `~/.config/google-chrome`
|
|
82
|
+
- **Windows:** `%LOCALAPPDATA%\Google\Chrome\User Data`
|
|
83
|
+
|
|
84
|
+
### Environment variables
|
|
85
|
+
|
|
86
|
+
Both options can also be set via environment variables:
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
# Connect to existing Chrome
|
|
90
|
+
export AGENTIC_BROWSER_CDP_URL=http://127.0.0.1:9222
|
|
91
|
+
|
|
92
|
+
# Use default Chrome profile (set to "default", "true", or an absolute path)
|
|
93
|
+
export AGENTIC_BROWSER_USER_PROFILE=default
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
CLI flags take precedence over environment variables.
|
|
97
|
+
|
|
40
98
|
## Agent Commands (Recommended for LLMs)
|
|
41
99
|
|
|
42
100
|
The `agent` subcommand manages session state, auto-restarts on disconnect, generates command IDs, and retries failed commands automatically:
|
|
43
101
|
|
|
44
102
|
```bash
|
|
45
103
|
agentic-browser agent start
|
|
104
|
+
agentic-browser agent start --cdp-url http://127.0.0.1:9222
|
|
105
|
+
agentic-browser agent start --user-profile default
|
|
46
106
|
agentic-browser agent status
|
|
47
107
|
agentic-browser agent run navigate '{"url":"https://example.com"}'
|
|
48
108
|
agentic-browser agent run interact '{"action":"click","selector":"#login"}'
|
|
@@ -120,6 +180,8 @@ For direct control without session state management:
|
|
|
120
180
|
|
|
121
181
|
```bash
|
|
122
182
|
agentic-browser session:start
|
|
183
|
+
agentic-browser session:start --cdp-url http://127.0.0.1:9222
|
|
184
|
+
agentic-browser session:start --user-profile default
|
|
123
185
|
```
|
|
124
186
|
|
|
125
187
|
### 2. Read Session Status
|
|
@@ -220,6 +282,31 @@ const memory = core.searchMemory({
|
|
|
220
282
|
await core.stopSession(session.sessionId);
|
|
221
283
|
```
|
|
222
284
|
|
|
285
|
+
### Connect to existing Chrome programmatically
|
|
286
|
+
|
|
287
|
+
```ts
|
|
288
|
+
import { createAgenticBrowserCore } from "agentic-browser";
|
|
289
|
+
|
|
290
|
+
// Connect to a Chrome instance running with --remote-debugging-port=9222
|
|
291
|
+
const core = createAgenticBrowserCore({
|
|
292
|
+
env: { ...process.env, AGENTIC_BROWSER_CDP_URL: "http://127.0.0.1:9222" },
|
|
293
|
+
});
|
|
294
|
+
const session = await core.startSession();
|
|
295
|
+
// session is now controlling the existing Chrome — stopping won't kill it
|
|
296
|
+
```
|
|
297
|
+
|
|
298
|
+
### Use default Chrome profile programmatically
|
|
299
|
+
|
|
300
|
+
```ts
|
|
301
|
+
import { createAgenticBrowserCore } from "agentic-browser";
|
|
302
|
+
|
|
303
|
+
const core = createAgenticBrowserCore({
|
|
304
|
+
env: { ...process.env, AGENTIC_BROWSER_USER_PROFILE: "default" },
|
|
305
|
+
});
|
|
306
|
+
const session = await core.startSession();
|
|
307
|
+
// Chrome launched with your real profile (cookies, bookmarks, extensions)
|
|
308
|
+
```
|
|
309
|
+
|
|
223
310
|
## Documentation
|
|
224
311
|
|
|
225
312
|
```bash
|
package/dist/cli/index.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import { r as createCliRuntime } from "../runtime-
|
|
2
|
+
import { r as createCliRuntime } from "../runtime-B_7vsUma.mjs";
|
|
3
3
|
import fs from "node:fs";
|
|
4
4
|
import path from "node:path";
|
|
5
5
|
import crypto from "node:crypto";
|
|
@@ -243,7 +243,9 @@ async function main() {
|
|
|
243
243
|
const runtime = createCliRuntime();
|
|
244
244
|
const program = new Command();
|
|
245
245
|
program.name("agentic-browser").description("Agentic browser CLI");
|
|
246
|
-
program.command("session:start").action(async () => {
|
|
246
|
+
program.command("session:start").option("--cdp-url <url>", "connect to existing Chrome via CDP endpoint URL").option("--user-profile <path>", "use 'default' for system Chrome profile or an absolute path").action(async (options) => {
|
|
247
|
+
if (options.cdpUrl) runtime.context.config.cdpUrl = options.cdpUrl;
|
|
248
|
+
if (options.userProfile) runtime.context.config.userProfileDir = options.userProfile === "true" || options.userProfile === "default" ? "default" : options.userProfile;
|
|
247
249
|
const result = await runSessionStart(runtime, { browser: "chrome" });
|
|
248
250
|
console.log(JSON.stringify(result));
|
|
249
251
|
});
|
|
@@ -308,7 +310,9 @@ async function main() {
|
|
|
308
310
|
console.log(JSON.stringify(result));
|
|
309
311
|
});
|
|
310
312
|
const agent = program.command("agent").description("Stateful agent wrapper with session persistence and auto-retry");
|
|
311
|
-
agent.command("start").action(async () => {
|
|
313
|
+
agent.command("start").option("--cdp-url <url>", "connect to existing Chrome via CDP endpoint URL").option("--user-profile <path>", "use 'default' for system Chrome profile or an absolute path").action(async (options) => {
|
|
314
|
+
if (options.cdpUrl) runtime.context.config.cdpUrl = options.cdpUrl;
|
|
315
|
+
if (options.userProfile) runtime.context.config.userProfileDir = options.userProfile === "true" || options.userProfile === "default" ? "default" : options.userProfile;
|
|
312
316
|
const result = await agentStart(runtime);
|
|
313
317
|
console.log(JSON.stringify(result));
|
|
314
318
|
});
|
package/dist/index.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import { i as createMockAgenticBrowserCore, n as createAgenticBrowserCore, t as AgenticBrowserCore } from "./runtime-
|
|
2
|
+
import { i as createMockAgenticBrowserCore, n as createAgenticBrowserCore, t as AgenticBrowserCore } from "./runtime-B_7vsUma.mjs";
|
|
3
3
|
|
|
4
4
|
export { AgenticBrowserCore, createAgenticBrowserCore, createMockAgenticBrowserCore };
|
package/dist/mcp/index.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
|
-
import { n as createAgenticBrowserCore } from "../runtime-
|
|
2
|
+
import { n as createAgenticBrowserCore } from "../runtime-B_7vsUma.mjs";
|
|
3
3
|
import { z } from "zod";
|
|
4
4
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
5
5
|
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
import { spawn } from "node:child_process";
|
|
3
3
|
import fs from "node:fs";
|
|
4
4
|
import net from "node:net";
|
|
5
|
+
import os from "node:os";
|
|
5
6
|
import path from "node:path";
|
|
6
7
|
import WebSocket, { WebSocketServer } from "ws";
|
|
7
8
|
import { URL as URL$1, fileURLToPath } from "node:url";
|
|
@@ -157,6 +158,13 @@ async function getFreePort() {
|
|
|
157
158
|
});
|
|
158
159
|
});
|
|
159
160
|
}
|
|
161
|
+
function resolveDefaultProfileDir() {
|
|
162
|
+
const platform = os.platform();
|
|
163
|
+
const home = os.homedir();
|
|
164
|
+
if (platform === "darwin") return path.join(home, "Library", "Application Support", "Google", "Chrome");
|
|
165
|
+
if (platform === "win32") return path.join(process.env.LOCALAPPDATA ?? path.join(home, "AppData", "Local"), "Google", "Chrome", "User Data");
|
|
166
|
+
return path.join(home, ".config", "google-chrome");
|
|
167
|
+
}
|
|
160
168
|
var ChromeCdpBrowserController = class {
|
|
161
169
|
connections = /* @__PURE__ */ new Map();
|
|
162
170
|
constructor(baseDir, connectionFactory = CdpConnection.connect) {
|
|
@@ -191,6 +199,19 @@ var ChromeCdpBrowserController = class {
|
|
|
191
199
|
closeConnection(targetWsUrl) {
|
|
192
200
|
this.dropConnection(targetWsUrl);
|
|
193
201
|
}
|
|
202
|
+
async connect(cdpUrl) {
|
|
203
|
+
const parsed = new URL(cdpUrl);
|
|
204
|
+
const port = Number.parseInt(parsed.port, 10);
|
|
205
|
+
if (!port) throw new Error(`Invalid CDP URL: could not extract port from ${cdpUrl}`);
|
|
206
|
+
await waitForDebugger(port);
|
|
207
|
+
const targetWsUrl = await createTarget(cdpUrl);
|
|
208
|
+
await evaluateExpression(targetWsUrl, "window.location.href");
|
|
209
|
+
return {
|
|
210
|
+
pid: 0,
|
|
211
|
+
cdpUrl,
|
|
212
|
+
targetWsUrl
|
|
213
|
+
};
|
|
214
|
+
}
|
|
194
215
|
async ensureEnabled(targetWsUrl) {
|
|
195
216
|
const cached = this.connections.get(targetWsUrl);
|
|
196
217
|
if (!cached) return;
|
|
@@ -203,10 +224,13 @@ var ChromeCdpBrowserController = class {
|
|
|
203
224
|
cached.enabled.runtime = true;
|
|
204
225
|
}
|
|
205
226
|
}
|
|
206
|
-
async launch(sessionId, explicitPath) {
|
|
227
|
+
async launch(sessionId, explicitPath, userProfileDir) {
|
|
207
228
|
const executablePath = discoverChrome(explicitPath);
|
|
208
229
|
const extension = loadControlExtension();
|
|
209
|
-
|
|
230
|
+
let profileDir;
|
|
231
|
+
if (userProfileDir === "default") profileDir = resolveDefaultProfileDir();
|
|
232
|
+
else if (userProfileDir) profileDir = userProfileDir;
|
|
233
|
+
else profileDir = path.join(this.baseDir, "profiles", sessionId);
|
|
210
234
|
fs.mkdirSync(profileDir, { recursive: true });
|
|
211
235
|
const launchAttempts = [
|
|
212
236
|
{
|
|
@@ -640,6 +664,7 @@ var ChromeCdpBrowserController = class {
|
|
|
640
664
|
}
|
|
641
665
|
}
|
|
642
666
|
terminate(pid) {
|
|
667
|
+
if (pid === 0) return;
|
|
643
668
|
try {
|
|
644
669
|
process.kill(pid, "SIGTERM");
|
|
645
670
|
} catch {}
|
|
@@ -662,6 +687,19 @@ var MockBrowserController = class {
|
|
|
662
687
|
targetWsUrl
|
|
663
688
|
};
|
|
664
689
|
}
|
|
690
|
+
async connect(cdpUrl) {
|
|
691
|
+
this.pages.set(cdpUrl, {
|
|
692
|
+
url: "about:blank",
|
|
693
|
+
title: "about:blank",
|
|
694
|
+
text: "",
|
|
695
|
+
html: "<html><body></body></html>"
|
|
696
|
+
});
|
|
697
|
+
return {
|
|
698
|
+
pid: 0,
|
|
699
|
+
cdpUrl,
|
|
700
|
+
targetWsUrl: cdpUrl
|
|
701
|
+
};
|
|
702
|
+
}
|
|
665
703
|
async navigate(cdpUrl, url) {
|
|
666
704
|
const page = this.pages.get(cdpUrl);
|
|
667
705
|
if (!page) throw new Error("mock page missing");
|
|
@@ -785,7 +823,7 @@ var SessionManager = class {
|
|
|
785
823
|
if (active && active.session.status !== "terminated") throw new Error("A managed session is already active");
|
|
786
824
|
const sessionId = crypto.randomUUID();
|
|
787
825
|
const token = this.ctx.tokenService.issue(sessionId);
|
|
788
|
-
const launched = await this.browser.launch(sessionId, this.ctx.config.browserExecutablePath);
|
|
826
|
+
const launched = this.ctx.config.cdpUrl ? await this.browser.connect(this.ctx.config.cdpUrl) : await this.browser.launch(sessionId, this.ctx.config.browserExecutablePath, this.ctx.config.userProfileDir);
|
|
789
827
|
const session = {
|
|
790
828
|
sessionId,
|
|
791
829
|
status: "ready",
|
|
@@ -1136,12 +1174,18 @@ function loadConfig(env = process.env) {
|
|
|
1136
1174
|
const commandTimeoutMs = Number.parseInt(env.AGENTIC_BROWSER_COMMAND_TIMEOUT_MS ?? `${DEFAULT_TIMEOUT_MS}`, 10);
|
|
1137
1175
|
if (Number.isNaN(wsPort) || wsPort <= 0) throw new Error("AGENTIC_BROWSER_WS_PORT must be a positive integer");
|
|
1138
1176
|
if (Number.isNaN(commandTimeoutMs) || commandTimeoutMs <= 0) throw new Error("AGENTIC_BROWSER_COMMAND_TIMEOUT_MS must be a positive integer");
|
|
1177
|
+
const userProfile = env.AGENTIC_BROWSER_USER_PROFILE;
|
|
1178
|
+
let userProfileDir;
|
|
1179
|
+
if (userProfile === "true" || userProfile === "default") userProfileDir = "default";
|
|
1180
|
+
else if (userProfile && path.isAbsolute(userProfile)) userProfileDir = userProfile;
|
|
1139
1181
|
return {
|
|
1140
1182
|
host: env.AGENTIC_BROWSER_HOST ?? "127.0.0.1",
|
|
1141
1183
|
wsPort,
|
|
1142
1184
|
commandTimeoutMs,
|
|
1143
1185
|
logDir: env.AGENTIC_BROWSER_LOG_DIR ?? path.resolve(process.cwd(), ".agentic-browser"),
|
|
1144
|
-
browserExecutablePath: env.AGENTIC_BROWSER_CHROME_PATH
|
|
1186
|
+
browserExecutablePath: env.AGENTIC_BROWSER_CHROME_PATH,
|
|
1187
|
+
cdpUrl: env.AGENTIC_BROWSER_CDP_URL,
|
|
1188
|
+
userProfileDir
|
|
1145
1189
|
};
|
|
1146
1190
|
}
|
|
1147
1191
|
|