93 lines
7.5 KiB
Markdown
93 lines
7.5 KiB
Markdown
# ARTEMIS-Eapil
|
||
|
||
基于 [ARTEMIS](https://github.com/google/artemis) 扩展的 Android AI 自动化测试平台。用自然语言描述任务，即可通过简体中文网页或 MCP 驱动真机、模拟器执行操作并收集结果。模型统一使用 **OpenAI Responses API**。
|
||
|
||
**2.0.0 已发布**：新增交互探索、插件扩展和精选任务，增强跨端证据与 AI 接入。完整变化及升级步骤见 [2.0.0 发行说明](docs/releases/2.0.0.md)。
|
||
|
||
## 主要功能
|
||
|
||
- **自然语言任务**：Flash 适合明确的操作流程，Pro 适合需要计划、分支探索和验证的任务。
|
||
- **交互探索**：边执行边交流，也可录制人工示范；探索成功后生成一个可编辑、复跑的用例。默认使用独立的 `gpt-6.1-sol / high` 配置，超时暂停并保留进度。见 [探索模式](docs/exploration-mode.md)。
|
||
- **插件扩展**：在插件市场安装并启用电脑控制等能力，AI 在安卓任务中按需使用；手机、电脑的步骤与证据统一留档。见 [插件与跨端任务](docs/plugins.md)。
|
||
- **可保存的模型配置**：支持自定义接口、模型、思考强度和超时重试，以及视频分析与录屏开关。
|
||
- **批量测试**：按新版 Excel 模板导入提示词，每项可独立指定模型、模式和参数；任务可暂停、补充指导并继续。
|
||
- **精选任务**：收藏单任务、批次或探索用例，在首页一键复跑，默认沿用已保存的配置。
|
||
- **报告与历史**：导出 Word、Excel、步骤截图、录屏和任务资料 ZIP；历史按日期分组，支持搜索和筛选。
|
||
- **AI 接入**：随源码提供 MCP 与 Skill，让 AI 完成设备诊断、任务执行、历史分析和报告交付。
|
||
|
||
## 安装与启动
|
||
|
||
准备一台开启 USB 调试并完成授权的 Android 手机，或已启动的 Android 模拟器。首次安装需要联网。可使用 Git 克隆或下载 1.1.1 及更新版本的发布源码包；新版 ZIP 解压后也保留 Git 更新能力。
|
||
|
||
### Windows
|
||
|
||
在 PowerShell 中执行：
|
||
|
||
```powershell
|
||
git clone https://git.playones.com/chenmingxuan/Artemis-Eapil.git
|
||
cd Artemis-Eapil
|
||
.\start.bat
|
||
```
|
||
|
||
国内网络使用 `.\start-cn.bat`，支持 `-Help` 查看中文选项。启动脚本会检测并安装缺少的 uv、Python 和所需工具，创建或复用 `.venv`，同步依赖并构建网页。启动后访问 **http://127.0.0.1:8000**。
|
||
|
||
常用选项：
|
||
|
||
```powershell
|
||
.\start-cn.bat -SetupOnly # 准备环境并安装/更新 Codex MCP
|
||
.\start.bat -Port 8001 # 指定端口
|
||
.\start.bat -SkipUpdate # 跳过源码更新提示
|
||
.\start.bat -SkipMcpSync # MCP 配置异常时，仅启动网页
|
||
```
|
||
|
||
镜像与下载超时在 [config/downloads.json](config/downloads.json) 中设置。scrcpy 国内下载源失败时自动尝试备用源，每个安装包均校验官方 SHA256；也可预先安装，或通过 `overrides.scrcpy_url` 和 `scrcpy_fallback_urls` 自定义 HTTPS 地址。
|
||
|
||
### macOS / Linux
|
||
|
||
克隆仓库后在项目目录执行 `./start.sh`。国内镜像入口和独立升级脚本目前由 Windows 提供。
|
||
|
||
## 配置与使用
|
||
|
||
1. 在首页“系统设置与运行准备”中选择设备，打开“模型配置”。
|
||
2. 填写支持 Responses 的接口地址、API Key 和模型名称，测试连接后保存。接口地址通常是以 `/v1` 结尾的 API 根地址。
|
||
3. 输入任务目标，选择 Flash、Pro 或探索后执行；在工作区查看步骤、截图和结果。流程尚不明确时，选择探索并随时交流。
|
||
4. 通过“报告与批量”导出报告或导入 Excel 用例；任务队列支持历史搜索。
|
||
|
||
预设模型为 `gpt-6-luna`、`gpt-6.1-sol`、`gpt-6-astra`、`mimo-v2.6-pro`，主模型与兜底模型均可选择预设或填写自定义名称。新安装默认模型是 `gpt-6-luna`，思考强度默认 `high`（最高可选 `max`），单次请求超时 **300 秒**，失败后最多重试 **5 次**，间隔 **10 秒**。遇到 429 请求过多时改为每次等待 **60 秒**。连续 3 次没有有效工具调用时，本步骤改用 `gpt-6-luna`（high），兜底模型最多再尝试 3 次；下一步恢复首选模型。视频分析与录屏默认关闭。模型及思考参数是否可用取决于所配置网关；不支持时会明确报错。
|
||
|
||
也可在项目 `.env` 中设置 `OPENAI_API_KEY`、`OPENAI_BASE_URL` 和 `OPENAI_MODEL`，其他参数见 [.env.example](.env.example)。新安装默认接口地址为 `https://api-n-cd.playones.com/v1`；已保存的地址不变。直接编辑环境文件后需重启相应服务。不要提交自己的密钥。
|
||
|
||
“功能开关”默认将任务截图长边限制为 2048 像素；关闭后保留设备原始分辨率。可在 [config/artemis.jsonc](config/artemis.jsonc) 的 `agent.screenshot` 中覆盖 `enabled` 和 `max_long_edge`，重启后对新任务生效。
|
||
|
||
报告会区分“执行完成”和“验证通过”；没有验证证据的结果标为“未验证”。任务步骤与截图可查看，设备动作回放不提供。
|
||
|
||
## 让 AI 使用
|
||
|
||
目前仅支持为 Codex 配置 MCP。Windows 启动脚本检测 Codex 配置目录并安装或更新 ARTEMIS；也可手动安装：
|
||
|
||
```sh
|
||
uv run artemis mcp --install codex
|
||
```
|
||
|
||
使用工具前，由用户先启动 ARTEMIS 网页主程序。MCP 仅连接这份主程序，不会为每个 AI 会话启动后台；主程序离线不阻断 Codex 会话，工具会提示先启动网页。
|
||
|
||
启动 ARTEMIS 时会自动安装或覆盖更新官方 [artemis-use Skill](skills/artemis-use/SKILL.md)，包含 Flash／Pro／探索模式、任务诊断复盘和插件开发指南。MCP 配置变化后在 Codex 中重新加载 MCP；Skill 未显示时重启 Codex。详细行为见 [AI 接入指南](docs/ai-automation.md)。可用 `uv run artemis mcp --generate-config codex` 查看配置模板。
|
||
|
||
示例指令：
|
||
|
||
> 使用 artemis-use，在我指定的模拟器上验证系统设置首页可以打开，不修改设置，完成后输出 Word 和 Excel 报告。
|
||
|
||
## 更新与排错
|
||
|
||
启动脚本只检查并提示源码更新，不自动拉取。升级运行 **`.\update.bat`**，国内网络运行 **`.\update-cn.bat`**；支持 `-Help`。升级会终止当前项目的 ARTEMIS 服务、MCP 和任务进程，然后快进更新源码，同步依赖、网页构建及 Codex MCP。升级程序先复制到项目外运行，避免更新正在执行的脚本；其他项目、Codex 本身、模拟器和共享 ADB 服务不会被终止。完成后重新启动 ARTEMIS，并在 Codex 中重载 MCP。
|
||
|
||
本地修改、分支分叉或网络认证失败会停止升级，保留现有文件；`.env`、密钥和历史资料不会清空。依赖同步失败会明确报错；Codex MCP 或 Skill 同步失败会保留可用版本并告警，网页继续启动。可用 `-SkipMcpSync` 跳过该次 Codex 集成同步。
|
||
|
||
1.1.1 及更新版本的发布 ZIP 含浅层 Git 工作树；包含独立升级入口的新版源码包可直接用上述脚本升级。1.1.0 及更早 ZIP 不含 Git 信息，需改用 Git 克隆或新版源码包。遇到启动或设备问题，在项目目录运行 `uv run artemis doctor`。
|
||
|
||
电脑控制插件由独立市场分发，升级 ARTEMIS 后还需在「插件」页面安装或更新并启用。当前 Cua 插件适用于 Windows x64，保留预览标识和实测范围；需要前台输入时会占用用户桌面。配置和开发约定见 [插件与跨端任务](docs/plugins.md)。
|
||
|
||
更多说明：[批量任务与报告](docs/automation-workspace.md) · [AI 接入](docs/ai-automation.md) · [开发协作指南](AGENTS.md)
|
||
|
||
基于上游 ARTEMIS 开发，遵循 [Apache-2.0 许可证](LICENSE)。
|