> For AI agents: the complete documentation index is available at /zh/llms.txt, the full documentation bundle is available at /zh/llms-full.txt.

# 开始使用：Android · Midscene Test · 模型 API Key {#get-started}

本页是在 **Android** 上使用 **Midscene Test**、通过**模型 API Key** 接入模型的配置步骤。如需其他组合，请查看[全部配置路径](/zh/get-started.md#all-setup-paths)。

## 安装 Node.js
安装 Node.js `^20.19.0 || ^22.12.0 || >=24.0.0`，并确认终端中可以执行 `node -v`。
下文命令使用 pnpm。如果尚未安装，请运行 `npm install -g pnpm`。

## 连接 Android 设备
运行 Midscene 的电脑需要通过 `adb` 连接目标 Android 设备，支持 USB 和无线 `adb` 两种连接方式。如果已安装 `adb` 并连接好设备，可直接跳至[确认设备连接](#verify-device-connection)。

### 安装 adb

- 通过 [Android Studio](https://developer.android.com/studio) 或独立的 [Android 命令行工具](https://developer.android.com/studio#command-line-tools-only)安装 `adb`。
- 在终端运行以下命令，验证 `adb` 是否安装成功：

```bash
adb --version
```

输出类似以下内容即表示安装成功：

```log
Android Debug Bridge version 1.0.41
Version 34.0.4-10411341
Installed as /usr/local/bin/adb
Running on Darwin 24.3.0 (arm64)
```

- 参考 [Android 环境变量文档](https://developer.android.com/tools/variables)配置 `ANDROID_HOME` 环境变量，并检查是否生效：

```bash
echo $ANDROID_HOME
```

输出应指向本机安装的 Android SDK 目录，例如：

```log
/Users/your_username/Library/Android/sdk
```

### 开启调试并连接设备

以下以 USB 连接为例；如果设备已通过无线 `adb` 连接，可继续使用现有连接。

1. 在手机系统设置的「开发者选项」中开启 **USB 调试**（若同时存在 **USB 调试（安全设置）**，请一并开启，以确保支持触控事件注入）。
2. 使用支持数据传输的 USB 数据线将手机连接到电脑。
3. 保持手机解锁亮屏，在手机弹出的授权窗口中勾选并允许 USB 调试。

![android usb debug](/images/android-usb-debug-en.png)

### 确认设备连接 {#verify-device-connection}

在终端运行以下命令检查连接状态：

```bash
adb devices -l
```

输出中设备状态显示为 `device` 即表示连接就绪：

```log
List of devices attached
s4ey59	device usb:34603008X product:cezanne model:M2006J device:cezan transport_id:3
```

如果同时连接了多台设备，请记录目标设备所在行第一列的设备 ID（如上例中的 `s4ey59`），以便后续在 Playground 或项目配置中指定该设备。

若未显示目标设备或状态不是 `device`，请按以下情况排查：

- **列表为空**：USB 连接请检查数据线（需支持数据传输）、USB 连接模式和 **USB 调试**开关；无线连接请检查网络及 `adb connect` 连接状态。
- **`unauthorized`**：请解锁手机屏幕，在手机弹出的授权窗口中勾选并允许 USB 调试。
- **`offline`**：请重新建立 USB 或无线 `adb` 连接，必要时重启 `adb` 服务。请确认设备状态变为 `device` 后再继续后续步骤。

## 创建测试项目

```bash
pnpm dlx @midscene/test create my-tests \
  --platform android \
  --package-manager pnpm
cd my-tests
```

该命令会生成项目文件、安装依赖并生成 Node 说明书，不会运行测试。生成的文件说明请参阅[项目结构](/zh/midscene-test/use.md#project-structure)。

## 配置模型

在 `my-tests` 目录中，将 `.env.example` 复制为 `.env`：
```bash
cp .env.example .env
```

在下方选择一个模型，它的配置包含四项。点击**获取 API Key**到服务商创建 API Key，再用它替换 `MIDSCENE_MODEL_API_KEY` 中的 `......`。

下方是 Doubao-Seed-2.1 Turbo 的配置。其他推荐模型：

- [Qwen3.7 Plus](/zh/model-api-setup.md#qwen) (阿里巴巴)
- [DeepSeek V4.1 Flash](/zh/model-api-setup.md#deepseek) (深度求索)
- [Gemini 3.5 Flash](/zh/model-api-setup.md#gemini) (Google)
- [GPT-6 Sol](/zh/model-api-setup.md#gpt) (OpenAI)
- [Kimi K3](/zh/model-api-setup.md#kimi) (月之暗面)
- [MiMo V2.6 Pro](/zh/model-api-setup.md#xiaomi-mimo) (小米)
- [GLM-5V-Turbo](/zh/model-api-setup.md#glm-v) (智谱)
- [Ling-3.0-flash-VL](/zh/model-api-setup.md#ant-ling) (蚂蚁集团)

**火山引擎** ([获取 API Key](https://console.volcengine.com/ark))

```bash
MIDSCENE_MODEL_BASE_URL="https://ark.cn-beijing.volces.com/api/v3"
MIDSCENE_MODEL_API_KEY="......"
MIDSCENE_MODEL_NAME="doubao-seed-2-1-turbo-260628"
MIDSCENE_MODEL_FAMILY="doubao-seed"
```

**OpenRouter** ([获取 API Key](https://openrouter.ai/settings/keys))

```bash
MIDSCENE_MODEL_BASE_URL="https://openrouter.ai/api/v1"
MIDSCENE_MODEL_API_KEY="......"
MIDSCENE_MODEL_NAME="bytedance-seed/seed-2-1-turbo"
MIDSCENE_MODEL_FAMILY="doubao-seed"
```

其他版本与使用说明请参阅[豆包 Seed 系列](/zh/model-api-setup.md#doubao-seed-model)。

各模型的差异请参阅[模型选择指南](/zh/model-selection.md)。UI-TARS 等兼容模型请参阅[使用模型 API Key](/zh/model-api-setup.md#支持的模型)。

用这份配置填写 `.env` 中的四项 `MIDSCENE_MODEL_*` 变量。

## 验证模型并完成配置
运行以下命令，检查模型能否连通、是否与 Midscene 兼容。该命令只读取当前目录下的 `.env`，不需要浏览器或设备：
```bash
pnpm exec midscene-test model verify
```
如果验证失败，请参阅[验证模型连接](/zh/model-config.md#verify-model-connectivity)。

如果连接了多台设备，请在 `.env` 中将 `ANDROID_DEVICE_ID` 设置为 `adb devices -l` 输出中的设备 ID。

## 运行示例并查看报告

示例会在设备浏览器中打开 React TodoMVC，并先检查列表为空。请保持设备解锁。如果列表中留有之前运行产生的待办事项，请切换到 **All** 并删除全部事项（包括已完成的事项）。

```bash
pnpm test
```
终端会输出测试结果和 `Report:` 报告路径。打开 HTML 报告，选择用例和步骤即可查看截图、输入输出和错误信息。报告默认保存在 `midscene_run/report/` 目录下。
用例通过即表示模型、运行环境和项目都已正常工作。运行参数请参阅[运行测试](/zh/midscene-test/running.md)。

## 下一步
- **查看更多案例**：[案例展示](/zh/showcases.md)收录了各平台的演示视频和完整执行报告。

- **测试自己的应用**：在 `cases/todo.yaml` 中，将 `beforeEach` 里的 TodoMVC 初始化步骤替换为打开应用的 `launch` Node：

  ```yaml
  beforeEach:
    - launch: com.example.app

  cases:
    - name: 打开首页
      steps:
        - aiAssert: 应用首页已显示
  ```

  Android 使用包名，iOS 使用 Bundle ID，HarmonyOS 使用 bundle name。其他系统操作请参阅[各平台预置 Node](/zh/midscene-test/builtin-nodes.md)。

- **编写和组织用例**：[编写 YAML 用例](/zh/midscene-test/writing.md)介绍了输入、变量、标签和 hooks。
- **在 CI 中运行**：请参阅[在 GitHub Actions 中运行](/zh/midscene-test/running.md#在-github-actions-中运行)。