Skip to main content

VibeSurf: A powerful browser assistant for vibe surfing

Project description

VibeSurf: A powerful browser assistant for vibe surfing

Discord WeChat WarmShao

VibeSurf is an open-source AI agentic browser that revolutionizes browser automation and research.

If you're as excited about open-source AI browsing as I am, give it a star! ⭐

中文 | English

✨ Key Features

  • 🧠 Advanced AI Automation: Beyond browser automation, VibeSurf performs deep research, intelligent crawling, content summarization, and more to exploration.

  • 🚀 Multi-Agent Parallel Processing: Run multiple AI agents simultaneously in different browser tabs, enabling both deep research and wide research with massive efficiency gains.

  • 🔄 Agentic Browser Workflow: Create custom drag-and-drop and conversation-based workflows that combine deterministic automation with AI intelligence - perfect for repetitive tasks like auto-login, data collection, and social media posting.

  • 🎨 Seamless Chrome Extension UI: Native browser integration without switching applications, providing an intuitive interface that feels like part of your browser.

  • 🔒 Privacy-First LLM Support: Supports local LLMs (Ollama, etc.) and custom LLM APIs to ensure your browsing data stays private and secure during vibe surfing.

🚀 Browser Workflow Magic

Why Browser Workflow Matters

🎯 Efficiency First: Most browser operations follow predictable patterns - why rebuild them every time with agents? Workflows let you define once, run forever.

💰 Token Savings: Workflows consume virtually zero tokens, only using them when dynamic information retrieval is needed. Save costs while maintaining intelligence.

Speed & Reliability: Deterministic workflows deliver consistent, fast, and highly accurate results. No more waiting for agents to "think" through repetitive steps.

Your browser does not support playing this video!

👉 Explore Workflow Templates - Get started with pre-built workflows for common tasks!

🛠️ Installation

For Windows users: You can also download and run our one-click installer: VibeSurf-Installer.exe

Note: If you encounter DLL errors related to torch c10.so or onnxruntime during installation, please download and install the Microsoft Visual C++ Redistributable.

Get VibeSurf up and running in just three simple steps. No complex configuration required.

1. Install uv

Install uv package manager from the official website

MacOS/Linux

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

2. Install VibeSurf

Install VibeSurf as a tool

uv tool install vibesurf

Tip: Use uv tool upgrade vibesurf to upgrade to the latest version.

3. Launch VibeSurf

Start the VibeSurf browser assistant

vibesurf

Note: Starting from Chrome 142, the --load-extension flag is no longer supported. When you first start VibeSurf, the browser will show a popup displaying the extension path. To manually load the extension:

  • Open chrome://extensions
  • Enable Developer mode
  • Click "Load unpacked" and navigate to the extension folder

Typical Extension Locations:

  • Windows: C:\Users\<username>\AppData\Roaming\uv\tools\vibesurf\Lib\site-packages\vibe_surf\chrome_extension

  • macOS: ~/.local/share/uv/tools/vibesurf/lib/python3.<version>/site-packages/vibe_surf/chrome_extension (replace <version> with your Python version, e.g., python3.12)

    Tip: Besides the popup, you can also find the extension path in the command line startup logs. For macOS users, press Cmd+Shift+G in Finder, paste the path, and press Enter to navigate directly to the folder.

4. Start to Use

Your browser does not support playing this video!

🐳 Docker (Alternative)

You can also run VibeSurf in Docker with browser VNC access:

Option 1: Using docker-compose (Recommended)

# 1. Edit docker-compose.yml and add your API keys (optional)
# Or create a .env file with your environment variables

# 2. Start VibeSurf
docker-compose up -d

# 3. Access VibeSurf
# - Backend: http://localhost:9335
# - Browser VNC (Web): http://localhost:6080 (Password: vibesurf)

Note: The VNC browser environment defaults to English input. Press Ctrl + Space to switch to Chinese Pinyin input method.

