Files
page-agent/README-zh.md

4.6 KiB
Raw Blame History

PageAgent 🤖🪄

Page Agent Banner

License: MIT TypeScript Downloads Bundle Size GitHub stars

纯 JS 实现的 GUI agent。使用自然语言操作你的 Web 应用。无须后端、客户端、浏览器插件。

🌐 English | 中文

👉 🚀 Demo | 📖 Documentation


Features

  • 🎯 轻松集成
    • 无需 Python无需无头浏览器无需浏览器插件。纯页面内脚本。
  • 🔐 端侧运行
  • 🧠 HTML 脱水
  • 💬 自然语言接口
  • 🎨 HITL 交互界面

以及 😉

  • 🧪 实验性的 Chrome 扩展,支持跨页面控制 - -b feat/ext

👉 🗺️ Roadmap

🚀 快速开始

一行代码集成

通过我们免费的 Demo LLM 快速体验 PageAgent

<script
    src="https://registry.npmmirror.com/page-agent/1.0.0-beta.4/files/dist/iife/page-agent.demo.js"
    crossorigin="true"
></script>
  • ⚠️ 仅用于技术评估。 Demo LLM 有速率和使用限制,可能随时变更。
  • 🌷 建议使用自己的 LLM API。
镜像 URL
Global https://cdn.jsdelivr.net/npm/page-agent@1.0.0-beta.4/dist/iife/page-agent.demo.js
China https://registry.npmmirror.com/page-agent/1.0.0-beta.4/files/dist/iife/page-agent.demo.js

NPM 安装

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: 'zh-CN',
})

await agent.execute('点击登录按钮')

适用于无法使用 NPM 的环境,我们也提供了 IIFE 构建的 CDN 方式。@see CDN Usage

🏗️ 架构设计

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 客户端 (npm: @page-agent/llms)
├── page-controller/     # DOM 操作 & 蒙层 & 模拟鼠标 (npm: @page-agent/page-controller)
├── ui/                  # 面板 & i18n (npm: @page-agent/ui)
└── website/             # 文档站点

🤝 贡献

欢迎社区贡献!请参阅 CONTRIBUTING.md 了解环境配置和本地开发说明。

请在贡献前阅读行为准则

👏 致谢

本项目基于 browser-use 的优秀工作构建。

PageAgent 专为客户端网页增强设计,不是服务端自动化工具。

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.

📄 许可证

MIT License


如果觉得 PageAgent 有用或有趣,请给项目点个星!