agent-browser 0.0.0 → 0.1.1

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.
Files changed (54) hide show
  1. package/.prettierrc +7 -0
  2. package/LICENSE +201 -0
  3. package/README.md +274 -1
  4. package/bin/agent-browser +2 -0
  5. package/dist/actions.d.ts +7 -0
  6. package/dist/actions.d.ts.map +1 -0
  7. package/dist/actions.js +1138 -0
  8. package/dist/actions.js.map +1 -0
  9. package/dist/browser.d.ts +232 -0
  10. package/dist/browser.d.ts.map +1 -0
  11. package/dist/browser.js +477 -0
  12. package/dist/browser.js.map +1 -0
  13. package/dist/browser.test.d.ts +2 -0
  14. package/dist/browser.test.d.ts.map +1 -0
  15. package/dist/browser.test.js +136 -0
  16. package/dist/browser.test.js.map +1 -0
  17. package/dist/client.d.ts +17 -0
  18. package/dist/client.d.ts.map +1 -0
  19. package/dist/client.js +133 -0
  20. package/dist/client.js.map +1 -0
  21. package/dist/daemon.d.ts +29 -0
  22. package/dist/daemon.d.ts.map +1 -0
  23. package/dist/daemon.js +165 -0
  24. package/dist/daemon.js.map +1 -0
  25. package/dist/index.d.ts +3 -0
  26. package/dist/index.d.ts.map +1 -0
  27. package/dist/index.js +1158 -0
  28. package/dist/index.js.map +1 -0
  29. package/dist/protocol.d.ts +26 -0
  30. package/dist/protocol.d.ts.map +1 -0
  31. package/dist/protocol.js +717 -0
  32. package/dist/protocol.js.map +1 -0
  33. package/dist/protocol.test.d.ts +2 -0
  34. package/dist/protocol.test.d.ts.map +1 -0
  35. package/dist/protocol.test.js +176 -0
  36. package/dist/protocol.test.js.map +1 -0
  37. package/dist/types.d.ts +604 -0
  38. package/dist/types.d.ts.map +1 -0
  39. package/dist/types.js +2 -0
  40. package/dist/types.js.map +1 -0
  41. package/package.json +39 -8
  42. package/scripts/postinstall.js +17 -0
  43. package/src/actions.ts +1658 -0
  44. package/src/browser.test.ts +157 -0
  45. package/src/browser.ts +586 -0
  46. package/src/client.ts +150 -0
  47. package/src/daemon.ts +187 -0
  48. package/src/index.ts +1180 -0
  49. package/src/protocol.test.ts +216 -0
  50. package/src/protocol.ts +848 -0
  51. package/src/types.ts +913 -0
  52. package/tsconfig.json +19 -0
  53. package/vitest.config.ts +9 -0
  54. package/index.js +0 -2
package/.prettierrc ADDED
@@ -0,0 +1,7 @@
1
+ {
2
+ "semi": true,
3
+ "singleQuote": true,
4
+ "trailingComma": "es5",
5
+ "printWidth": 100,
6
+ "tabWidth": 2
7
+ }
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright 2025 Vercel Inc.
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md CHANGED
@@ -1,3 +1,276 @@
1
1
  # agent-browser
2
2
 
