You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+108-6Lines changed: 108 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,17 +2,52 @@
2
2
3
3
**Auto Browse** is the easiest way to connect your AI agents with the browser using natural language.
4
4
5
-
6
5
## Quick start
7
6
8
-
An AI-powered browser automation enginer for automating browser tasks and Playwright tests that enables natural language interactions with web pages.
7
+
An AI-powered browser automation agent for automating browser tasks and Write Playwright tests that enables natural language interactions with web pages.
9
8
10
9
## Installation
11
10
12
11
```bash
13
-
npm install auto-browse
12
+
npm install @auto-browse/auto-browse
13
+
```
14
+
15
+
## ⚠️ Important: Playwright Version Requirements
16
+
17
+
> **Note:** Auto Browse currently requires specific versions of Playwright. This requirement will be relaxed in future versions.
18
+
19
+
### Required Versions
20
+
21
+
```bash
22
+
"@playwright/test": "1.52.0-alpha-1743011787000"
23
+
"playwright": "1.52.0-alpha-1743011787000"
14
24
```
15
25
26
+
### Version Conflicts
27
+
28
+
If you're using Auto Browse alongside an existing Playwright setup, you must upgrade to these specific versions. Here's how to handle common issues:
29
+
30
+
1.**Installation Conflicts**
31
+
32
+
```bash
33
+
npm install --legacy-peer-deps
34
+
```
35
+
36
+
This flag helps resolve peer dependency conflicts during installation.
37
+
38
+
2.**Multiple Playwright Versions**
39
+
40
+
- Remove existing Playwright installations
41
+
- Clear npm cache if needed: `npm cache clean --force`
42
+
- Reinstall with the required versions
43
+
44
+
3.**Project Compatibility**
45
+
- Update your project's Playwright configuration
46
+
- Ensure your existing tests are compatible with the alpha version
47
+
- Consider using a separate test environment if needed
48
+
49
+
> 🔄 Future releases will support a wider range of Playwright versions. Subscribe to our GitHub repository for updates.
50
+
16
51
## Configuration
17
52
18
53
Auto Browse requires environment variables for the LLM (Language Model) configuration. Create a `.env` file in your project root:
@@ -51,7 +86,7 @@ Coming soon:
51
86
Auto Browse can also be used outside of Playwright test context. Here's a complete form automation example:
52
87
53
88
```typescript
54
-
import { auto } from"auto-browse";
89
+
import { auto } from"@auto-browse/auto-browse";
55
90
56
91
asyncfunction main() {
57
92
try {
@@ -97,7 +132,7 @@ npx ts-node your-script.ts
97
132
98
133
```typescript
99
134
import { test, expect } from"@playwright/test";
100
-
import { auto } from"auto-browse";
135
+
import { auto } from"@auto-browse/auto-browse";
101
136
102
137
test("example test", async ({ page }) => {
103
138
awaitpage.goto("https://example.com");
@@ -119,7 +154,7 @@ The package automatically detects the current page context, so you can skip pass
Auto Browse seamlessly integrates with [playwright-bdd](https://github.com/vitalets/playwright-bdd) for behavior-driven development. This allows you to write expressive feature files and implement steps using natural language commands.
172
+
173
+
#### Example Feature File
174
+
175
+
```gherkin
176
+
# features/homepage.feature
177
+
Feature: Playwright Home Page
178
+
179
+
Scenario: Check title
180
+
Given navigate to https://playwright.dev
181
+
When click link "Get started"
182
+
Then assert title "Installation"
183
+
```
184
+
185
+
#### Step Definitions
186
+
187
+
```typescript
188
+
import { auto } from"@auto-browse/auto-browse";
189
+
import { Given, When, Then } from"./fixtures";
190
+
191
+
// Generic step that handles any natural language action
0 commit comments