106 lines
3.0 KiB
Markdown
106 lines
3.0 KiB
Markdown
# PageAgent 🤖🪄
|
||
|
||
> Unfinished Project. See [**Roadmap**](./ROADMAP.md)
|
||
|
||
|
||
|
||
[](https://badge.fury.io/js/page-agent) [](https://opensource.org/licenses/MIT) [](http://www.typescriptlang.org/) [](https://www.npmjs.com/package/page-agent) [](https://bundlephobia.com/package/page-agent) [](https://github.com/alibaba/page-agent)
|
||
|
||
**一行脚本，让任何网页支持 AI 自动化。**
|
||
|
||
运行在页面内的 UI agent. 使用自然语言操作 Web 应用。
|
||
|
||
🌐 [English](./README.md) | **中文**
|
||
|
||
👉 [🚀 **Demo**](https://alibaba.github.io/page-agent/) | [📖 **Documentation**](https://alibaba.github.io/page-agent/#/docs/introduction/overview)
|
||
|
||
---
|
||
|
||
## ✨ Features
|
||
|
||
- **🎯 轻松集成**
|
||
- **🔐 端侧运行**
|
||
- **🧠 HTML 脱水**
|
||
- **💬 自然语言接口**
|
||
- **🎨 HITL 交互界面**
|
||
|
||
## 🗺️ Roadmap
|
||
|
||
👉 [**Roadmap**](./ROADMAP.md)
|
||
|
||
## 🚀 快速开始
|
||
|
||
### CDN 集成
|
||
|
||
> **TODO**: CDN 地址待确定。
|
||
|
||
```html
|
||
<!-- CDN 脚本标签 - URL 待更新 -->
|
||
<script src="TODO-CDN-URL"></script>
|
||
```
|
||
|
||
### NPM 安装
|
||
|
||
```bash
|
||
npm install page-agent
|
||
```
|
||
|
||
```javascript
|
||
import { PageAgent } from 'page-agent'
|
||
|
||
const agent = new PageAgent({
|
||
modelName: 'gpt-4.1-mini',
|
||
baseURL: 'xxxx',
|
||
apiKey: 'xxxx'
|
||
})
|
||
|
||
await agent.execute("点击登录按钮")
|
||
```
|
||
|
||
## 🏗️ 架构设计
|
||
|
||
PageAgent 采用清晰的模块化架构：
|
||
|
||
```
|
||
src/
|
||
├── PageAgent.ts # Agent 主流程
|
||
├── dom/ # DOM 理解
|
||
├── tools/ # 代理交互工具
|
||
├── ui/ # UI 组件和面板
|
||
├── llms/ # LLM 集成层
|
||
└── utils/ # 事件总线和工具
|
||
```
|
||
|
||
## 🤝 贡献
|
||
|
||
欢迎社区贡献！以下是参与方式：
|
||
|
||
### 开发环境
|
||
|
||
1. Fork 项目仓库
|
||
2. Clone or fork: `git clone https://github.com/alibaba/page-agent.git && cd page-agent`
|
||
3. 安装依赖: `npm install`
|
||
4. 启动开发: `npm start`
|
||
|
||
### 贡献指南
|
||
|
||
请在贡献前阅读我们的[行为准则](CODE_OF_CONDUCT.md)和[贡献指南](CONTRIBUTING.md)。
|
||
|
||
## 👏 致谢
|
||
|
||
本项目基于以下优秀项目构建：
|
||
|
||
- **[browser-use](https://github.com/browser-use/browser-use)**
|
||
- **[ai-sdk](https://ai-sdk.dev/)**
|
||
|
||
PageAgent 专为**客户端网页增强**设计，不是服务端自动化工具。
|
||
|
||
## 📄 许可证
|
||
|
||
MIT 许可证 - 详见 [LICENSE](LICENSE) 文件。
|
||
|
||
DOM 处理与提示词参考了 [browser-use](https://github.com/browser-use/browser-use)（MIT 许可证）。完整归属请见 [NOTICE](NOTICE)。
|
||
|
||
---
|
||
|
||
**⭐ 如果觉得 PageAgent 有用或有趣，请给项目点个星！** |