bunwright 0.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/.env ADDED
@@ -0,0 +1 @@
1
+ BUN_CHROME_PATH="C:\Users\jonaspm\Development\repos\bunwright\instructions-farmacias-guadalajara copy.json"
package/LICENSE.md ADDED
@@ -0,0 +1,469 @@
1
+ Bunwright: The lightweight browser automation library for Bun
2
+ Copyright (C) 2026 Jonas Perusquia Morales
3
+ https://jonasperusquia.com
4
+
5
+ This library is free software; you can redistribute it and/or
6
+ modify it under the terms of the GNU Lesser General Public
7
+ License as published by the Free Software Foundation; either
8
+ version 2.1 of the License.
9
+
10
+ This library is distributed in the hope that it will be useful,
11
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
12
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
+ Lesser General Public License for more details.
14
+
15
+ You should have received a copy of the GNU Lesser General Public
16
+ License along with this library; if not, write to the Free Software
17
+ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
+
19
+ # GNU Lesser General Public License
20
+
21
+ =================================
22
+
23
+ _Version 2.1, February 1999_
24
+ _Copyright © 1991, 1999 Free Software Foundation, Inc._
25
+ _51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA_
26
+
27
+ Everyone is permitted to copy and distribute verbatim copies
28
+ of this license document, but changing it is not allowed.
29
+
30
+ _This is the first released version of the Lesser GPL. It also counts
31
+ as the successor of the GNU Library Public License, version 2, hence
32
+ the version number 2.1._
33
+
34
+ ### Preamble
35
+
36
+ The licenses for most software are designed to take away your
37
+ freedom to share and change it. By contrast, the GNU General Public
38
+ Licenses are intended to guarantee your freedom to share and change
39
+ free software--to make sure the software is free for all its users.
40
+
41
+ This license, the Lesser General Public License, applies to some
42
+ specially designated software packages--typically libraries--of the
43
+ Free Software Foundation and other authors who decide to use it. You
44
+ can use it too, but we suggest you first think carefully about whether
45
+ this license or the ordinary General Public License is the better
46
+ strategy to use in any particular case, based on the explanations below.
47
+
48
+ When we speak of free software, we are referring to freedom of use,
49
+ not price. Our General Public Licenses are designed to make sure that
50
+ you have the freedom to distribute copies of free software (and charge
51
+ for this service if you wish); that you receive source code or can get
52
+ it if you want it; that you can change the software and use pieces of
53
+ it in new free programs; and that you are informed that you can do
54
+ these things.
55
+
56
+ To protect your rights, we need to make restrictions that forbid
57
+ distributors to deny you these rights or to ask you to surrender these
58
+ rights. These restrictions translate to certain responsibilities for
59
+ you if you distribute copies of the library or if you modify it.
60
+
61
+ For example, if you distribute copies of the library, whether gratis
62
+ or for a fee, you must give the recipients all the rights that we gave
63
+ you. You must make sure that they, too, receive or can get the source
64
+ code. If you link other code with the library, you must provide
65
+ complete object files to the recipients, so that they can relink them
66
+ with the library after making changes to the library and recompiling
67
+ it. And you must show them these terms so they know their rights.
68
+
69
+ We protect your rights with a two-step method: **(1)** we copyright the
70
+ library, and **(2)** we offer you this license, which gives you legal
71
+ permission to copy, distribute and/or modify the library.
72
+
73
+ To protect each distributor, we want to make it very clear that
74
+ there is no warranty for the free library. Also, if the library is
75
+ modified by someone else and passed on, the recipients should know
76
+ that what they have is not the original version, so that the original
77
+ author's reputation will not be affected by problems that might be
78
+ introduced by others.
79
+
80
+ Finally, software patents pose a constant threat to the existence of
81
+ any free program. We wish to make sure that a company cannot
82
+ effectively restrict the users of a free program by obtaining a
83
+ restrictive license from a patent holder. Therefore, we insist that
84
+ any patent license obtained for a version of the library must be
85
+ consistent with the full freedom of use specified in this license.
86
+
87
+ Most GNU software, including some libraries, is covered by the
88
+ ordinary GNU General Public License. This license, the GNU Lesser
89
+ General Public License, applies to certain designated libraries, and
90
+ is quite different from the ordinary General Public License. We use
91
+ this license for certain libraries in order to permit linking those
92
+ libraries into non-free programs.
93
+
94
+ When a program is linked with a library, whether statically or using
95
+ a shared library, the combination of the two is legally speaking a
96
+ combined work, a derivative of the original library. The ordinary
97
+ General Public License therefore permits such linking only if the
98
+ entire combination fits its criteria of freedom. The Lesser General
99
+ Public License permits more lax criteria for linking other code with
100
+ the library.
101
+
102
+ We call this license the “Lesser” General Public License because it
103
+ does Less to protect the user's freedom than the ordinary General
104
+ Public License. It also provides other free software developers Less
105
+ of an advantage over competing non-free programs. These disadvantages
106
+ are the reason we use the ordinary General Public License for many
107
+ libraries. However, the Lesser license provides advantages in certain
108
+ special circumstances.
109
+
110
+ For example, on rare occasions, there may be a special need to
111
+ encourage the widest possible use of a certain library, so that it becomes
112
+ a de-facto standard. To achieve this, non-free programs must be
113
+ allowed to use the library. A more frequent case is that a free
114
+ library does the same job as widely used non-free libraries. In this
115
+ case, there is little to gain by limiting the free library to free
116
+ software only, so we use the Lesser General Public License.
117
+
118
+ In other cases, permission to use a particular library in non-free
119
+ programs enables a greater number of people to use a large body of
120
+ free software. For example, permission to use the GNU C Library in
121
+ non-free programs enables many more people to use the whole GNU
122
+ operating system, as well as its variant, the GNU/Linux operating
123
+ system.
124
+
125
+ Although the Lesser General Public License is Less protective of the
126
+ users' freedom, it does ensure that the user of a program that is
127
+ linked with the Library has the freedom and the wherewithal to run
128
+ that program using a modified version of the Library.
129
+
130
+ The precise terms and conditions for copying, distribution and
131
+ modification follow. Pay close attention to the difference between a
132
+ “work based on the library” and a “work that uses the library”. The
133
+ former contains code derived from the library, whereas the latter must
134
+ be combined with the library in order to run.
135
+
136
+ ### TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
137
+
138
+ **0.** This License Agreement applies to any software library or other
139
+ program which contains a notice placed by the copyright holder or
140
+ other authorized party saying it may be distributed under the terms of
141
+ this Lesser General Public License (also called “this License”).
142
+ Each licensee is addressed as “you”.
143
+
144
+ A “library” means a collection of software functions and/or data
145
+ prepared so as to be conveniently linked with application programs
146
+ (which use some of those functions and data) to form executables.
147
+
148
+ The “Library”, below, refers to any such software library or work
149
+ which has been distributed under these terms. A “work based on the
150
+ Library” means either the Library or any derivative work under
151
+ copyright law: that is to say, a work containing the Library or a
152
+ portion of it, either verbatim or with modifications and/or translated
153
+ straightforwardly into another language. (Hereinafter, translation is
154
+ included without limitation in the term “modification”.)
155
+
156
+ “Source code” for a work means the preferred form of the work for
157
+ making modifications to it. For a library, complete source code means
158
+ all the source code for all modules it contains, plus any associated
159
+ interface definition files, plus the scripts used to control compilation
160
+ and installation of the library.
161
+
162
+ Activities other than copying, distribution and modification are not
163
+ covered by this License; they are outside its scope. The act of
164
+ running a program using the Library is not restricted, and output from
165
+ such a program is covered only if its contents constitute a work based
166
+ on the Library (independent of the use of the Library in a tool for
167
+ writing it). Whether that is true depends on what the Library does
168
+ and what the program that uses the Library does.
169
+
170
+ **1.** You may copy and distribute verbatim copies of the Library's
171
+ complete source code as you receive it, in any medium, provided that
172
+ you conspicuously and appropriately publish on each copy an
173
+ appropriate copyright notice and disclaimer of warranty; keep intact
174
+ all the notices that refer to this License and to the absence of any
175
+ warranty; and distribute a copy of this License along with the
176
+ Library.
177
+
178
+ You may charge a fee for the physical act of transferring a copy,
179
+ and you may at your option offer warranty protection in exchange for a
180
+ fee.
181
+
182
+ **2.** You may modify your copy or copies of the Library or any portion
183
+ of it, thus forming a work based on the Library, and copy and
184
+ distribute such modifications or work under the terms of Section 1
185
+ above, provided that you also meet all of these conditions:
186
+
187
+ * **a)** The modified work must itself be a software library.
188
+ * **b)** You must cause the files modified to carry prominent notices
189
+ stating that you changed the files and the date of any change.
190
+ * **c)** You must cause the whole of the work to be licensed at no
191
+ charge to all third parties under the terms of this License.
192
+ * **d)** If a facility in the modified Library refers to a function or a
193
+ table of data to be supplied by an application program that uses
194
+ the facility, other than as an argument passed when the facility
195
+ is invoked, then you must make a good faith effort to ensure that,
196
+ in the event an application does not supply such function or
197
+ table, the facility still operates, and performs whatever part of
198
+ its purpose remains meaningful.
199
+ (For example, a function in a library to compute square roots has
200
+ a purpose that is entirely well-defined independent of the
201
+ application. Therefore, Subsection 2d requires that any
202
+ application-supplied function or table used by this function must
203
+ be optional: if the application does not supply it, the square
204
+ root function must still compute square roots.)
205
+
206
+ These requirements apply to the modified work as a whole. If
207
+ identifiable sections of that work are not derived from the Library,
208
+ and can be reasonably considered independent and separate works in
209
+ themselves, then this License, and its terms, do not apply to those
210
+ sections when you distribute them as separate works. But when you
211
+ distribute the same sections as part of a whole which is a work based
212
+ on the Library, the distribution of the whole must be on the terms of
213
+ this License, whose permissions for other licensees extend to the
214
+ entire whole, and thus to each and every part regardless of who wrote
215
+ it.
216
+
217
+ Thus, it is not the intent of this section to claim rights or contest
218
+ your rights to work written entirely by you; rather, the intent is to
219
+ exercise the right to control the distribution of derivative or
220
+ collective works based on the Library.
221
+
222
+ In addition, mere aggregation of another work not based on the Library
223
+ with the Library (or with a work based on the Library) on a volume of
224
+ a storage or distribution medium does not bring the other work under
225
+ the scope of this License.
226
+
227
+ **3.** You may opt to apply the terms of the ordinary GNU General Public
228
+ License instead of this License to a given copy of the Library. To do
229
+ this, you must alter all the notices that refer to this License, so
230
+ that they refer to the ordinary GNU General Public License, version 2,
231
+ instead of to this License. (If a newer version than version 2 of the
232
+ ordinary GNU General Public License has appeared, then you can specify
233
+ that version instead if you wish.) Do not make any other change in
234
+ these notices.
235
+
236
+ Once this change is made in a given copy, it is irreversible for
237
+ that copy, so the ordinary GNU General Public License applies to all
238
+ subsequent copies and derivative works made from that copy.
239
+
240
+ This option is useful when you wish to copy part of the code of
241
+ the Library into a program that is not a library.
242
+
243
+ **4.** You may copy and distribute the Library (or a portion or
244
+ derivative of it, under Section 2) in object code or executable form
245
+ under the terms of Sections 1 and 2 above provided that you accompany
246
+ it with the complete corresponding machine-readable source code, which
247
+ must be distributed under the terms of Sections 1 and 2 above on a
248
+ medium customarily used for software interchange.
249
+
250
+ If distribution of object code is made by offering access to copy
251
+ from a designated place, then offering equivalent access to copy the
252
+ source code from the same place satisfies the requirement to
253
+ distribute the source code, even though third parties are not
254
+ compelled to copy the source along with the object code.
255
+
256
+ **5.** A program that contains no derivative of any portion of the
257
+ Library, but is designed to work with the Library by being compiled or
258
+ linked with it, is called a “work that uses the Library”. Such a
259
+ work, in isolation, is not a derivative work of the Library, and
260
+ therefore falls outside the scope of this License.
261
+
262
+ However, linking a “work that uses the Library” with the Library
263
+ creates an executable that is a derivative of the Library (because it
264
+ contains portions of the Library), rather than a “work that uses the
265
+ library”. The executable is therefore covered by this License.
266
+ Section 6 states terms for distribution of such executables.
267
+
268
+ When a “work that uses the Library” uses material from a header file
269
+ that is part of the Library, the object code for the work may be a
270
+ derivative work of the Library even though the source code is not.
271
+ Whether this is true is especially significant if the work can be
272
+ linked without the Library, or if the work is itself a library. The
273
+ threshold for this to be true is not precisely defined by law.
274
+
275
+ If such an object file uses only numerical parameters, data
276
+ structure layouts and accessors, and small macros and small inline
277
+ functions (ten lines or less in length), then the use of the object
278
+ file is unrestricted, regardless of whether it is legally a derivative
279
+ work. (Executables containing this object code plus portions of the
280
+ Library will still fall under Section 6.)
281
+
282
+ Otherwise, if the work is a derivative of the Library, you may
283
+ distribute the object code for the work under the terms of Section 6.
284
+ Any executables containing that work also fall under Section 6,
285
+ whether or not they are linked directly with the Library itself.
286
+
287
+ **6.** As an exception to the Sections above, you may also combine or
288
+ link a “work that uses the Library” with the Library to produce a
289
+ work containing portions of the Library, and distribute that work
290
+ under terms of your choice, provided that the terms permit
291
+ modification of the work for the customer's own use and reverse
292
+ engineering for debugging such modifications.
293
+
294
+ You must give prominent notice with each copy of the work that the
295
+ Library is used in it and that the Library and its use are covered by
296
+ this License. You must supply a copy of this License. If the work
297
+ during execution displays copyright notices, you must include the
298
+ copyright notice for the Library among them, as well as a reference
299
+ directing the user to the copy of this License. Also, you must do one
300
+ of these things:
301
+
302
+ * **a)** Accompany the work with the complete corresponding
303
+ machine-readable source code for the Library including whatever
304
+ changes were used in the work (which must be distributed under
305
+ Sections 1 and 2 above); and, if the work is an executable linked
306
+ with the Library, with the complete machine-readable “work that
307
+ uses the Library”, as object code and/or source code, so that the
308
+ user can modify the Library and then relink to produce a modified
309
+ executable containing the modified Library. (It is understood
310
+ that the user who changes the contents of definitions files in the
311
+ Library will not necessarily be able to recompile the application
312
+ to use the modified definitions.)
313
+ * **b)** Use a suitable shared library mechanism for linking with the
314
+ Library. A suitable mechanism is one that (1) uses at run time a
315
+ copy of the library already present on the user's computer system,
316
+ rather than copying library functions into the executable, and (2)
317
+ will operate properly with a modified version of the library, if
318
+ the user installs one, as long as the modified version is
319
+ interface-compatible with the version that the work was made with.
320
+ * **c)** Accompany the work with a written offer, valid for at
321
+ least three years, to give the same user the materials
322
+ specified in Subsection 6a, above, for a charge no more
323
+ than the cost of performing this distribution.
324
+ * **d)** If distribution of the work is made by offering access to copy
325
+ from a designated place, offer equivalent access to copy the above
326
+ specified materials from the same place.
327
+ * **e)** Verify that the user has already received a copy of these
328
+ materials or that you have already sent this user a copy.
329
+
330
+ For an executable, the required form of the “work that uses the
331
+ Library” must include any data and utility programs needed for
332
+ reproducing the executable from it. However, as a special exception,
333
+ the materials to be distributed need not include anything that is
334
+ normally distributed (in either source or binary form) with the major
335
+ components (compiler, kernel, and so on) of the operating system on
336
+ which the executable runs, unless that component itself accompanies
337
+ the executable.
338
+
339
+ It may happen that this requirement contradicts the license
340
+ restrictions of other proprietary libraries that do not normally
341
+ accompany the operating system. Such a contradiction means you cannot
342
+ use both them and the Library together in an executable that you
343
+ distribute.
344
+
345
+ **7.** You may place library facilities that are a work based on the
346
+ Library side-by-side in a single library together with other library
347
+ facilities not covered by this License, and distribute such a combined
348
+ library, provided that the separate distribution of the work based on
349
+ the Library and of the other library facilities is otherwise
350
+ permitted, and provided that you do these two things:
351
+
352
+ * **a)** Accompany the combined library with a copy of the same work
353
+ based on the Library, uncombined with any other library
354
+ facilities. This must be distributed under the terms of the
355
+ Sections above.
356
+ * **b)** Give prominent notice with the combined library of the fact
357
+ that part of it is a work based on the Library, and explaining
358
+ where to find the accompanying uncombined form of the same work.
359
+
360
+ **8.** You may not copy, modify, sublicense, link with, or distribute
361
+ the Library except as expressly provided under this License. Any
362
+ attempt otherwise to copy, modify, sublicense, link with, or
363
+ distribute the Library is void, and will automatically terminate your
364
+ rights under this License. However, parties who have received copies,
365
+ or rights, from you under this License will not have their licenses
366
+ terminated so long as such parties remain in full compliance.
367
+
368
+ **9.** You are not required to accept this License, since you have not
369
+ signed it. However, nothing else grants you permission to modify or
370
+ distribute the Library or its derivative works. These actions are
371
+ prohibited by law if you do not accept this License. Therefore, by
372
+ modifying or distributing the Library (or any work based on the
373
+ Library), you indicate your acceptance of this License to do so, and
374
+ all its terms and conditions for copying, distributing or modifying
375
+ the Library or works based on it.
376
+
377
+ **10.** Each time you redistribute the Library (or any work based on the
378
+ Library), the recipient automatically receives a license from the
379
+ original licensor to copy, distribute, link with or modify the Library
380
+ subject to these terms and conditions. You may not impose any further
381
+ restrictions on the recipients' exercise of the rights granted herein.
382
+ You are not responsible for enforcing compliance by third parties with
383
+ this License.
384
+
385
+ **11.** If, as a consequence of a court judgment or allegation of patent
386
+ infringement or for any other reason (not limited to patent issues),
387
+ conditions are imposed on you (whether by court order, agreement or
388
+ otherwise) that contradict the conditions of this License, they do not
389
+ excuse you from the conditions of this License. If you cannot
390
+ distribute so as to satisfy simultaneously your obligations under this
391
+ License and any other pertinent obligations, then as a consequence you
392
+ may not distribute the Library at all. For example, if a patent
393
+ license would not permit royalty-free redistribution of the Library by
394
+ all those who receive copies directly or indirectly through you, then
395
+ the only way you could satisfy both it and this License would be to
396
+ refrain entirely from distribution of the Library.
397
+
398
+ If any portion of this section is held invalid or unenforceable under any
399
+ particular circumstance, the balance of the section is intended to apply,
400
+ and the section as a whole is intended to apply in other circumstances.
401
+
402
+ It is not the purpose of this section to induce you to infringe any
403
+ patents or other property right claims or to contest validity of any
404
+ such claims; this section has the sole purpose of protecting the
405
+ integrity of the free software distribution system which is
406
+ implemented by public license practices. Many people have made
407
+ generous contributions to the wide range of software distributed
408
+ through that system in reliance on consistent application of that
409
+ system; it is up to the author/donor to decide if he or she is willing
410
+ to distribute software through any other system and a licensee cannot
411
+ impose that choice.
412
+
413
+ This section is intended to make thoroughly clear what is believed to
414
+ be a consequence of the rest of this License.
415
+
416
+ **12.** If the distribution and/or use of the Library is restricted in
417
+ certain countries either by patents or by copyrighted interfaces, the
418
+ original copyright holder who places the Library under this License may add
419
+ an explicit geographical distribution limitation excluding those countries,
420
+ so that distribution is permitted only in or among countries not thus
421
+ excluded. In such case, this License incorporates the limitation as if
422
+ written in the body of this License.
423
+
424
+ **13.** The Free Software Foundation may publish revised and/or new
425
+ versions of the Lesser General Public License from time to time.
426
+ Such new versions will be similar in spirit to the present version,
427
+ but may differ in detail to address new problems or concerns.
428
+
429
+ Each version is given a distinguishing version number. If the Library
430
+ specifies a version number of this License which applies to it and
431
+ “any later version”, you have the option of following the terms and
432
+ conditions either of that version or of any later version published by
433
+ the Free Software Foundation. If the Library does not specify a
434
+ license version number, you may choose any version ever published by
435
+ the Free Software Foundation.
436
+
437
+ **14.** If you wish to incorporate parts of the Library into other free
438
+ programs whose distribution conditions are incompatible with these,
439
+ write to the author to ask for permission. For software which is
440
+ copyrighted by the Free Software Foundation, write to the Free
441
+ Software Foundation; we sometimes make exceptions for this. Our
442
+ decision will be guided by the two goals of preserving the free status
443
+ of all derivatives of our free software and of promoting the sharing
444
+ and reuse of software generally.
445
+
446
+ ### NO WARRANTY
447
+
448
+ **15.** BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
449
+ WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
450
+ EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
451
+ OTHER PARTIES PROVIDE THE LIBRARY “AS IS” WITHOUT WARRANTY OF ANY
452
+ KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
453
+ IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
454
+ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
455
+ LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
456
+ THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
457
+
458
+ **16.** IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
459
+ WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
460
+ AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
461
+ FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
462
+ CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
463
+ LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
464
+ RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
465
+ FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
466
+ SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
467
+ DAMAGES.
468
+
469
+ _END OF TERMS AND CONDITIONS_
package/README.md ADDED
@@ -0,0 +1,142 @@
1
+ <h1 align="center">
2
+ <strong>Bunwright</strong>
3
+ </h1>
4
+
5
+ <p align="center">
6
+ <strong>The lightweight browser automation library for Bun</strong>
7
+ </p>
8
+
9
+ <p align="center">
10
+ JSON-driven browser automation built on <code>Bun.WebView</code>.
11
+ <br />
12
+ A smaller, Bun-native alternative for automation flows where Playwright would be heavier than necessary.
13
+ </p>
14
+
15
+ ---
16
+
17
+ `bunwright` is a lightweight browser automation tool for Bun focused on simple, scriptable workflows.
18
+ It lets you describe browser actions as JSON and execute them through `Bun.WebView`, making it useful for local automation, repeatable UI flows, and small browser-driven utilities.
19
+
20
+ If you want a Playwright alternative for Bun that is smaller in scope, faster to wire into Bun projects, and centered on lightweight automation instead of a full end-to-end testing stack, `bunwright` is built for that space.
21
+
22
+ ## Use Cases
23
+
24
+ - Automate repetitive internal web workflows such as logins, form filling, and admin panel tasks
25
+ - Capture screenshots of pages or post-login states from scripted browser sessions
26
+ - Run lightweight browser-driven data collection or verification flows
27
+ - Prototype browser automations in Bun without adopting a larger testing framework
28
+ - Execute JSON-defined automation steps from other Bun tools, scripts, or local CLIs
29
+
30
+ ## Install
31
+
32
+ ### npm
33
+
34
+ Install globally with npm:
35
+
36
+ ```bash
37
+ npm install -g bunwright
38
+ ```
39
+
40
+ Then run:
41
+
42
+ ```bash
43
+ bunwright --file instructions.json
44
+ ```
45
+
46
+ ### Development
47
+
48
+ Install dependencies in this repository:
49
+
50
+ ```bash
51
+ bun install
52
+ ```
53
+
54
+ Run the CLI directly during development:
55
+
56
+ ```bash
57
+ bun run bunwright.ts --help
58
+ ```
59
+
60
+ ## Quick Start
61
+
62
+ Run a JSON instruction file:
63
+
64
+ ```bash
65
+ bunx bunwright --file instructions.json
66
+ ```
67
+
68
+ Or pass instructions inline:
69
+
70
+ ```bash
71
+ bunx bunwright --instructions '{"steps":[{"action":"navigate","url":"https://example.com"}]}'
72
+ ```
73
+
74
+ Schema documentation lives in `docs/instructions-schema.md`.
75
+ Sample input lives in `instructions.json`.
76
+
77
+ ## Example
78
+
79
+ Example instruction document:
80
+
81
+ ```json
82
+ {
83
+ "config": {
84
+ "backend": "chrome",
85
+ "width": 1440,
86
+ "height": 900,
87
+ "console": true
88
+ },
89
+ "steps": [
90
+ { "action": "navigate", "url": "https://example.com/login" },
91
+ { "action": "type", "selector": "input[name=email]", "text": "user@example.com" },
92
+ { "action": "click", "selector": "button[type=submit]" },
93
+ { "action": "wait", "ms": 1500 },
94
+ { "action": "screenshot", "path": "./generated/login.png", "format": "png" }
95
+ ]
96
+ }
97
+ ```
98
+
99
+ Run it with:
100
+
101
+ ```bash
102
+ bunx bunwright --file instructions.json
103
+ ```
104
+
105
+ On success, `bunwright` prints structured JSON to stdout describing the executed steps.
106
+
107
+ ## Link The CLI Into Another Bun Project
108
+
109
+ From this repository:
110
+
111
+ ```bash
112
+ bun link
113
+ ```
114
+
115
+ From the other project:
116
+
117
+ ```bash
118
+ bun link bunwright
119
+ ```
120
+
121
+ Then run the linked executable:
122
+
123
+ ```bash
124
+ bunwright --file instructions.json
125
+ ```
126
+
127
+ Or with Bun's package runner:
128
+
129
+ ```bash
130
+ bunx bunwright --file instructions.json
131
+ ```
132
+
133
+ ## CLI Usage
134
+
135
+ ```bash
136
+ bunx bunwright --file instructions.json
137
+ bunx bunwright --instructions '{"steps":[{"action":"navigate","url":"https://example.com"}]}'
138
+ ```
139
+
140
+ Pass exactly one of `--file` or `--instructions`.
141
+
142
+ This project was created using `bun init` in bun v1.3.12. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.