Files
page-agent/README.md

4.5 KiB

PageAgent 🤖🪄

Page Agent Banner

License: MIT TypeScript Downloads Bundle Size GitHub stars

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

🌐 English | 中文

👉 🚀 Demo | 📖 Documentation


Features

  • 🎯 Easy Integration
    • No python. No headless browser. No browser extension. Just in-page scripts.
  • 🔐 Client-Side Processing
  • 🧠 DOM Extraction
  • 💬 Natural Language Interface
  • 🎨 UI with Human in the loop

And 😉

  • 🧪 cross-page control with an experimental chrome extension - packages/extension

👉 🗺️ Roadmap

🚀 Quick Start

One-line integration

Fastest way to try PageAgent with our free Demo LLM:

<script
    src="https://cdn.jsdelivr.net/npm/page-agent@1.0.0/dist/iife/page-agent.demo.js"
    crossorigin="true"
></script>
  • ⚠️ For technical evaluation only. Demo LLM has rate limits and usage restrictions. May change without notice.
  • 🌷 Bring your own LLM API.
Mirrors URL
Global https://cdn.jsdelivr.net/npm/page-agent@1.0.0/dist/iife/page-agent.demo.js
China https://registry.npmmirror.com/page-agent/1.0.0/files/dist/iife/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')

🏗️ Structure

PageAgent adopts a simplified monorepo structure:

packages/
├── core/                # ** Core agent logic without UI(npm: @page-agent/core) **
├── page-agent/          # Exported agent and demo(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)
└── website/             # Demo & Documentation site

🤝 Contributing

We welcome contributions from the community! Follow our instructions in CONTRIBUTING.md for environment setup and local development.

Please read 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!