Getting Started

1. Prerequisites

• Google Chrome or Chromium must be installed in your environment and accessible.

2. Install BrowserWing

We provide multiple installation methods. Using a package manager or the one-click script is recommended.

Method A — Via Package Manager (Recommended)

Using npm:

npm install -g browserwing
browserwing --port 8080

Using pnpm:

pnpm add -g browserwing
browserwing --port 8080

Note: The npm package automatically tests GitHub and Gitee mirrors during installation and selects the fastest source for downloading.

Using Homebrew (macOS/Linux):

# Coming soon
brew install browserwing

Method B — One-Click Installation Script

Linux / macOS:

curl -fsSL https://raw.githubusercontent.com/browserwing/browserwing/main/install.sh | bash

Windows (PowerShell):

iwr -useb https://raw.githubusercontent.com/browserwing/browserwing/main/install.ps1 | iex

The script will automatically:

• Detect system and architecture.
• Test GitHub and Gitee mirrors to select the fastest download source.
• Download and extract binary files.
• Add to the PATH environment variable.

Start BrowserWing after installation:

browserwing --port 8080
# Open http://localhost:8080 in your browser

Method C — Manual Download

Download the pre-built binary for your operating system from Releases. If GitHub is slow, you can visit Gitee Releases.

Run Commands:

# Linux/macOS
chmod +x ./browserwing
./browserwing --port 8080

# Windows (PowerShell)
.\browserwing.exe --port 8080

macOS Security Note: macOS users may see a "damaged software" or "unidentified developer" warning. Solution: Go to Settings -> Privacy & Security and click Allow Anyway.

Method D — Build from Source

Suitable for developers or users needing custom features.

# Install dependencies (requires Go and pnpm)
make install

# Build embedded version (frontend embedded in backend)
make build-embedded
./build/browserwing --port 8080

# Or build all targets and package
make build-all
make package

3. Quick Integration with AI Tools

BrowserWing offers three flexible ways to empower your AI models with browser capabilities immediately.

Option 1: MCP Server Integration

Suitable for tools supporting MCP (Model Context Protocol) like Cursor, Claude Desktop, etc.

Configuration:

{
  "mcpServers": {
    "browserwing": {
      "type": "http",
      "url": "http://localhost:8080/api/v1/mcp/message"
    }
  }
}

Add this configuration to your AI tool's MCP settings to enable browser automation.

Option 2: Skills File Integration

Suitable for AI tools supporting the Skills protocol.

1. Start BrowserWing.
2. Download SKILL.md.
3. Import the file into your AI tool's Skills settings.
4. Start automation using natural language commands.

Example Command:

"Visit Amazon, search for 'MacBook', and extract prices of the top 5 items."

Option 3: Direct Use of Built-in AI Agent

BrowserWing comes with a visual AI Agent interface.

1. Open your browser and visit: http://localhost:8080.
2. Go to the AI Agent page.
3. Configure your LLM (supports OpenAI, Claude, DeepSeek, etc.).
   • It is recommended to use models that support Function Calling and have strong performance (like DeepSeek-V3) for stable results.
4. Type your requirements in the chat box to start automation.

4. Advanced Usage

Import and Manage Scripts

You can import existing scripts on the Scripts page or explore more at the Script Marketplace.

Export Custom Scripts

Export recorded scripts as Skills or MCP commands for easy sharing or integration:

curl -X POST 'http://localhost:8080/api/v1/scripts/export/skill' \
  -H 'Content-Type: application/json' \
  -d '{"script_ids": []}' \
  -o MY_CUSTOM_SCRIPTS.md

Platform Login Assistance

For platforms requiring login (e.g., social media sites), it is recommended to:

1. Manually log in using the browser launched by BrowserWing.
2. Or export Cookies from your daily Chrome browser and import them in BrowserWing's Cookie management page.

5. Next Steps

• Explore Core Concepts to understand how BrowserWing works.
• Check the Configuration Guide for more detailed settings.
• Join the Community for more help.