Note: To use a proxy, set the HTTP_PROXY and HTTPS_PROXY environment variables in docker-compose.yml (e.g., HTTP_PROXY: http://proxy.example.com:8080).

Option 2: Using docker run

# Pull the image
docker pull ghcr.io/vibesurf-ai/vibesurf:latest

# Run the container
docker run --name vibesurf -d --restart unless-stopped \
  -p 9335:9335 \
  -p 6080:6080 \
  -p 5901:5901 \
  -v ./data:/data \
  -e IN_DOCKER=true \
  -e VIBESURF_WORKSPACE=/data/vibesurf_workspace \
  -e VNC_PASSWORD=vibesurf \
  --shm-size=4g \
  --cap-add=SYS_ADMIN \
  ghcr.io/vibesurf-ai/vibesurf:latest

👩‍💻 For Contributors

Want to contribute to VibeSurf? Follow these steps to set up your development environment:

1. Clone Repository

git clone https://github.com/vibesurf-ai/VibeSurf.git
cd VibeSurf

2. Setup Environment

MacOS/Linux

uv venv --python 3.12
source .venv/bin/activate
uv pip install -e .

Windows

uv venv --python 3.12
.venv\Scripts\activate
uv pip install -e .

3. Build Frontend (Optional)

If you're working on frontend changes, you need to build and copy the frontend to the backend directory:

# Navigate to frontend directory
cd vibe_surf/frontend

# Install frontend dependencies
npm ci

# Build the frontend
npm run build

# Copy build output to backend directory
mkdir -p ../backend/frontend
cp -r build/* ../backend/frontend/

4. Start Debugging

Option 1: Direct Server

uvicorn vibe_surf.backend.main:app --host 127.0.0.1 --port 9335

Option 2: CLI Entry

uv run vibesurf

🗺️ Roadmap

We're building VibeSurf to be your ultimate AI browser companion. Here's what's coming next:

  • Smart Skills System - Completed Add /search for quick information search, /crawl for automatic website data extraction and /code for webpage js code execution. Integrated native APIs for Xiaohongshu, Douyin, Weibo, and YouTube.

  • Third-Party Integrations - Completed Connect with hundreds of popular tools including Gmail, Notion, Google Calendar, Slack, Trello, GitHub, and more through Composio integration to combine browsing with powerful automation capabilities

  • Agentic Browser Workflow - Completed Create custom drag-and-drop and conversation-based workflows for auto-login, data collection, and complex browser automation tasks

  • Powerful Coding Agent - In Progress Build a comprehensive coding assistant for data processing and analysis directly in your browser

  • Intelligent Memory & Personalization - Planned Transform VibeSurf into a truly human-like companion with persistent memory that learns your preferences, habits, and browsing patterns over time

🎬 Demo

How to use?

Your browser does not support playing this video!

Dozens of agent running in on browser

Your browser does not support playing this video!

📝 License

This repository is licensed under the VibeSurf Open Source License, based on Apache 2.0 with additional conditions.

👏 Acknowledgments

VibeSurf builds on top of other awesome open-source projects:

Huge thanks to their creators and contributors!

💬 Join Our Community

Welcome to join our WeChat group for discussions!

WeChat Group

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vibesurf-0.5.0.tar.gz (47.9 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vibesurf-0.5.0-py3-none-any.whl (19.4 MB view details)

Uploaded Python 3

File details

Details for the file vibesurf-0.5.0.tar.gz.

File metadata

  • Download URL: vibesurf-0.5.0.tar.gz
  • Upload date:
  • Size: 47.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for vibesurf-0.5.0.tar.gz
Algorithm Hash digest
SHA256 9ea2c047ac158a8e389ecbc6dffb079b5fd96303f788385b2931f6fcae62b4f8
MD5 42b0b35b738f79075b93a635ac9c4560
BLAKE2b-256 25ab30568b2cb07ffe1a3cad8c5fce0d253545c4025f0f8d6d85e71c8aff670d

See more details on using hashes here.

File details

Details for the file vibesurf-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: vibesurf-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 19.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for vibesurf-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 aeaae23a93831a72638df786ab09335cbee44de3e23dcb005757cdc84a573652
MD5 def21253bbab6b455730ef7ba5817ceb
BLAKE2b-256 69aa72155fa7717d10af1cadb1842a59c48a76c253e03e1999f6c0dc66edc65a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page