autoglm.js 0.0.1

package/LICENSE.md

@@ -0,0 +1,230 @@
+MIT License
+
+Copyright (c) 2025-PRESENT FliPPeDround <https://github.com/flippedround>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+# Open-AutoGLM
+
+License: Apache 2.0
+By: zai-org
+Repository: https://github.com/zai-org/Open-AutoGLM
+
+
+>                                  Apache License
+>                            Version 2.0, January 2004
+>                         http://www.apache.org/licenses/
+>
+>    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+>
+>    1. Definitions.
+>
+>       "License" shall mean the terms and conditions for use, reproduction,
+>       and distribution as defined by Sections 1 through 9 of this document.
+>
+>       "Licensor" shall mean the copyright owner or entity authorized by
+>       the copyright owner that is granting the License.
+>
+>       "Legal Entity" shall mean the union of the acting entity and all
+>       other entities that control, are controlled by, or are under common
+>       control with that entity. For the purposes of this definition,
+>       "control" means (i) the power, direct or indirect, to cause the
+>       direction or management of such entity, whether by contract or
+>       otherwise, or (ii) ownership of fifty percent (50%) or more of the
+>       outstanding shares, or (iii) beneficial ownership of such entity.
+>
+>       "You" (or "Your") shall mean an individual or Legal Entity
+>       exercising permissions granted by this License.
+>
+>       "Source" form shall mean the preferred form for making modifications,
+>       including but not limited to software source code, documentation
+>       source, and configuration files.
+>
+>       "Object" form shall mean any form resulting from mechanical
+>       transformation or translation of a Source form, including but
+>       not limited to compiled object code, generated documentation,
+>       and conversions to other media types.
+>
+>       "Work" shall mean the work of authorship, whether in Source or
+>       Object form, made available under the License, as indicated by a
+>       copyright notice that is included in or attached to the work
+>       (an example is provided in the Appendix below).
+>
+>       "Derivative Works" shall mean any work, whether in Source or Object
+>       form, that is based on (or derived from) the Work and for which the
+>       editorial revisions, annotations, elaborations, or other modifications
+>       represent, as a whole, an original work of authorship. For the purposes
+>       of this License, Derivative Works shall not include works that remain
+>       separable from, or merely link (or bind by name) to the interfaces of,
+>       the Work and Derivative Works thereof.
+>
+>       "Contribution" shall mean any work of authorship, including
+>       the original version of the Work and any modifications or additions
+>       to that Work or Derivative Works thereof, that is intentionally
+>       submitted to the Licensor for inclusion in the Work by the copyright owner
+>       or by an individual or Legal Entity authorized to submit on behalf of
+>       the copyright owner. For the purposes of this definition, "submitted"
+>       means any form of electronic, verbal, or written communication sent
+>       to the Licensor or its representatives, including but not limited to
+>       communication on electronic mailing lists, source code control systems,
+>       and issue tracking systems that are managed by, or on behalf of, the
+>       Licensor for the purpose of discussing and improving the Work, but
+>       excluding communication that is conspicuously marked or otherwise
+>       designated in writing by the copyright owner as "Not a Contribution."
+>
+>       "Contributor" shall mean Licensor and any individual or Legal Entity
+>       on behalf of whom a Contribution has been received by Licensor and
+>       subsequently incorporated within the Work.
+>
+>    2. Grant of Copyright License. Subject to the terms and conditions of
+>       this License, each Contributor hereby grants to You a perpetual,
+>       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+>       copyright license to reproduce, prepare Derivative Works of,
+>       publicly display, publicly perform, sublicense, and distribute the
+>       Work and such Derivative Works in Source or Object form.
+>
+>    3. Grant of Patent License. Subject to the terms and conditions of
+>       this License, each Contributor hereby grants to You a perpetual,
+>       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+>       (except as stated in this section) patent license to make, have made,
+>       use, offer to sell, sell, import, and otherwise transfer the Work,
+>       where such license applies only to those patent claims licensable
+>       by such Contributor that are necessarily infringed by their
+>       Contribution(s) alone or by combination of their Contribution(s)
+>       with the Work to which such Contribution(s) was submitted. If You
+>       institute patent litigation against any entity (including a
+>       cross-claim or counterclaim in a lawsuit) alleging that the Work
+>       or a Contribution incorporated within the Work constitutes direct
+>       or contributory patent infringement, then any patent licenses
+>       granted to You under this License for that Work shall terminate
+>       as of the date such litigation is filed.
+>
+>    4. Redistribution. You may reproduce and distribute copies of the
+>       Work or Derivative Works thereof in any medium, with or without
+>       modifications, and in Source or Object form, provided that You
+>       meet the following conditions:
+>
+>       (a) You must give any other recipients of the Work or
+>           Derivative Works a copy of this License; and
+>
+>       (b) You must cause any modified files to carry prominent notices
+>           stating that You changed the files; and
+>
+>       (c) You must retain, in the Source form of any Derivative Works
+>           that You distribute, all copyright, patent, trademark, and
+>           attribution notices from the Source form of the Work,
+>           excluding those notices that do not pertain to any part of
+>           the Derivative Works; and
+>
+>       (d) If the Work includes a "NOTICE" text file as part of its
+>           distribution, then any Derivative Works that You distribute must
+>           include a readable copy of the attribution notices contained
+>           within such NOTICE file, excluding those notices that do not
+>           pertain to any part of the Derivative Works, in at least one
+>           of the following places: within a NOTICE text file distributed
+>           as part of the Derivative Works; within the Source form or
+>           documentation, if provided along with the Derivative Works; or,
+>           within a display generated by the Derivative Works, if and
+>           wherever such third-party notices normally appear. The contents
+>           of the NOTICE file are for informational purposes only and
+>           do not modify the License. You may add Your own attribution
+>           notices within Derivative Works that You distribute, alongside
+>           or as an addendum to the NOTICE text from the Work, provided
+>           that such additional attribution notices cannot be construed
+>           as modifying the License.
+>
+>       You may add Your own copyright statement to Your modifications and
+>       may provide additional or different license terms and conditions
+>       for use, reproduction, or distribution of Your modifications, or
+>       for any such Derivative Works as a whole, provided Your use,
+>       reproduction, and distribution of the Work otherwise complies with
+>       the conditions stated in this License.
+>
+>    5. Submission of Contributions. Unless You explicitly state otherwise,
+>       any Contribution intentionally submitted for inclusion in the Work
+>       by You to the Licensor shall be under the terms and conditions of
+>       this License, without any additional terms or conditions.
+>       Notwithstanding the above, nothing herein shall supersede or modify
+>       the terms of any separate license agreement you may have executed
+>       with Licensor regarding such Contributions.
+>
+>    6. Trademarks. This License does not grant permission to use the trade
+>       names, trademarks, service marks, or product names of the Licensor,
+>       except as required for reasonable and customary use in describing the
+>       origin of the Work and reproducing the content of the NOTICE file.
+>
+>    7. Disclaimer of Warranty. Unless required by applicable law or
+>       agreed to in writing, Licensor provides the Work (and each
+>       Contributor provides its Contributions) on an "AS IS" BASIS,
+>       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+>       implied, including, without limitation, any warranties or conditions
+>       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+>       PARTICULAR PURPOSE. You are solely responsible for determining the
+>       appropriateness of using or redistributing the Work and assume any
+>       risks associated with Your exercise of permissions under this License.
+>
+>    8. Limitation of Liability. In no event and under no legal theory,
+>       whether in tort (including negligence), contract, or otherwise,
+>       unless required by applicable law (such as deliberate and grossly
+>       negligent acts) or agreed to in writing, shall any Contributor be
+>       liable to You for damages, including any direct, indirect, special,
+>       incidental, or consequential damages of any character arising as a
+>       result of this License or out of the use or inability to use the
+>       Work (including but not limited to damages for loss of goodwill,
+>       work stoppage, computer failure or malfunction, or any and all
+>       other commercial damages or losses), even if such Contributor
+>       has been advised of the possibility of such damages.
+>
+>    9. Accepting Warranty or Additional Liability. While redistributing
+>       the Work or Derivative Works thereof, You may choose to offer,
+>       and charge a fee for, acceptance of support, warranty, indemnity,
+>       or other liability obligations and/or rights consistent with this
+>       License. However, in accepting such obligations, You may act only
+>       on Your own behalf and on Your sole responsibility, not on behalf
+>       of any other Contributor, and only if You agree to indemnify,
+>       defend, and hold each Contributor harmless for any liability
+>       incurred by, or claims asserted against, such Contributor by reason
+>       of your accepting any such warranty or additional liability.
+>
+>    END OF TERMS AND CONDITIONS
+>
+>    APPENDIX: How to apply the Apache License to your work.
+>
+>       To apply the Apache License to your work, attach the following
+>       boilerplate notice, with the fields enclosed by brackets "[]"
+>       replaced with your own identifying information. (Don't include
+>       the brackets!)  The text should be enclosed in the appropriate
+>       comment syntax for the file format. We also recommend that a
+>       file or class name and description of purpose be included on the
+>       same "printed page" as the copyright notice for easier
+>       identification within third-party archives.
+>
+>    Copyright 2025 Zhipu AI
+>
+>    Licensed under the Apache License, Version 2.0 (the "License");
+>    you may not use this file except in compliance with the License.
+>    You may obtain a copy of the License at
+>
+>        http://www.apache.org/licenses/LICENSE-2.0
+>
+>    Unless required by applicable law or agreed to in writing, software
+>    distributed under the License is distributed on an "AS IS" BASIS,
+>    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+>    See the License for the specific language governing permissions and
+>    limitations under the License.