3
- Coming soon.
3
+ Headless browser automation CLI for AI agents.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ pnpm install
9
+ npx playwright install chromium
10
+ pnpm build
11
+ ```
12
+
13
+ ## Quick Start
14
+
15
+ ```bash
16
+ agent-browser open example.com
17
+ agent-browser click "#submit"
18
+ agent-browser fill "#email" "test@example.com"
19
+ agent-browser get text "h1"
20
+ agent-browser screenshot page.png
21
+ agent-browser close
22
+ ```
23
+
24
+ ## Commands
25
+
26
+ ### Core Commands
27
+
28
+ ```bash
29
+ agent-browser open <url> # Navigate to URL
30
+ agent-browser click <sel> # Click element
31
+ agent-browser dblclick <sel> # Double-click element
32
+ agent-browser focus <sel> # Focus element
33
+ agent-browser type <sel> <text> # Type into element
34
+ agent-browser fill <sel> <text> # Clear and fill
35
+ agent-browser press <key> # Press key (Enter, Tab, Control+a)
36
+ agent-browser keydown <key> # Hold key down
37
+ agent-browser keyup <key> # Release key
38
+ agent-browser insert <text> # Insert text (no key events)
39
+ agent-browser hover <sel> # Hover element
40
+ agent-browser select <sel> <val> # Select dropdown option
41
+ agent-browser multiselect <sel> <v1> <v2> # Multi-select
42
+ agent-browser check <sel> # Check checkbox
43
+ agent-browser uncheck <sel> # Uncheck checkbox
44
+ agent-browser scroll <dir> [px] # Scroll (up/down/left/right)
45
+ agent-browser scrollinto <sel> # Scroll element into view
46
+ agent-browser drag <src> <tgt> # Drag and drop
47
+ agent-browser upload <sel> <files> # Upload files
48
+ agent-browser download [path] # Wait for download
49
+ agent-browser screenshot [path] # Take screenshot (--full for full page)
50
+ agent-browser pdf <path> # Save as PDF
51
+ agent-browser snapshot # Accessibility tree (best for AI)
52
+ agent-browser eval <js> # Run JavaScript
53
+ agent-browser close # Close browser
54
+ ```
55
+
56
+ ### Get Info
57
+
58
+ ```bash
59
+ agent-browser get text <sel> # Get text content
60
+ agent-browser get html <sel> # Get innerHTML
61
+ agent-browser get value <sel> # Get input value
62
+ agent-browser get attr <sel> <attr> # Get attribute
63
+ agent-browser get title # Get page title
64
+ agent-browser get url # Get current URL
65
+ agent-browser get count <sel> # Count matching elements
66
+ agent-browser get box <sel> # Get bounding box
67
+ ```
68
+
69
+ ### Check State
70
+
71
+ ```bash
72
+ agent-browser is visible <sel> # Check if visible
73
+ agent-browser is enabled <sel> # Check if enabled
74
+ agent-browser is checked <sel> # Check if checked
75
+ ```
76
+
77
+ ### Find Elements (Semantic Locators)
78
+
79
+ ```bash
80
+ agent-browser find role <role> <action> [value] # By ARIA role
81
+ agent-browser find text <text> <action> # By text content
82
+ agent-browser find label <label> <action> [value] # By label
83
+ agent-browser find placeholder <ph> <action> [value] # By placeholder
84
+ agent-browser find alt <text> <action> # By alt text
85
+ agent-browser find title <text> <action> # By title attr
86
+ agent-browser find testid <id> <action> [value] # By data-testid
87
+ agent-browser find first <sel> <action> [value] # First match
88
+ agent-browser find last <sel> <action> [value] # Last match
89
+ agent-browser find nth <n> <sel> <action> [value] # Nth match
90
+ ```
91
+
92
+ **Actions:** `click`, `fill`, `check`, `hover`, `text`
93
+
94
+ **Examples:**
95
+ ```bash
96
+ agent-browser find role button click --name "Submit"
97
+ agent-browser find text "Sign In" click
98
+ agent-browser find label "Email" fill "test@test.com"
99
+ agent-browser find first ".item" click
100
+ agent-browser find nth 2 "a" text
101
+ ```
102
+
103
+ ### Wait
104
+
105
+ ```bash
106
+ agent-browser wait <selector> # Wait for element
107
+ agent-browser wait <ms> # Wait for time
108
+ agent-browser wait --text "Welcome" # Wait for text
109
+ agent-browser wait --url "**/dash" # Wait for URL pattern
110
+ agent-browser wait --load networkidle # Wait for load state
111
+ agent-browser wait --fn "window.ready === true" # Wait for JS condition
112
+ ```
113
+
114
+ **Load states:** `load`, `domcontentloaded`, `networkidle`
115
+
116
+ ### Mouse Control
117
+
118
+ ```bash
119
+ agent-browser mouse move <x> <y> # Move mouse
120
+ agent-browser mouse down [button] # Press button (left/right/middle)
121
+ agent-browser mouse up [button] # Release button
122
+ agent-browser mouse wheel <dy> [dx] # Scroll wheel
123
+ ```
124
+
125
+ ### Browser Settings
126
+
127
+ ```bash
128
+ agent-browser set viewport <w> <h> # Set viewport size
129
+ agent-browser set device <name> # Emulate device ("iPhone 14")
130
+ agent-browser set geo <lat> <lng> # Set geolocation
131
+ agent-browser set offline [on|off] # Toggle offline mode
132
+ agent-browser set headers <json> # Extra HTTP headers
133
+ agent-browser set credentials <u> <p> # HTTP basic auth
134
+ agent-browser set media [dark|light|print] # Emulate media
135
+ ```
136
+
137
+ ### Cookies & Storage
138
+
139
+ ```bash
140
+ agent-browser cookies # Get all cookies
141
+ agent-browser cookies set <json> # Set cookies
142
+ agent-browser cookies clear # Clear cookies
143
+
144
+ agent-browser storage local # Get all localStorage
145
+ agent-browser storage local <key> # Get specific key
146
+ agent-browser storage local set <k> <v> # Set value
147
+ agent-browser storage local clear # Clear all
148
+
149
+ agent-browser storage session # Same for sessionStorage
150
+ ```
151
+
152
+ ### Network
153
+
154
+ ```bash
155
+ agent-browser network route <url> # Intercept requests
156
+ agent-browser network route <url> --abort # Block requests
157
+ agent-browser network route <url> --body <json> # Mock response
158
+ agent-browser network unroute [url] # Remove routes
159
+ agent-browser network requests # View tracked requests
160
+ agent-browser network requests --filter api # Filter requests
161
+ agent-browser response <url> # Get response body (waits for matching request)
162
+ ```
163
+
164
+ ### Tabs & Windows
165
+
166
+ ```bash
167
+ agent-browser tab # List tabs
168
+ agent-browser tab new # New tab
169
+ agent-browser tab <n> # Switch to tab n
170
+ agent-browser tab close [n] # Close tab
171
+ agent-browser window new # New window
172
+ ```
173
+
174
+ ### Frames
175
+
176
+ ```bash
177
+ agent-browser frame <sel> # Switch to iframe
178
+ agent-browser frame main # Back to main frame
179
+ ```
180
+
181
+ ### Dialogs
182
+
183
+ ```bash
184
+ agent-browser dialog accept [text] # Accept (with optional prompt text)
185
+ agent-browser dialog dismiss # Dismiss
186
+ ```
187
+
188
+ ### Debug
189
+
190
+ ```bash
191
+ agent-browser trace start # Start recording trace
192
+ agent-browser trace stop <path> # Stop and save trace
193
+ agent-browser console # View console messages
194
+ agent-browser console --clear # Clear console
195
+ agent-browser errors # View page errors
196
+ agent-browser highlight <sel> # Highlight element
197
+ agent-browser state save <path> # Save auth state
198
+ agent-browser state load <path> # Load auth state
199
+ agent-browser initscript <js> # Run JS on every page load
200
+ ```
201
+
202
+ ### Navigation
203
+
204
+ ```bash
205
+ agent-browser back # Go back
206
+ agent-browser forward # Go forward
207
+ agent-browser reload # Reload page
208
+ ```
209
+
210
+ ### Sessions
211
+
212
+ ```bash
213
+ agent-browser session # Show current session
214
+ agent-browser session list # List active sessions
215
+ ```
216
+
217
+ ## Options
218
+
219
+ | Option | Description |
220
+ |--------|-------------|
221
+ | `--session <name>` | Use isolated session (or `AGENT_BROWSER_SESSION` env) |
222
+ | `--json` | JSON output (for agents) |
223
+ | `--full, -f` | Full page screenshot |
224
+ | `--name, -n` | Locator name filter |
225
+ | `--exact` | Exact text match |
226
+ | `--headed` | Show browser window (not headless) |
227
+ | `--debug` | Debug output |
228
+
229
+ ## Sessions
230
+
231
+ Run multiple isolated browser instances:
232
+
233
+ ```bash
234
+ # Different sessions
235
+ agent-browser --session agent1 open site-a.com
236
+ agent-browser --session agent2 open site-b.com
237
+
238
+ # Or via environment
239
+ AGENT_BROWSER_SESSION=agent1 agent-browser click "#btn"
240
+
241
+ # List all
242
+ agent-browser session list
243
+ ```
244
+
245
+ ## Selectors
246
+
247
+ ```bash
248
+ # CSS
249
+ agent-browser click "#id"
250
+ agent-browser click ".class"
251
+ agent-browser click "div > button"
252
+
253
+ # Text
254
+ agent-browser click "text=Submit"
255
+
256
+ # XPath
257
+ agent-browser click "xpath=//button"
258
+
259
+ # Semantic (recommended)
260
+ agent-browser find role button click --name "Submit"
261
+ agent-browser find label "Email" fill "test@test.com"
262
+ ```
263
+
264
+ ## Agent Mode
265
+
266
+ Use `--json` for machine-readable output:
267
+
268
+ ```bash
269
+ agent-browser snapshot --json
270
+ agent-browser get text "h1" --json
271
+ agent-browser is visible ".modal" --json
272
+ ```
273
+
274
+ ## License
275
+
276
+ Apache-2.0
@@ -0,0 +1,2 @@
1
+ #!/usr/bin/env node
2
+ import '../dist/index.js';
@@ -0,0 +1,7 @@
1
+ import type { BrowserManager } from './browser.js';
2
+ import type { Command, Response } from './types.js';
3
+ /**
4
+ * Execute a command and return a response
5
+ */
6
+ export declare function executeCommand(command: Command, browser: BrowserManager): Promise<Response>;
7
+ //# sourceMappingURL=actions.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../src/actions.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,EACV,OAAO,EACP,QAAQ,EAoGT,MAAM,YAAY,CAAC;AAQpB;;GAEG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC,CAiPjG"}