从0到1:UI-TARS-desktop开源项目开发环境搭建教程
【免费下载链接】UI-TARS-desktopA GUI Agent application based on UI-TARS(Vision-Lanuage Model) that allows you to control your computer using natural language.项目地址: https://gitcode.com/GitHub_Trending/ui/UI-TARS-desktop
UI-TARS-desktop是一款基于视觉语言模型的GUI智能助手应用,允许用户通过自然语言控制计算机。本文将以问题导向的方式,带你完成从开发环境准备到应用成功运行的全过程,掌握高效搭建开源项目开发环境的核心技能与配置技巧。
准备篇:开发环境的核心依赖与配置
在开始UI-TARS-desktop的开发工作前,需要确保系统中已安装正确版本的开发工具链。这些工具的版本兼容性直接影响项目能否顺利构建和运行。
核心依赖清单
你将需要安装以下工具,且版本需严格符合项目要求:
- Node.js:v20.x版本(提供JavaScript运行环境)
- pnpm:v9.10.0及以上版本(高效的包管理工具)
- Git:用于获取项目源码
版本校验方法
安装完成后,通过以下命令验证版本是否符合要求:
node -v # 检查Node.js版本,需返回v20.x.x pnpm -v # 检查pnpm版本,需返回9.10.0以上版本 git --version # 检查Git是否安装成功💡 注意事项:如果系统中已安装其他版本的Node.js,建议使用nvm(Node Version Manager)进行版本管理,避免全局环境冲突。
源码获取与项目结构解析
使用Git克隆项目仓库到本地:
git clone https://gitcode.com/GitHub_Trending/ui/UI-TARS-desktop.git cd UI-TARS-desktop # 进入项目根目录项目采用多包架构,核心目录结构如下:
- apps/ui-tars/:主应用目录,包含Electron主进程和渲染进程代码
- src/main/:Electron主进程代码
- src/renderer/:前端界面渲染代码
- images/:应用截图和资源文件
- packages/:项目核心模块,包含各类工具和SDK
- docs/:项目文档和使用指南
实战篇:环境搭建与应用运行全流程
完成开发环境的准备工作后,我们将通过一系列步骤完成依赖安装、开发调试和生产构建的全流程操作。
依赖安装与配置优化
项目采用pnpm workspace管理多包依赖,执行以下命令安装所有依赖:
pnpm install # 安装项目所有依赖🔧 配置技巧:为加速依赖下载,可配置国内镜像源:
pnpm config set registry https://registry.npmmirror.com # 设置npm镜像 pnpm config set electron_mirror https://npmmirror.com/mirrors/electron/ # 设置Electron镜像依赖安装完成后,执行预构建命令检查是否存在依赖冲突:
pnpm run build:deps # 预构建项目依赖包开发模式启动与界面预览
进入主应用目录并启动开发服务器:
cd apps/ui-tars # 进入主应用目录 pnpm run dev # 启动开发模式,支持热重载成功启动后,应用将自动打开主界面窗口,展示UI-TARS-desktop的功能选择页面。
生产版本构建
如需生成可执行文件,执行全量构建命令:
pnpm run build # 执行清理、类型检查、编译和打包流程构建产物将生成在项目根目录的out/文件夹中,不同操作系统对应不同格式的安装包:
- Windows系统:
UI TARS Setup x.y.z.exe - macOS系统:
UI TARS-x.y.z.dmg - Linux系统:
ui-tars_x.y.z_amd64.deb
系统权限配置
macOS系统配置
- 将应用拖入应用程序目录完成安装:
- 开启必要系统权限:
- 进入系统设置 → 隐私与安全性
- 在辅助功能中启用UI-TARS的控制权限
- 在屏幕录制中允许UI-TARS的屏幕捕获权限
Windows系统配置
Windows系统安装时可能会触发SmartScreen保护,需点击"更多信息",然后选择"仍要运行"以继续安装:
优化篇:问题预判与解决方案
在环境搭建过程中,可能会遇到各类技术问题。以下是常见问题的现象分析和解决步骤。
依赖安装失败
现象:执行pnpm install时出现与Homebrew相关的ARM架构错误。
原因:在ARM架构的Mac上使用Intel架构的Homebrew前缀。
解决步骤:
- 安装Rosetta 2兼容层:
softwareupdate --install-rosetta # 安装Rosetta 2- 重新安装Homebrew到正确的架构路径
编译错误:node-gyp相关问题
现象:编译过程中出现gyp: No Xcode or CLT version detected!错误。
原因:缺少Xcode命令行工具。
解决步骤:
- 安装Xcode命令行工具:
xcode-select --install # 安装Xcode命令行工具- 如已安装,尝试重置命令行工具路径:
sudo xcode-select -s /Library/Developer/CommandLineTools应用启动白屏问题
现象:开发模式下应用启动后显示白屏。
原因:Electron入口配置错误或资源加载失败。
解决步骤:
- 检查electron.vite.config.ts配置文件
- 确保
main.entry属性正确指向src/main/index.ts - 清除缓存并重启开发服务器:
pnpm run dev --force # 强制重新构建并启动镜像拉取缓慢
现象:Electron或其他大型依赖下载速度缓慢。
原因:默认镜像服务器在国内访问速度受限。
解决步骤:
- 配置pnpm使用国内镜像:
pnpm config set electron_mirror https://npmmirror.com/mirrors/electron/ pnpm config set nodegit_binary_host_mirror https://npmmirror.com/mirrors/nodegit/开发效率提升工具链
为提高开发效率,项目提供了一系列辅助脚本和工具:
- 代码格式化:
pnpm run format(基于Prettier配置) - 类型检查:
pnpm run typecheck(全项目TypeScript类型校验) - 单元测试:
pnpm run test(使用Vitest测试框架) - E2E测试:
pnpm run test:e2e(使用Playwright进行端到端测试)
测试配置文件位于apps/ui-tars/vitest.config.mts,可根据需要进行自定义配置。
总结
通过本文的步骤,你已经掌握了UI-TARS-desktop开源项目开发环境的搭建方法,包括依赖安装、开发调试、生产构建和问题解决等关键技能。项目的核心配置文件和模块结构为后续开发提供了清晰的路径。
如需进一步深入开发,可参考以下资源:
- 官方开发文档:docs/quick-start.md
- API接口定义:packages/ui-tars/sdk/src/index.ts
- 贡献指南:CONTRIBUTING.md
现在,你可以开始基于UI-TARS-desktop进行二次开发,为这款智能助手应用添加更多强大功能。
【免费下载链接】UI-TARS-desktopA GUI Agent application based on UI-TARS(Vision-Lanuage Model) that allows you to control your computer using natural language.项目地址: https://gitcode.com/GitHub_Trending/ui/UI-TARS-desktop
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考