PageAgent 🤖🪄

The GUI Agent Living in Your Webpage. Control web interfaces with natural language.

🌐 English | 中文

👉 🚀 Demo | 📖 Documentation

✨ Features

🎯 Easy Integration - Transform your webpage into an agent with a single script tag.
🔐 Client-Side Processing
🧠 DOM Extraction
💬 Natural Language Interface
🎨 UI with Human in the loop

🗺️ Roadmap

👉 Roadmap

🚀 Quick Start

Quick Try (With Testing LLM)

Fastest way to try PageAgent:

<script
	src="https://cdn.jsdelivr.net/npm/@page-agent/cdn/dist/page-agent.demo.js"
	crossorigin="true"
></script>

⚠️ For technical evaluation only. Demo model has rate limits and usage restrictions. Use NPM for production.

Mirrors	URL
Global	https://cdn.jsdelivr.net/npm/@page-agent/cdn/dist/page-agent.demo.js
China	https://registry.npmmirror.com/@page-agent/cdn/latest/files/dist/page-agent.demo.js

NPM Installation

npm install page-agent

import { PageAgent } from 'page-agent'

const agent = new PageAgent({
	model: 'deepseek-chat',
	baseURL: 'https://api.deepseek.com',
	apiKey: 'YOUR_API_KEY',
	language: 'en-US',
})

await agent.execute('Click the login button')

For environments where NPM is not available. We do offer a IIFE build via CDN. @see CDN Usage

🏗️ Structure

PageAgent adopts a simplified monorepo structure:

packages/
├── page-agent/          # AI agent (npm: page-agent)
├── llms/                # LLM client (npm: @page-agent/llms)
├── page-controller/     # DOM operations & Visual Mask (npm: @page-agent/page-controller)
├── ui/                  # Panel & i18n (npm: @page-agent/ui)
├── cdn/                 # CDN IIFE builds (npm: @page-agent/cdn)
└── website/             # Demo & Documentation site

🤝 Contributing

We welcome contributions from the community! Here's how to get started:

Fork and clone. git clone https://github.com/alibaba/page-agent.git && cd page-agent
Install dependencies: npm install
Start development: npm start

More details in CONTRIBUTING.md.

Please read our Code of Conduct before contributing.

👏 Acknowledgments

This project builds upon the excellent work of browser-use.

PageAgent is designed for client-side web enhancement, not server-side automation.

DOM processing components and prompt are derived from browser-use:

Browser Use
Copyright (c) 2024 Gregor Zunic
Licensed under the MIT License

Original browser-use project: <https://github.com/browser-use/browser-use>

We gratefully acknowledge the browser-use project and its contributors for their
excellent work on web automation and DOM interaction patterns that helped make
this project possible.

Third-party dependencies and their licenses can be found in the package.json
file and in the node_modules directory after installation.

📄 License

MIT License

⭐ Star this repo if you find PageAgent helpful!

4.4 KiB Raw Blame History