diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..ce0b6bc --- /dev/null +++ b/README.en.md @@ -0,0 +1,125 @@ +# Page Agent + + + + Page Agent Banner + + +[![CI](https://img.shields.io/github/actions/workflow/status/alibaba/page-agent/main-ci.yml?branch=main&style=flat-square&label=ci)](https://github.com/alibaba/page-agent/actions/workflows/main-ci.yml) +[![npm](https://img.shields.io/npm/v/page-agent?style=flat-square&label=npm)](https://www.npmjs.com/package/page-agent) +[![downloads](https://img.shields.io/npm/dt/page-agent?style=flat-square)](https://www.npmjs.com/package/page-agent) +[![size](https://img.shields.io/bundlephobia/minzip/page-agent?style=flat-square&label=size)](https://bundlephobia.com/package/page-agent) +[![license](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](https://opensource.org/licenses/MIT) +[![typescript](https://img.shields.io/badge/%3C%2F%3E-typescript-blue?style=flat-square)](http://www.typescriptlang.org/) +[![Chrome Web Store Rating](https://img.shields.io/chrome-web-store/rating/akldabonmimlicnjlflnapfeklbfemhj?style=flat-square&label=chrome%20rating)](https://chromewebstore.google.com/detail/page-agent-ext/akldabonmimlicnjlflnapfeklbfemhj) +[![GitHub stars](https://img.shields.io/github/stars/alibaba/page-agent.svg)](https://github.com/alibaba/page-agent) + +The GUI Agent Living in Your Webpage. One script gives any web page its own AI agent. + +alibaba%2Fpage-agent | Trendshift + +🌐 **English** | [δΈ­ζ–‡](./docs/README-zh.md) + +πŸš€ Demo | πŸ“– Docs | πŸ“’ HN Discussion | 𝕏 Follow on X + + + +[![Watch the demo](https://page-agent.github.io/assets/readme/poster.jpg)](https://github.com/user-attachments/assets/a1f2eae2-13fb-4aae-98cf-a3fc1620a6c2) + +--- + +## ✨ Features + +- **🎯 Easy integration** + - No need for `browser extension` / `python` / `headless browser`. + - Just in-page javascript. Everything happens in your web page. +- **πŸ“– Text-based DOM manipulation** + - No screenshots. No multi-modal LLMs or special permissions needed. +- **🧠 Bring your own LLMs** + - Works with most mainstream models, including locally deployed ones. See [supported models](https://alibaba.github.io/page-agent/docs/features/models). +- **πŸ™ Optional [chrome extension](https://alibaba.github.io/page-agent/docs/features/chrome-extension) for multi-page tasks.** + - And an [MCP Server (Beta)](https://alibaba.github.io/page-agent/docs/features/mcp-server) to control it from outside + +## πŸ’‘ Use Cases + +- **SaaS AI Copilot** β€” Ship an AI copilot in your product in lines of code. No backend rewrite. +- **Smart Form Filling** β€” Turn 20-click workflows into one sentence. Perfect for ERP, CRM, and admin systems. +- **Accessibility** β€” Make any web app accessible through natural language. Voice commands, screen readers, zero barrier. +- **Multi-page Agent** β€” Extend your own web agent's reach across browser tabs via the [Chrome extension](https://alibaba.github.io/page-agent/docs/features/chrome-extension). +- **MCP** - Allow your agent clients to control your browser. + +## πŸš€ Quick Start + +### One-line integration + +Fastest way to try PageAgent with our free Demo LLM: + +```html + +``` + +> **⚠️ For technical evaluation only.** This demo CDN uses our free [testing LLM API](https://alibaba.github.io/page-agent/docs/features/models#free-testing-api). By using it, you agree to its [terms](https://github.com/alibaba/page-agent/blob/main/docs/terms-and-privacy.md). +> Add `?autoInit=false` to load the script without creating the demo agent automatically. You can then instantiate it with `new window.PageAgent(...)`. + +| Mirrors | URL | +| ------- | ----------------------------------------------------------------------------------- | +| Global | https://cdn.jsdelivr.net/npm/page-agent@1.12.1/dist/iife/page-agent.demo.js | +| China | https://registry.npmmirror.com/page-agent/1.12.1/files/dist/iife/page-agent.demo.js | + +### NPM Installation + +```bash +npm install page-agent +``` + +```javascript +import { PageAgent } from 'page-agent' + +const agent = new PageAgent({ + model: 'qwen3.5-plus', + baseURL: 'https://dashscope.aliyuncs.com/compatible-mode/v1', + apiKey: 'YOUR_API_KEY', + language: 'en-US', +}) + +await agent.execute('Click the login button') +``` + +For more programmatic usage, see [πŸ“– Documentations](https://alibaba.github.io/page-agent/docs/introduction/overview). + +## 🀝 Contributing + +We welcome contributions from the community! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines and [docs/developer-guide.md](docs/developer-guide.md) for local development workflows. + +Built something cool with PageAgent? Share it in [Show and Tell](https://github.com/alibaba/page-agent/discussions/categories/show-and-tell). πŸ™Œ + +Please read the [maintainer's note](https://github.com/alibaba/page-agent/issues/349) on principles and current state. + +Contributions generated entirely by **bots or AI** without substantial human involvement will **not be accepted**. + +## βš–οΈ License + +[MIT License](LICENSE) + +## πŸ‘ Acknowledgments + +This project builds upon the excellent work of **[`browser-use`](https://github.com/browser-use/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 + +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. +``` + +**⭐ Star this repo if you find PageAgent helpful!**