package/README.md

@@ -0,0 +1,283 @@
+<a href="https://github.com/FliPPeDround/autoglm.js"><img src="./banner.svg" alt="banner" width="100%"/></a>
+
+<a href="https://github.com/FliPPeDround/autoglm.js"><img src="https://img.shields.io/github/stars/FliPPeDround/autoglm.js?colorA=6A00FF&colorB=eee&style=for-the-badge"></a>
+<a href="https://www.npmjs.com/package/autoglm.js"><img src="https://img.shields.io/npm/dm/autoglm.js?colorA=6A00FF&colorB=eee&style=for-the-badge"></a>
+<a href="https://www.npmjs.com/package/autoglm.js"><img src="https://img.shields.io/npm/v/autoglm.js?colorA=6A00FF&colorB=eee&style=for-the-badge"></a>
+<br/>
+
+# 基于 JavaScript 实现的 [Open-AutoGLM](https://github.com/zai-org/Open-AutoGLM) - 智能 AI 代理框架
+
+> AutoGLM.js 是一个强大的 AI 代理框架，能够通过自然语言指令自动控制 Android 设备，执行各种复杂的手机操作任务。
+
+## ✨ 特性
+
+- 🎯 **自然语言控制**: 通过简单的文字指令控制手机操作
+- 📱 **Android 自动化**: 支持截图分析、应用操作、UI 交互等
+- 🧠 **智能决策**: 基于大语言模型的智能任务规划和执行
+- 🔧 **灵活配置**: 支持多种调用方式和配置选项
+- 🌍 **多语言支持**: 内置中英文支持
+- 📦 **易于集成**: 提供 CLI 和 API 两种使用方式
+
+## 🚀 快速开始
+https://github.com/FliPPeDround/autoglm.js
+### 快捷使用
+```bash
+npx autoglm.js
+```
+
+### 安装
+
+```bash
+npm install autoglm.js
+```
+
+### 环境要求
+
+- Node.js >= 18.0.0
+- Android 设备（需要开启 USB 调试）
+- ADB (Android Debug Bridge) 工具
+
+## 📖 使用方式
+
+AutoGLM.js 提供了两种使用方式：**CLI 命令行工具** 和 **API 集成**。
+
+> **CLI 命令行工具** 是一个方便的方式，用于快速使用 AutoGLM.js。
+> **API 集成** 则提供了更灵活的方式，用于在自定义应用中集成 AutoGLM.js 的功能。
+
+### 方式一：CLI 命令行工具
+
+#### 1. 全局安装/快捷使用
+
+```bash
+npm install -g autoglm.js // 全局安装
+npx autoglm.js // 快捷使用
+```
+
+#### 2. 创建配置文件
+
+创建 `config.json` 文件：
+
+```json
+{
+  "$schema": "https://unpkg.com/autoglm.js@latest/schema/agent-config.schema.json",
+  "maxSteps": 200,
+  "lang": "cn",
+  "baseUrl": "https://open.bigmodel.cn/api/paas/v4/",
+  "apiKey": "your-api-key-here",
+  "model": "autoglm-phone",
+  "deviceId": "your-device-id"
+}
+```
+
+#### 3. 运行 CLI
+
+```bash
+# 使用配置文件
+autoglm -c config.json
+
+# 或者直接运行（会进入交互式配置）
+autoglm
+```
+
+#### 4. 交互式使用
+
+CLI 会启动交互式界面，你可以输入自然语言指令：
+
+```
+💬 请输入任务：打开微信并给张三发送"你好"
+```
+
+### 方式二：API 集成
+
+#### 1. 基础使用
+
+```javascript
+import { AutoGLM } from 'autoglm.js'
+
+// 创建代理实例
+const agent = await AutoGLM.createAgent({
+  maxSteps: 200,
+  lang: 'cn',
+  baseUrl: 'https://open.bigmodel.cn/api/paas/v4/',
+  apiKey: 'your-api-key-here',
+  model: 'autoglm-phone',
+  deviceId: 'your-device-id'
+})
+
+// 执行任务
+agent.run('打开微信并给张三发送"你好"')
+```
+
+#### 2. 事件监听
+
+```javascript
+import { emitter } from 'autoglm.js/utils/events'
+
+// 监听任务执行事件
+emitter.on('thinking', (data) => {
+  console.log('思考中:', data)
+})
+
+emitter.on('action', (result) => {
+  console.log('执行动作:', result)
+})
+
+emitter.on('task_complete', (result) => {
+  console.log('任务完成:', result)
+})
+```
+
+## ⚙️ 配置选项
+
+### 基础配置
+
+| 参数 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `maxSteps` | number | 100 | 最大执行步骤数 |
+| `lang` | string | 'cn' | 语言设置 ('cn' 或 'en') |
+| `deviceId` | string | - | Android 设备 ID |
+
+### 模型配置
+
+| 参数 | 类型 | 默认值 | 说明 |
+|------|------|--------|------|
+| `baseUrl` | string | 'http://localhost:8000/v1' | API 基础地址 |
+| `apiKey` | string | - | API 密钥 |
+| `model` | string | 'autoglm-phone' | 模型名称 |
+| `maxTokens` | number | 3000 | 最大 token 数 |
+| `temperature` | number | 0.0 | 温度参数 |
+| `topP` | number | 0.85 | Top P 参数 |
+| `frequencyPenalty` | number | 0.2 | 频率惩罚参数 |
+
+## 🔧 开发指南
+
+### 本地开发
+
+```bash
+# 克隆仓库
+git clone https://github.com/flippedround/autoglm.js.git
+
+# 安装依赖
+pnpm install
+
+# 开发模式
+pnpm dev
+
+# 构建项目
+pnpm build
+
+# 运行测试
+pnpm test
+```
+
+### 代码结构
+
+```
+src/
+├── agent/          # 代理核心逻辑
+├── actions/        # 动作处理
+├── adb/           # Android 调试桥接
+├── cli/           # 命令行界面
+├── config/        # 配置管理
+├── model/         # 模型客户端
+├── utils/         # 工具函数
+└── locales/       # 国际化
+```
+
+## 📋 示例任务
+
+### 社交应用
+- "打开微信，给张三发送'晚上一起吃饭吗'"
+- "在微博上搜索'科技新闻'并点赞第一条"
+- "打开QQ，查看未读消息"
+
+### 日常操作
+- "设置明天早上7点的闹钟"
+- "打开相机拍照并保存"
+- "查看今天的天气预报"
+
+### 信息查询
+- "在百度上搜索'Node.js最新版本'"
+- "打开浏览器访问github.com"
+- "查看手机存储空间"
+
+## 🔍 调试与故障排除
+
+### 常见问题
+
+1. **设备连接失败**
+   ```bash
+   # 检查 ADB 连接
+   adb devices
+
+   # 确保 USB 调试已开启
+   adb shell settings put global adb_enabled 1
+   ```
+
+2. **截图权限问题**
+   ```bash
+   # 授予截图权限
+   adb shell pm grant com.android.systemui android.permission.READ_FRAME_BUFFER
+   ```
+
+3. **模型 API 错误**
+   - 检查 API 密钥是否正确
+   - 确认网络连接正常
+   - 验证模型名称是否支持
+
+### 调试模式
+
+```javascript
+// 监听所有事件
+emitter.on('*', (event, data) => {
+  console.log(`[${event}]`, data)
+})
+```
+
+## 🤝 贡献指南
+
+欢迎提交 Issue 和 Pull Request！
+
+### 提交规范
+
+- 使用清晰的提交信息
+- 添加适当的测试用例
+- 更新相关文档
+- 遵循代码风格规范
+
+### 开发流程
+
+1. Fork 项目
+2. 创建特性分支 (`git checkout -b feature/amazing-feature`)
+3. 提交更改 (`git commit -m 'Add some amazing feature'`)
+4. 推送到分支 (`git push origin feature/amazing-feature`)
+5. 创建 Pull Request
+
+## 📄 许可证
+
+本项目基于 [MIT 许可证](LICENSE) 开源。
+
+## 🙏 致谢
+
+- [Open-AutoGLM](https://github.com/zai-org/Open-AutoGLM) - 原始项目灵感
+
+## 📞 支持
+
+- 💬 [提交 Issue](https://github.com/flippedround/autoglm.js/issues)
+- 📧 邮件: flippedround@qq.com
+- 💖 [赞助项目](https://afdian.com/a/flippedround)
+
+## 🙇🏻‍♂️[Sponsors](https://afdian.com/a/flippedround)
+
+<p align="center">
+  <a href="https://afdian.com/a/flippedround">
+    <img alt="sponsors" src="https://cdn.jsdelivr.net/gh/FliPPeDround/sponsors/sponsorkit/sponsors.svg"/>
+  </a>
+</p>
+
+---
+
+<div align="center">
+  <p>如果这个项目对你有帮助，请给个 ⭐️ 支持一下！</p>
+  <p><b>Made with ❤️ by <a href="https://github.com/flippedround">@FliPPeDround</a></b></p>
+</div>