@hasna/connectors 0.0.6 → 0.2.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/LICENSE +191 -0
- package/README.md +67 -41
- package/bin/index.js +1390 -745
- package/bin/mcp.js +184 -19
- package/bin/serve.js +1118 -0
- package/connectors/connect-anthropic/package.json +4 -4
- package/connectors/connect-aws/package.json +4 -4
- package/connectors/connect-brandsight/package.json +4 -4
- package/connectors/connect-cloudflare/.env.example +0 -5
- package/connectors/connect-cloudflare/package.json +4 -4
- package/connectors/connect-discord/package.json +4 -4
- package/connectors/connect-docker/package.json +4 -4
- package/connectors/connect-e2b/package.json +4 -4
- package/connectors/connect-elevenlabs/package.json +4 -4
- package/connectors/connect-exa/package.json +4 -4
- package/connectors/connect-figma/package.json +4 -4
- package/connectors/connect-firecrawl/package.json +4 -4
- package/connectors/connect-github/package.json +4 -4
- package/connectors/connect-gmail/package.json +4 -4
- package/connectors/connect-google/package.json +4 -4
- package/connectors/connect-googlecalendar/package.json +4 -4
- package/connectors/connect-googlecloud/package.json +4 -4
- package/connectors/connect-googlecontacts/package.json +4 -4
- package/connectors/connect-googledocs/package.json +4 -4
- package/connectors/connect-googledrive/package.json +4 -4
- package/connectors/connect-googlegemini/package.json +4 -4
- package/connectors/connect-googlemaps/package.json +2 -2
- package/connectors/connect-googlesheets/package.json +4 -4
- package/connectors/connect-googletasks/package.json +2 -2
- package/connectors/connect-hedra/package.json +4 -4
- package/connectors/connect-heygen/package.json +4 -4
- package/connectors/connect-huggingface/package.json +4 -4
- package/connectors/connect-icons8/package.json +4 -4
- package/connectors/connect-maropost/package.json +4 -4
- package/connectors/connect-mercury/package.json +4 -4
- package/connectors/connect-meta/package.json +4 -4
- package/connectors/connect-midjourney/package.json +4 -4
- package/connectors/connect-mistral/package.json +4 -4
- package/connectors/connect-mixpanel/package.json +4 -4
- package/connectors/connect-notion/.env.example +0 -5
- package/connectors/connect-notion/package.json +2 -2
- package/connectors/connect-openai/package.json +4 -4
- package/connectors/connect-openweathermap/package.json +4 -4
- package/connectors/connect-pandadoc/package.json +4 -4
- package/connectors/connect-quo/package.json +4 -4
- package/connectors/connect-reddit/package.json +4 -4
- package/connectors/connect-reducto/package.json +1 -1
- package/connectors/connect-resend/package.json +4 -4
- package/connectors/connect-revolut/package.json +4 -4
- package/connectors/connect-sedo/package.json +4 -4
- package/connectors/connect-sentry/package.json +4 -4
- package/connectors/connect-shadcn/package.json +4 -4
- package/connectors/connect-shopify/package.json +2 -2
- package/connectors/connect-snap/package.json +4 -4
- package/connectors/connect-stabilityai/package.json +4 -4
- package/connectors/connect-stripe/package.json +4 -4
- package/connectors/connect-stripeatlas/package.json +4 -4
- package/connectors/connect-substack/package.json +4 -4
- package/connectors/connect-tiktok/package.json +4 -4
- package/connectors/connect-tinker/package.json +4 -4
- package/connectors/connect-twilio/package.json +6 -6
- package/connectors/connect-uspto/package.json +4 -4
- package/connectors/connect-webflow/package.json +2 -2
- package/connectors/connect-wix/package.json +2 -2
- package/connectors/connect-x/package.json +4 -4
- package/connectors/connect-xads/package.json +4 -4
- package/connectors/connect-xai/package.json +4 -4
- package/connectors/connect-youtube/package.json +4 -4
- package/connectors/connect-zoom/package.json +4 -4
- package/dashboard/dist/assets/index-BZZ_709y.css +1 -0
- package/dashboard/dist/assets/index-CBroKWCD.js +234 -0
- package/dashboard/dist/index.html +13 -0
- package/dashboard/dist/logo.jpg +0 -0
- package/dist/cli/cli.test.d.ts +1 -0
- package/dist/cli/components/App.d.ts +6 -0
- package/dist/cli/components/CategorySelect.d.ts +6 -0
- package/dist/cli/components/ConnectorSelect.d.ts +10 -0
- package/dist/cli/components/Header.d.ts +6 -0
- package/dist/cli/components/InstallProgress.d.ts +8 -0
- package/dist/cli/components/SearchView.d.ts +8 -0
- package/dist/cli/components/components.test.d.ts +1 -0
- package/dist/cli/index.d.ts +2 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.js +11 -16
- package/dist/lib/installer.d.ts +55 -0
- package/dist/lib/installer.test.d.ts +1 -0
- package/dist/lib/registry.d.ts +18 -0
- package/dist/lib/registry.test.d.ts +1 -0
- package/dist/mcp/index.d.ts +2 -0
- package/dist/mcp/mcp.test.d.ts +1 -0
- package/dist/server/auth.d.ts +70 -0
- package/dist/server/dashboard.d.ts +5 -0
- package/dist/server/index.d.ts +6 -0
- package/dist/server/serve.d.ts +12 -0
- package/dist/server/server.test.d.ts +1 -0
- package/package.json +11 -6
- package/connectors/connect-browseruse/.env.example +0 -7
- package/connectors/connect-browseruse/.npmrc.example +0 -2
- package/connectors/connect-browseruse/AGENTS.md +0 -172
- package/connectors/connect-browseruse/CLAUDE.md +0 -172
- package/connectors/connect-browseruse/GEMINI.md +0 -172
- package/connectors/connect-browseruse/README.md +0 -153
- package/connectors/connect-browseruse/package.json +0 -52
- package/connectors/connect-browseruse/src/api/billing.ts +0 -32
- package/connectors/connect-browseruse/src/api/browsers.ts +0 -50
- package/connectors/connect-browseruse/src/api/client.ts +0 -168
- package/connectors/connect-browseruse/src/api/files.ts +0 -70
- package/connectors/connect-browseruse/src/api/index.ts +0 -95
- package/connectors/connect-browseruse/src/api/profiles.ts +0 -59
- package/connectors/connect-browseruse/src/api/sessions.ts +0 -88
- package/connectors/connect-browseruse/src/api/skills.ts +0 -194
- package/connectors/connect-browseruse/src/api/tasks.ts +0 -127
- package/connectors/connect-browseruse/src/cli/index.ts +0 -888
- package/connectors/connect-browseruse/src/index.ts +0 -35
- package/connectors/connect-browseruse/src/types/index.ts +0 -312
- package/connectors/connect-browseruse/src/utils/config.ts +0 -212
- package/connectors/connect-browseruse/src/utils/output.ts +0 -119
- package/connectors/connect-browseruse/tsconfig.json +0 -16
|
@@ -1,172 +0,0 @@
|
|
|
1
|
-
# CLAUDE.md
|
|
2
|
-
|
|
3
|
-
This file provides guidance to Claude Code when working with this repository.
|
|
4
|
-
|
|
5
|
-
## Project Overview
|
|
6
|
-
|
|
7
|
-
connect-browseruse is a TypeScript connector for Browser Use Cloud API (browser-use.com) with multi-profile configuration support. It provides CLI and programmatic access to AI-powered browser automation tasks, sessions, and skills.
|
|
8
|
-
|
|
9
|
-
## Build & Run Commands
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
# Install dependencies
|
|
13
|
-
bun install
|
|
14
|
-
|
|
15
|
-
# Run CLI in development
|
|
16
|
-
bun run dev
|
|
17
|
-
|
|
18
|
-
# Build for distribution
|
|
19
|
-
bun run build
|
|
20
|
-
|
|
21
|
-
# Type check
|
|
22
|
-
bun run typecheck
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
## Code Style
|
|
26
|
-
|
|
27
|
-
- TypeScript with strict mode
|
|
28
|
-
- ESM modules (`type: module`)
|
|
29
|
-
- Async/await for all async operations
|
|
30
|
-
- Minimal dependencies: commander, chalk
|
|
31
|
-
- Type annotations required everywhere
|
|
32
|
-
|
|
33
|
-
## Project Structure
|
|
34
|
-
|
|
35
|
-
```
|
|
36
|
-
src/
|
|
37
|
-
├── api/ # API client modules
|
|
38
|
-
│ ├── client.ts # HTTP client with authentication
|
|
39
|
-
│ └── index.ts # Main connector class
|
|
40
|
-
├── cli/
|
|
41
|
-
│ └── index.ts # CLI commands
|
|
42
|
-
├── types/
|
|
43
|
-
│ └── index.ts # TypeScript types
|
|
44
|
-
├── utils/
|
|
45
|
-
│ ├── config.ts # Multi-profile configuration
|
|
46
|
-
│ └── output.ts # CLI output formatting
|
|
47
|
-
└── index.ts # Library exports
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
## Authentication
|
|
51
|
-
|
|
52
|
-
Bearer Token authentication. Credentials can be set via:
|
|
53
|
-
- Environment variable (see below)
|
|
54
|
-
- Profile configuration: `connect-browseruse config set-key <key>`
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
## Key Patterns
|
|
58
|
-
|
|
59
|
-
### Multi-Profile Configuration
|
|
60
|
-
|
|
61
|
-
Profiles stored in `~/.connect/connect-browseruse/profiles/`:
|
|
62
|
-
- Each profile is a separate JSON file
|
|
63
|
-
- `current_profile` file tracks active profile
|
|
64
|
-
- `--profile` flag overrides for single command
|
|
65
|
-
- Environment variables override profile config
|
|
66
|
-
|
|
67
|
-
### Authentication
|
|
68
|
-
|
|
69
|
-
Uses Bearer token authentication for all requests. API key can be set via:
|
|
70
|
-
- Environment variable: `BROWSER_USE_API_KEY`
|
|
71
|
-
- Profile configuration: `connect-browseruse config set api-key <key>`
|
|
72
|
-
|
|
73
|
-
### Service APIs
|
|
74
|
-
|
|
75
|
-
Each API endpoint has its own module:
|
|
76
|
-
- **TasksApi**: Create, list, get, stop, pause, resume tasks
|
|
77
|
-
- **SessionsApi**: Manage agent sessions with public sharing
|
|
78
|
-
- **ProfilesApi**: Browser profiles for persistent state
|
|
79
|
-
- **BrowsersApi**: Direct CDP browser sessions
|
|
80
|
-
- **SkillsApi**: User-created skills
|
|
81
|
-
- **MarketplaceApi**: Browse and discover marketplace skills
|
|
82
|
-
- **FilesApi**: Upload/download files via presigned URLs
|
|
83
|
-
- **BillingApi**: Account credits and plan info
|
|
84
|
-
|
|
85
|
-
## CLI Commands
|
|
86
|
-
|
|
87
|
-
### Tasks
|
|
88
|
-
```bash
|
|
89
|
-
connect-browseruse tasks list # List all tasks
|
|
90
|
-
connect-browseruse tasks create "Search for AI" # Create new task
|
|
91
|
-
connect-browseruse tasks get <id> # Get task details
|
|
92
|
-
connect-browseruse tasks stop <id> # Stop running task
|
|
93
|
-
connect-browseruse tasks pause <id> # Pause task
|
|
94
|
-
connect-browseruse tasks resume <id> # Resume paused task
|
|
95
|
-
connect-browseruse tasks logs <id> # View task logs
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
### Sessions
|
|
99
|
-
```bash
|
|
100
|
-
connect-browseruse sessions list # List sessions
|
|
101
|
-
connect-browseruse sessions get <id> # Get session details
|
|
102
|
-
connect-browseruse sessions create # Create new session
|
|
103
|
-
connect-browseruse sessions delete <id> # Delete session
|
|
104
|
-
connect-browseruse sessions share <id> # Create public share
|
|
105
|
-
connect-browseruse sessions unshare <id> # Remove public share
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
### Browser Profiles
|
|
109
|
-
```bash
|
|
110
|
-
connect-browseruse profiles list # List browser profiles
|
|
111
|
-
connect-browseruse profiles get <id> # Get profile details
|
|
112
|
-
connect-browseruse profiles create --name "My Profile" # Create profile
|
|
113
|
-
connect-browseruse profiles delete <id> # Delete profile
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
### Skills & Marketplace
|
|
117
|
-
```bash
|
|
118
|
-
connect-browseruse skills list # List user skills
|
|
119
|
-
connect-browseruse skills get <id> # Get skill details
|
|
120
|
-
connect-browseruse skills create --name "Login" --parameter "url:string" # Create skill
|
|
121
|
-
connect-browseruse skills delete <id> # Delete skill
|
|
122
|
-
connect-browseruse skills run <id> -p '{"url":"example.com"}' # Run skill
|
|
123
|
-
|
|
124
|
-
connect-browseruse marketplace list # List marketplace skills
|
|
125
|
-
connect-browseruse marketplace get <id> # Get marketplace skill
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
### Billing
|
|
129
|
-
```bash
|
|
130
|
-
connect-browseruse billing show # Show billing info
|
|
131
|
-
connect-browseruse billing credits # Show credit balance
|
|
132
|
-
connect-browseruse billing plan # Show current plan
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
### Quick Run
|
|
136
|
-
```bash
|
|
137
|
-
connect-browseruse run "Navigate to google.com" # Quick task execution
|
|
138
|
-
connect-browseruse run "Search for news" --timeout 120000
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
### Profile & Config
|
|
142
|
-
```bash
|
|
143
|
-
connect-browseruse profile list # List profiles
|
|
144
|
-
connect-browseruse profile use <name> # Switch profile
|
|
145
|
-
connect-browseruse profile create <name> # Create profile
|
|
146
|
-
connect-browseruse profile delete <name> # Delete profile
|
|
147
|
-
connect-browseruse config set api-key <key> # Set API key
|
|
148
|
-
connect-browseruse config set base-url <url> # Set base URL
|
|
149
|
-
connect-browseruse config show # Show current config
|
|
150
|
-
```
|
|
151
|
-
|
|
152
|
-
## Environment Variables
|
|
153
|
-
|
|
154
|
-
| Variable | Description |
|
|
155
|
-
|----------|-------------|
|
|
156
|
-
| `BROWSER_USE_API_KEY` | Browser Use API key (overrides profile) |
|
|
157
|
-
| `BROWSER_USE_BASE_URL` | Base URL (default: https://api.browser-use.com) |
|
|
158
|
-
|
|
159
|
-
## Data Storage
|
|
160
|
-
|
|
161
|
-
```
|
|
162
|
-
~/.connect/connect-browseruse/
|
|
163
|
-
├── current_profile # Active profile name
|
|
164
|
-
└── profiles/
|
|
165
|
-
├── default.json # Default profile
|
|
166
|
-
└── {name}.json # Named profiles
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
## Dependencies
|
|
170
|
-
|
|
171
|
-
- commander: CLI framework
|
|
172
|
-
- chalk: Terminal styling
|
|
@@ -1,172 +0,0 @@
|
|
|
1
|
-
# GEMINI.md
|
|
2
|
-
|
|
3
|
-
This file provides guidance to Gemini when working with this repository.
|
|
4
|
-
|
|
5
|
-
## Project Overview
|
|
6
|
-
|
|
7
|
-
connect-browseruse is a TypeScript connector for Browser Use Cloud API (browser-use.com) with multi-profile configuration support. It provides CLI and programmatic access to AI-powered browser automation tasks, sessions, and skills.
|
|
8
|
-
|
|
9
|
-
## Build & Run Commands
|
|
10
|
-
|
|
11
|
-
```bash
|
|
12
|
-
# Install dependencies
|
|
13
|
-
bun install
|
|
14
|
-
|
|
15
|
-
# Run CLI in development
|
|
16
|
-
bun run dev
|
|
17
|
-
|
|
18
|
-
# Build for distribution
|
|
19
|
-
bun run build
|
|
20
|
-
|
|
21
|
-
# Type check
|
|
22
|
-
bun run typecheck
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
## Code Style
|
|
26
|
-
|
|
27
|
-
- TypeScript with strict mode
|
|
28
|
-
- ESM modules (`type: module`)
|
|
29
|
-
- Async/await for all async operations
|
|
30
|
-
- Minimal dependencies: commander, chalk
|
|
31
|
-
- Type annotations required everywhere
|
|
32
|
-
|
|
33
|
-
## Project Structure
|
|
34
|
-
|
|
35
|
-
```
|
|
36
|
-
src/
|
|
37
|
-
├── api/ # API client modules
|
|
38
|
-
│ ├── client.ts # HTTP client with authentication
|
|
39
|
-
│ └── index.ts # Main connector class
|
|
40
|
-
├── cli/
|
|
41
|
-
│ └── index.ts # CLI commands
|
|
42
|
-
├── types/
|
|
43
|
-
│ └── index.ts # TypeScript types
|
|
44
|
-
├── utils/
|
|
45
|
-
│ ├── config.ts # Multi-profile configuration
|
|
46
|
-
│ └── output.ts # CLI output formatting
|
|
47
|
-
└── index.ts # Library exports
|
|
48
|
-
```
|
|
49
|
-
|
|
50
|
-
## Authentication
|
|
51
|
-
|
|
52
|
-
Bearer Token authentication. Credentials can be set via:
|
|
53
|
-
- Environment variable (see below)
|
|
54
|
-
- Profile configuration: `connect-browseruse config set-key <key>`
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
## Key Patterns
|
|
58
|
-
|
|
59
|
-
### Multi-Profile Configuration
|
|
60
|
-
|
|
61
|
-
Profiles stored in `~/.connect/connect-browseruse/profiles/`:
|
|
62
|
-
- Each profile is a separate JSON file
|
|
63
|
-
- `current_profile` file tracks active profile
|
|
64
|
-
- `--profile` flag overrides for single command
|
|
65
|
-
- Environment variables override profile config
|
|
66
|
-
|
|
67
|
-
### Authentication
|
|
68
|
-
|
|
69
|
-
Uses Bearer token authentication for all requests. API key can be set via:
|
|
70
|
-
- Environment variable: `BROWSER_USE_API_KEY`
|
|
71
|
-
- Profile configuration: `connect-browseruse config set api-key <key>`
|
|
72
|
-
|
|
73
|
-
### Service APIs
|
|
74
|
-
|
|
75
|
-
Each API endpoint has its own module:
|
|
76
|
-
- **TasksApi**: Create, list, get, stop, pause, resume tasks
|
|
77
|
-
- **SessionsApi**: Manage agent sessions with public sharing
|
|
78
|
-
- **ProfilesApi**: Browser profiles for persistent state
|
|
79
|
-
- **BrowsersApi**: Direct CDP browser sessions
|
|
80
|
-
- **SkillsApi**: User-created skills
|
|
81
|
-
- **MarketplaceApi**: Browse and discover marketplace skills
|
|
82
|
-
- **FilesApi**: Upload/download files via presigned URLs
|
|
83
|
-
- **BillingApi**: Account credits and plan info
|
|
84
|
-
|
|
85
|
-
## CLI Commands
|
|
86
|
-
|
|
87
|
-
### Tasks
|
|
88
|
-
```bash
|
|
89
|
-
connect-browseruse tasks list # List all tasks
|
|
90
|
-
connect-browseruse tasks create "Search for AI" # Create new task
|
|
91
|
-
connect-browseruse tasks get <id> # Get task details
|
|
92
|
-
connect-browseruse tasks stop <id> # Stop running task
|
|
93
|
-
connect-browseruse tasks pause <id> # Pause task
|
|
94
|
-
connect-browseruse tasks resume <id> # Resume paused task
|
|
95
|
-
connect-browseruse tasks logs <id> # View task logs
|
|
96
|
-
```
|
|
97
|
-
|
|
98
|
-
### Sessions
|
|
99
|
-
```bash
|
|
100
|
-
connect-browseruse sessions list # List sessions
|
|
101
|
-
connect-browseruse sessions get <id> # Get session details
|
|
102
|
-
connect-browseruse sessions create # Create new session
|
|
103
|
-
connect-browseruse sessions delete <id> # Delete session
|
|
104
|
-
connect-browseruse sessions share <id> # Create public share
|
|
105
|
-
connect-browseruse sessions unshare <id> # Remove public share
|
|
106
|
-
```
|
|
107
|
-
|
|
108
|
-
### Browser Profiles
|
|
109
|
-
```bash
|
|
110
|
-
connect-browseruse profiles list # List browser profiles
|
|
111
|
-
connect-browseruse profiles get <id> # Get profile details
|
|
112
|
-
connect-browseruse profiles create --name "My Profile" # Create profile
|
|
113
|
-
connect-browseruse profiles delete <id> # Delete profile
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
### Skills & Marketplace
|
|
117
|
-
```bash
|
|
118
|
-
connect-browseruse skills list # List user skills
|
|
119
|
-
connect-browseruse skills get <id> # Get skill details
|
|
120
|
-
connect-browseruse skills create --name "Login" --parameter "url:string" # Create skill
|
|
121
|
-
connect-browseruse skills delete <id> # Delete skill
|
|
122
|
-
connect-browseruse skills run <id> -p '{"url":"example.com"}' # Run skill
|
|
123
|
-
|
|
124
|
-
connect-browseruse marketplace list # List marketplace skills
|
|
125
|
-
connect-browseruse marketplace get <id> # Get marketplace skill
|
|
126
|
-
```
|
|
127
|
-
|
|
128
|
-
### Billing
|
|
129
|
-
```bash
|
|
130
|
-
connect-browseruse billing show # Show billing info
|
|
131
|
-
connect-browseruse billing credits # Show credit balance
|
|
132
|
-
connect-browseruse billing plan # Show current plan
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
### Quick Run
|
|
136
|
-
```bash
|
|
137
|
-
connect-browseruse run "Navigate to google.com" # Quick task execution
|
|
138
|
-
connect-browseruse run "Search for news" --timeout 120000
|
|
139
|
-
```
|
|
140
|
-
|
|
141
|
-
### Profile & Config
|
|
142
|
-
```bash
|
|
143
|
-
connect-browseruse profile list # List profiles
|
|
144
|
-
connect-browseruse profile use <name> # Switch profile
|
|
145
|
-
connect-browseruse profile create <name> # Create profile
|
|
146
|
-
connect-browseruse profile delete <name> # Delete profile
|
|
147
|
-
connect-browseruse config set api-key <key> # Set API key
|
|
148
|
-
connect-browseruse config set base-url <url> # Set base URL
|
|
149
|
-
connect-browseruse config show # Show current config
|
|
150
|
-
```
|
|
151
|
-
|
|
152
|
-
## Environment Variables
|
|
153
|
-
|
|
154
|
-
| Variable | Description |
|
|
155
|
-
|----------|-------------|
|
|
156
|
-
| `BROWSER_USE_API_KEY` | Browser Use API key (overrides profile) |
|
|
157
|
-
| `BROWSER_USE_BASE_URL` | Base URL (default: https://api.browser-use.com) |
|
|
158
|
-
|
|
159
|
-
## Data Storage
|
|
160
|
-
|
|
161
|
-
```
|
|
162
|
-
~/.connect/connect-browseruse/
|
|
163
|
-
├── current_profile # Active profile name
|
|
164
|
-
└── profiles/
|
|
165
|
-
├── default.json # Default profile
|
|
166
|
-
└── {name}.json # Named profiles
|
|
167
|
-
```
|
|
168
|
-
|
|
169
|
-
## Dependencies
|
|
170
|
-
|
|
171
|
-
- commander: CLI framework
|
|
172
|
-
- chalk: Terminal styling
|
|
@@ -1,153 +0,0 @@
|
|
|
1
|
-
# connect-browseruse
|
|
2
|
-
|
|
3
|
-
Browser Use Cloud API connector CLI - AI-powered browser automation tasks, sessions, and skills
|
|
4
|
-
|
|
5
|
-
## Installation
|
|
6
|
-
|
|
7
|
-
```bash
|
|
8
|
-
bun install -g @hasna/connect-browseruse
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Quick Start
|
|
12
|
-
|
|
13
|
-
```bash
|
|
14
|
-
# Set your API key
|
|
15
|
-
connect-browseruse config set-key YOUR_API_KEY
|
|
16
|
-
|
|
17
|
-
# Or use environment variable
|
|
18
|
-
export BROWSER_USE_API_KEY=YOUR_API_KEY
|
|
19
|
-
```
|
|
20
|
-
|
|
21
|
-
## CLI Commands
|
|
22
|
-
|
|
23
|
-
### Tasks
|
|
24
|
-
```bash
|
|
25
|
-
connect-browseruse tasks list # List all tasks
|
|
26
|
-
connect-browseruse tasks create "Search for AI" # Create new task
|
|
27
|
-
connect-browseruse tasks get <id> # Get task details
|
|
28
|
-
connect-browseruse tasks stop <id> # Stop running task
|
|
29
|
-
connect-browseruse tasks pause <id> # Pause task
|
|
30
|
-
connect-browseruse tasks resume <id> # Resume paused task
|
|
31
|
-
connect-browseruse tasks logs <id> # View task logs
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
### Sessions
|
|
35
|
-
```bash
|
|
36
|
-
connect-browseruse sessions list # List sessions
|
|
37
|
-
connect-browseruse sessions get <id> # Get session details
|
|
38
|
-
connect-browseruse sessions create # Create new session
|
|
39
|
-
connect-browseruse sessions delete <id> # Delete session
|
|
40
|
-
connect-browseruse sessions share <id> # Create public share
|
|
41
|
-
connect-browseruse sessions unshare <id> # Remove public share
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
### Browser Profiles
|
|
45
|
-
```bash
|
|
46
|
-
connect-browseruse profiles list # List browser profiles
|
|
47
|
-
connect-browseruse profiles get <id> # Get profile details
|
|
48
|
-
connect-browseruse profiles create --name "My Profile" # Create profile
|
|
49
|
-
connect-browseruse profiles delete <id> # Delete profile
|
|
50
|
-
```
|
|
51
|
-
|
|
52
|
-
### Skills & Marketplace
|
|
53
|
-
```bash
|
|
54
|
-
connect-browseruse skills list # List user skills
|
|
55
|
-
connect-browseruse skills get <id> # Get skill details
|
|
56
|
-
connect-browseruse skills create --name "Login" --parameter "url:string" # Create skill
|
|
57
|
-
connect-browseruse skills delete <id> # Delete skill
|
|
58
|
-
connect-browseruse skills run <id> -p '{"url":"example.com"}' # Run skill
|
|
59
|
-
|
|
60
|
-
connect-browseruse marketplace list # List marketplace skills
|
|
61
|
-
connect-browseruse marketplace get <id> # Get marketplace skill
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
### Billing
|
|
65
|
-
```bash
|
|
66
|
-
connect-browseruse billing show # Show billing info
|
|
67
|
-
connect-browseruse billing credits # Show credit balance
|
|
68
|
-
connect-browseruse billing plan # Show current plan
|
|
69
|
-
```
|
|
70
|
-
|
|
71
|
-
### Quick Run
|
|
72
|
-
```bash
|
|
73
|
-
connect-browseruse run "Navigate to google.com" # Quick task execution
|
|
74
|
-
connect-browseruse run "Search for news" --timeout 120000
|
|
75
|
-
```
|
|
76
|
-
|
|
77
|
-
### Profile & Config
|
|
78
|
-
```bash
|
|
79
|
-
connect-browseruse profile list # List profiles
|
|
80
|
-
connect-browseruse profile use <name> # Switch profile
|
|
81
|
-
connect-browseruse profile create <name> # Create profile
|
|
82
|
-
connect-browseruse profile delete <name> # Delete profile
|
|
83
|
-
connect-browseruse config set api-key <key> # Set API key
|
|
84
|
-
connect-browseruse config set base-url <url> # Set base URL
|
|
85
|
-
connect-browseruse config show # Show current config
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
## Profile Management
|
|
89
|
-
|
|
90
|
-
```bash
|
|
91
|
-
# Create profiles for different accounts
|
|
92
|
-
connect-browseruse profile create work --api-key xxx --use
|
|
93
|
-
connect-browseruse profile create personal --api-key yyy
|
|
94
|
-
|
|
95
|
-
# Switch profiles
|
|
96
|
-
connect-browseruse profile use work
|
|
97
|
-
|
|
98
|
-
# Use profile for single command
|
|
99
|
-
connect-browseruse -p personal <command>
|
|
100
|
-
|
|
101
|
-
# List profiles
|
|
102
|
-
connect-browseruse profile list
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
## Library Usage
|
|
106
|
-
|
|
107
|
-
```typescript
|
|
108
|
-
import { Browseruse } from '@hasna/connect-browseruse';
|
|
109
|
-
|
|
110
|
-
const client = new Browseruse({ apiKey: 'YOUR_API_KEY' });
|
|
111
|
-
|
|
112
|
-
// Use the client
|
|
113
|
-
// See CLAUDE.md for detailed API documentation
|
|
114
|
-
```
|
|
115
|
-
|
|
116
|
-
## Environment Variables
|
|
117
|
-
|
|
118
|
-
| Variable | Description |
|
|
119
|
-
|----------|-------------|
|
|
120
|
-
| `BROWSER_USE_API_KEY` | Browser Use API key (overrides profile) |
|
|
121
|
-
| `BROWSER_USE_BASE_URL` | Base URL (default: https://api.browser-use.com) |
|
|
122
|
-
|
|
123
|
-
## Data Storage
|
|
124
|
-
|
|
125
|
-
Configuration stored in `~/.connect/connect-browseruse/`:
|
|
126
|
-
|
|
127
|
-
```
|
|
128
|
-
~/.connect/connect-browseruse/
|
|
129
|
-
├── current_profile # Active profile name
|
|
130
|
-
└── profiles/
|
|
131
|
-
├── default.json # Default profile
|
|
132
|
-
└── {name}.json # Named profiles
|
|
133
|
-
```
|
|
134
|
-
|
|
135
|
-
## Development
|
|
136
|
-
|
|
137
|
-
```bash
|
|
138
|
-
# Install dependencies
|
|
139
|
-
bun install
|
|
140
|
-
|
|
141
|
-
# Run CLI in development
|
|
142
|
-
bun run dev
|
|
143
|
-
|
|
144
|
-
# Build
|
|
145
|
-
bun run build
|
|
146
|
-
|
|
147
|
-
# Type check
|
|
148
|
-
bun run typecheck
|
|
149
|
-
```
|
|
150
|
-
|
|
151
|
-
## License
|
|
152
|
-
|
|
153
|
-
MIT
|
|
@@ -1,52 +0,0 @@
|
|
|
1
|
-
{
|
|
2
|
-
"name": "@hasna/connect-browseruse",
|
|
3
|
-
"version": "0.0.2",
|
|
4
|
-
"description": "Browser Use Cloud API connector CLI - AI-powered browser automation tasks, sessions, and skills",
|
|
5
|
-
"type": "module",
|
|
6
|
-
"bin": {
|
|
7
|
-
"connect-browseruse": "./bin/index.js"
|
|
8
|
-
},
|
|
9
|
-
"exports": {
|
|
10
|
-
".": {
|
|
11
|
-
"import": "./dist/index.js",
|
|
12
|
-
"types": "./dist/index.d.ts"
|
|
13
|
-
}
|
|
14
|
-
},
|
|
15
|
-
"main": "./dist/index.js",
|
|
16
|
-
"types": "./dist/index.d.ts",
|
|
17
|
-
"scripts": {
|
|
18
|
-
"build": "bun build ./src/index.ts --outdir ./dist --target bun && bun build ./src/cli/index.ts --outdir ./bin --target bun",
|
|
19
|
-
"dev": "bun run ./src/cli/index.ts",
|
|
20
|
-
"typecheck": "tsc --noEmit",
|
|
21
|
-
"prepublishOnly": "bun run build"
|
|
22
|
-
},
|
|
23
|
-
"keywords": [
|
|
24
|
-
"browser-use",
|
|
25
|
-
"browser",
|
|
26
|
-
"automation",
|
|
27
|
-
"ai-agent",
|
|
28
|
-
"web-scraping",
|
|
29
|
-
"connector",
|
|
30
|
-
"cli",
|
|
31
|
-
"typescript",
|
|
32
|
-
"bun",
|
|
33
|
-
"hasna"
|
|
34
|
-
],
|
|
35
|
-
"author": "Hasna",
|
|
36
|
-
"license": "MIT",
|
|
37
|
-
"devDependencies": {
|
|
38
|
-
"@types/bun": "latest",
|
|
39
|
-
"typescript": "^5"
|
|
40
|
-
},
|
|
41
|
-
"dependencies": {
|
|
42
|
-
"commander": "^12.1.0",
|
|
43
|
-
"chalk": "^5.3.0"
|
|
44
|
-
},
|
|
45
|
-
"engines": {
|
|
46
|
-
"bun": ">=1.0.0"
|
|
47
|
-
},
|
|
48
|
-
"repository": {
|
|
49
|
-
"type": "git",
|
|
50
|
-
"url": "git+https://github.com/hasna/opensource-connectors.git"
|
|
51
|
-
}
|
|
52
|
-
}
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
import type { BrowserUseClient } from './client';
|
|
2
|
-
import type { AccountBilling } from '../types';
|
|
3
|
-
|
|
4
|
-
/**
|
|
5
|
-
* Billing API
|
|
6
|
-
*/
|
|
7
|
-
export class BillingApi {
|
|
8
|
-
constructor(private client: BrowserUseClient) {}
|
|
9
|
-
|
|
10
|
-
/**
|
|
11
|
-
* Get account billing information
|
|
12
|
-
*/
|
|
13
|
-
async getAccount(): Promise<AccountBilling> {
|
|
14
|
-
return this.client.get<AccountBilling>('/v2/billing');
|
|
15
|
-
}
|
|
16
|
-
|
|
17
|
-
/**
|
|
18
|
-
* Get current credit balance
|
|
19
|
-
*/
|
|
20
|
-
async getCredits(): Promise<number> {
|
|
21
|
-
const account = await this.getAccount();
|
|
22
|
-
return account.credits;
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
/**
|
|
26
|
-
* Get current plan
|
|
27
|
-
*/
|
|
28
|
-
async getPlan(): Promise<string> {
|
|
29
|
-
const account = await this.getAccount();
|
|
30
|
-
return account.plan;
|
|
31
|
-
}
|
|
32
|
-
}
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
import type { BrowserUseClient } from './client';
|
|
2
|
-
import type {
|
|
3
|
-
BrowserSession,
|
|
4
|
-
CreateBrowserSessionParams,
|
|
5
|
-
ListBrowserSessionsParams,
|
|
6
|
-
PaginatedResponse,
|
|
7
|
-
} from '../types';
|
|
8
|
-
|
|
9
|
-
/**
|
|
10
|
-
* Browsers API (Direct CDP browser sessions)
|
|
11
|
-
*/
|
|
12
|
-
export class BrowsersApi {
|
|
13
|
-
constructor(private client: BrowserUseClient) {}
|
|
14
|
-
|
|
15
|
-
/**
|
|
16
|
-
* List all browser sessions
|
|
17
|
-
*/
|
|
18
|
-
async list(params?: ListBrowserSessionsParams): Promise<PaginatedResponse<BrowserSession>> {
|
|
19
|
-
return this.client.get<PaginatedResponse<BrowserSession>>('/v2/browsers', {
|
|
20
|
-
limit: params?.limit,
|
|
21
|
-
cursor: params?.cursor,
|
|
22
|
-
});
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
/**
|
|
26
|
-
* Create a new browser session
|
|
27
|
-
*/
|
|
28
|
-
async create(params?: CreateBrowserSessionParams): Promise<BrowserSession> {
|
|
29
|
-
return this.client.post<BrowserSession>('/v2/browsers', {
|
|
30
|
-
profile_id: params?.profileId,
|
|
31
|
-
proxy_url: params?.proxyUrl,
|
|
32
|
-
});
|
|
33
|
-
}
|
|
34
|
-
|
|
35
|
-
/**
|
|
36
|
-
* Get a browser session by ID
|
|
37
|
-
*/
|
|
38
|
-
async get(browserId: string): Promise<BrowserSession> {
|
|
39
|
-
return this.client.get<BrowserSession>(`/v2/browsers/${browserId}`);
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
/**
|
|
43
|
-
* Stop a browser session
|
|
44
|
-
*/
|
|
45
|
-
async stop(browserId: string): Promise<BrowserSession> {
|
|
46
|
-
return this.client.patch<BrowserSession>(`/v2/browsers/${browserId}`, {
|
|
47
|
-
action: 'stop',
|
|
48
|
-
});
|
|
49
|
-
}
|
|
50
|
-
}
|