Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ To change the AI-related code of this repository, you need to create a '.env 'fi

```
OPENAI_API_KEY="your_token"
MIDSCENE_MODEL_NAME="gpt-4o-2024-08-06"
MIDSCENE_MODEL_NAME="qwen3-vl-plus"
```


Expand Down
82 changes: 82 additions & 0 deletions apps/site/docs-migration-log.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# 文档迁移工作日志

## 记录规范

- 每条记录都仅针对一个 breaking change,避免多个操作混写。
- 在描述路径时请写明仓库内的完整相对路径,便于检索。
- 如果是合并、拆分或改名,请在「操作类型」里明确指出。
- 如果需要后续验证或修改,使用「后续行动」注明负责人或跟进人。

### 模板

```markdown
### YYYY-MM-DD – 简短的变更摘要

- 原路径:`apps/site/...`
- 原标题:`原文档标题`
- 操作类型:移动 / 合并 / 拆分 / 重命名
- 新位置:`apps/site/...`
- Breaking change 说明:说明迁移原因、影响范围以及需要知悉的事项。
- 后续行动:若无后续事项,可填「无」。
```

## 迁移记录

(按时间倒序追加记录,最新记录放最上方)

### 2025-11-05 – 拆分英文 YAML 自动化与命令行文档

- 原路径:`apps/site/docs/en/automate-with-scripts-in-yaml.mdx`
- 原标题:`Automate with scripts in YAML`
- 操作类型:拆分
- 新位置:`apps/site/docs/en/automate-with-scripts-in-yaml.mdx`、`apps/site/docs/en/command-line-tools.mdx`
- Breaking change 说明:将 CLI 安装与执行说明抽离为独立页面,原文保留 YAML 格式与语法说明。同步更新 `apps/site/rspress.config.ts` 侧边栏链接为 `/command-line-tools`。
- 后续行动:无

### 2025-11-05 – 拆分中文 YAML 自动化与命令行文档

- 原路径:`apps/site/docs/zh/automate-with-scripts-in-yaml.mdx`
- 原标题:`使用 YAML 格式的自动化脚本`
- 操作类型:拆分
- 新位置:`apps/site/docs/zh/automate-with-scripts-in-yaml.mdx`、`apps/site/docs/zh/command-line-tools.mdx`
- Breaking change 说明:同步中文文档结构,新增命令行工具页面并简化 YAML 文档内容,同时更新侧边栏链接到 `/zh/command-line-tools`。
- 后续行动:无

### 2024-07-23 – 合并 Web 与 Android MCP 文档

- 原路径:`apps/site/docs/en/web-mcp.mdx`
- 原标题:`MCP server`
- 操作类型:合并
- 新位置:`apps/site/docs/en/mcp.mdx`
- Breaking change 说明:原 Web 端 MCP 文档与 Android MCP 文档合并为统一文档,新增对两种环境配置和工具差异的说明。
- 后续行动:无

- 原路径:`apps/site/docs/en/mcp-android.mdx`
- 原标题:`MCP server`
- 操作类型:合并
- 新位置:`apps/site/docs/en/mcp.mdx`
- Breaking change 说明:Android 模式内容合入统一的 MCP 文档,文档中区分 Web 与 Android 的配置与可用工具。
- 后续行动:无

- 原路径:`apps/site/docs/zh/web-mcp.mdx`
- 原标题:`MCP 服务`
- 操作类型:合并
- 新位置:`apps/site/docs/zh/mcp.mdx`
- Breaking change 说明:中文 Web 端 MCP 文档合并入统一文档,补充了 Web 与 Android 的环境差异说明。
- 后续行动:无

- 原路径:`apps/site/docs/zh/mcp-android.mdx`
- 原标题:`MCP 服务`
- 操作类型:合并
- 新位置:`apps/site/docs/zh/mcp.mdx`
- Breaking change 说明:中文 Android 模式内容合并到统一 MCP 文档,统一呈现配置与工具差异。
- 后续行动:无

