diff --git a/README.md b/README.md index ce0b6bc..b7d13d2 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,9 @@ + +> [!NOTE] +> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。 +> [English](./README.en.md) · [原始项目](https://github.com/alibaba/page-agent) · [上游 README](https://github.com/alibaba/page-agent/blob/HEAD/README.md) +> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。 + # Page Agent @@ -14,7 +20,7 @@ [![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. +驻留在网页中的 GUI Agent。只需一段脚本，即可为任意网页赋予专属 AI Agent。 alibaba%2Fpage-agent | Trendshift @@ -30,29 +36,29 @@ The GUI Agent Living in Your Webpage. One script gives any web page its own AI a ## ✨ 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 +- **🎯 轻松集成** + - 无需 `browser extension` / `python` / `headless browser`。 + - 纯页面内 JavaScript，一切都在你的网页中完成。 +- **📖 基于文本的 DOM 操作** + - 无需截图，也无需多模态 LLM 或特殊权限。 +- **🧠 自带 LLM（Bring your own LLMs）** + - 兼容大多数主流模型，包括本地部署的模型。请参阅[支持的模型](https://alibaba.github.io/page-agent/docs/features/models). +- **🐙 可选 [Chrome 扩展](https://alibaba.github.io/page-agent/docs/features/chrome-extension)，用于多页面任务。** + - 还提供 [MCP Server（Beta）](https://alibaba.github.io/page-agent/docs/features/mcp-server)，可从外部进行控制 ## 💡 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. +- **SaaS AI Copilot** — 几行代码即可在产品中上线 AI 副驾驶，无需重写后端。 +- **智能表单填写** — 将 20 次点击的工作流压缩为一句话，非常适合 ERP、CRM 和管理系统。 +- **无障碍访问** — 通过自然语言让任意 Web 应用可用：语音指令、屏幕阅读器，零门槛。 +- **多页面 Agent** — 通过 [Chrome 扩展](https://alibaba.github.io/page-agent/docs/features/chrome-extension).，将你的 Web Agent 扩展到多个浏览器标签页。 +- **MCP** — 让你的 Agent 客户端控制浏览器。 ## 🚀 Quick Start -### One-line integration +### 一行集成 -Fastest way to try PageAgent with our free Demo LLM: +使用免费 Demo LLM 体验 PageAgent 的最快方式： ```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(...)`. +> **⚠️ 仅供技术评估。** 此演示 CDN 使用我们免费的[测试 LLM API](https://alibaba.github.io/page-agent/docs/features/models#free-testing-api).。使用即表示你同意其[条款](https://github.com/alibaba/page-agent/blob/main/docs/terms-and-privacy.md). +> 添加 `?autoInit=false` 可在加载脚本时不自动创建演示 Agent。随后可用 `new window.PageAgent(...)` 自行实例化。 -| Mirrors | URL | +| 镜像 | 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 | +| 全球 | https://cdn.jsdelivr.net/npm/page-agent@1.12.1/dist/iife/page-agent.demo.js | +| 中国 | https://registry.npmmirror.com/page-agent/1.12.1/files/dist/iife/page-agent.demo.js | -### NPM Installation +### NPM 安装 ```bash npm install page-agent @@ -88,27 +94,27 @@ const agent = new PageAgent({ await agent.execute('Click the login button') ``` -For more programmatic usage, see [📖 Documentations](https://alibaba.github.io/page-agent/docs/introduction/overview). +更多编程式用法请参阅[📖 文档](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. +欢迎社区贡献！指南请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)，本地开发流程请参阅 [docs/developer-guide.md](docs/developer-guide.md)。 -Built something cool with PageAgent? Share it in [Show and Tell](https://github.com/alibaba/page-agent/discussions/categories/show-and-tell). 🙌 +用 PageAgent 做出了酷东西？欢迎在 [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. +请阅读[维护者说明](https://github.com/alibaba/page-agent/issues/349)，了解原则与当前状态。 -Contributions generated entirely by **bots or AI** without substantial human involvement will **not be accepted**. +完全由**机器人或 AI** 生成、缺乏实质性人工参与的贡献**不会被接受**。 -## ⚖️ License +## ⚖️ 许可证 [MIT License](LICENSE) -## 👏 Acknowledgments +## 👏 致谢 -This project builds upon the excellent work of **[`browser-use`](https://github.com/browser-use/browser-use)**. +本项目建立在 **[`browser-use`](https://github.com/browser-use/browser-use)**. 的优秀工作之上。 -`PageAgent` is designed for **client-side web enhancement**, not server-side automation. +`PageAgent` 面向**客户端 Web 增强**，而非服务端自动化。 ``` DOM processing components and prompt are derived from browser-use: @@ -122,4 +128,4 @@ excellent work on web automation and DOM interaction patterns that helped make this project possible. ``` -**⭐ Star this repo if you find PageAgent helpful!** +**⭐ 如果觉得 PageAgent 有用，欢迎给本仓库点 Star！**