### 2025-11-06 – 重命名桥接模式文档

- 原路径:`apps/site/docs/en/bridge-mode-by-chrome-extension.mdx`、`apps/site/docs/zh/bridge-mode-by-chrome-extension.mdx`
- 原标题:`Bridge to the desktop Chrome`、`桥接到桌面 Chrome`
- 操作类型:重命名
- 新位置:`apps/site/docs/en/bridge-mode.mdx`、`apps/site/docs/zh/bridge-mode.mdx`
- Breaking change 说明:将桥接模式文档从冗长的文件名简化为 `bridge-mode.mdx`,同时更新 `apps/site/rspress.config.ts` 中的侧边栏链接配置。
- 后续行动:无
37 changes: 37 additions & 0 deletions apps/site/docs/en/android-introduction.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Android Automation Support

Thanks to the visual model approach, Midscene can drive adb tools to support Android automation.

Since it adopts a visual model approach, apps built with any technology stack can integrate with Midscene. Developers can directly target the final results and debug their UI automation scripts.

The Android UI automation solution comes with all the features of Midscene:

- Supports zero-code trial using Playground.
- Supports JavaScript SDK.
- Supports automation scripts in YAML format and command-line tools.
- Supports HTML reports to replay all operation paths.

## Showcases

### Navigate to Tourist Attraction

Open the Maps app, search for the destination, and start navigation.

<video src="https://lf3-static.bytednsdoc.com/obj/eden-cn/nupipfups/Midscene/android-maps.mp4" controls/>

### Auto-like on Twitter

Open Twitter and auto-like the first tweet by [@midscene_ai](https://x.com/midscene_ai).

<video src="https://lf3-static.bytednsdoc.com/obj/eden-cn/nupipfups/Midscene/android-twitter.mp4" controls/>

## Try with Playground

With Playground, you can experience Midscene's capabilities without writing any code.

Click here to view the [Android Playground usage documentation](/en/android-playground).

## Next Steps

* [Use JavaScript SDK](/en/integrate-with-android)
* [Use YAML format automation scripts](/en/automate-with-scripts-in-yaml) and [command-line tools](/en/automate-with-scripts-in-yaml)
10 changes: 9 additions & 1 deletion apps/site/docs/en/api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Each Agent in Midscene has its own constructor.

- In Puppeteer, use [PuppeteerAgent](./integrate-with-puppeteer)
- In Bridge Mode, use [AgentOverChromeBridge](./bridge-mode-by-chrome-extension#constructor)
- In Bridge Mode, use [AgentOverChromeBridge](./bridge-mode#constructor)
- In Android, use [AndroidAgent](./integrate-with-android)
- For GUI Agent integrating with your own interface, refer to [Integrate with any interface](./integrate-with-any-interface)

Expand Down Expand Up @@ -1223,3 +1223,11 @@ describe('Android Settings Test', () => {
:::tip
The merged report file will be saved in the `midscene_run/report` directory by default. You can customize the report directory location by setting the `MIDSCENE_RUN_DIR` environment variable.
:::

## Platform-Specific Agents

- `AndroidAgent` / `AndroidDevice`: Use the Android SDK integration guide for APIs, constructors, and helper utilities. [Read more](./integrate-with-android#androidagent) and [device details](./integrate-with-android#androiddevice).
- `IOSAgent` / `IOSDevice`: Follow the iOS integration guide for WebDriverAgent-based automation. [Read more](./integrate-with-ios#iosagent) and [device details](./integrate-with-ios#iosdevice).
- `PuppeteerAgent`: See the Puppeteer integration doc for browser automation options and constructor parameters. [Read more](./integrate-with-puppeteer#puppeteeragent).
- `PlaywrightAgent`: Explore the Playwright integration guide for direct usage examples and configuration. [Read more](./integrate-with-playwright#playwrightagent).
- `AgentOverChromeBridge`: Refer to the bridge mode instructions for connecting local scripts to Chrome. [Read more](./bridge-mode#agentoverchromebridge).
Loading