UI-TARS Desktop 开发者指南

UI-TARS Desktop 开发者指南

UI-TARS-desktop A GUI Agent application based on UI-TARS(Vision-Lanuage Model) that allows you to control your computer using natural language. 项目地址: https://gitcode.com/gh_mirrors/ui/UI-TARS-desktop

1. 项目目录结构及介绍

UI-TARS Desktop 的项目目录结构如下：

UI-TARS-desktop/
├── apps/                      # 应用程序目录
├── docs/                      # 文档目录
├── examples/                  # 示例代码目录
├── packages/                  # 项目依赖包目录
├── rfcs/                      # RFC（Request for Comments）文档目录
├── scripts/                   # 脚本目录
├── .changeset/                # 变更集配置文件
├── .github/                   # GitHub 工作流和配置文件
├── .husky/                    # Husky 配置文件，用于 Git 钩子
├── .vscode/                   # Visual Studio Code 配置文件
├── CODE_OF_CONDUCT.md         # 项目行为准则
├── CONTRIBUTING.md            # 贡献指南
├── LICENSE                    # 项目许可证
├── README.md                  # 项目介绍
├── SECURITY.md                # 安全策略
├── codecov.yml                # CodeCov 配置文件
├── package.json               # 项目依赖和脚本
├── pnpm-lock.yaml             # pnpm 锁文件
├── pnpm-workspace.yaml        # pnpm 工作区配置文件
├── tsconfig.json              # TypeScript 配置文件
├── turbo.json                 # Turborepo 配置文件
└── vitest.config.mts          # Vitest 测试配置文件

目录说明：

• apps/: 存放应用程序的代码。
• docs/: 包含项目的文档。
• examples/: 提供了一些使用该项目的示例。
• packages/: 项目的依赖包和模块。
• rfcs/: 包含对项目有重大影响的建议和变更请求。
• scripts/: 存放一些自动化脚本。

其余的目录和文件主要是项目配置和工具相关。

2. 项目的启动文件介绍

项目的启动文件通常是 package.json 文件中的脚本。以下是一些常用的启动脚本：

"scripts": {
  "start": "vite",                 // 启动开发服务器
  "build": "vite build",            // 构建生产环境的代码
  "serve": "vite preview",          // 本地预览生产环境的代码
  "test": "vitest",                // 运行测试
  // 其他脚本...
}

使用以下命令可以启动开发服务器：

npm run start

3. 项目的配置文件介绍

以下是几个重要的配置文件及其简介：

• tsconfig.json: TypeScript 配置文件，定义了项目的类型检查和编译选项。

{
  "compilerOptions": {
    "target": "esnext",
    "module": "esnext",
    "moduleResolution": "node",
    // 其他 TypeScript 编译选项...
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules"]
}

• vitest.config.mts: Vitest 的配置文件，用于配置测试环境。

{
  "test": {
    "type": "unit",
    "include": ["src/**/*.{test,spec}.{js,ts}"],
    // 其他 Vitest 配置...
  }
}

• package.json: 包含了项目的依赖、脚本和元数据。

{
  "name": "ui-tars-desktop",
  "version": "1.0.0",
  "scripts": {
    // 脚本定义...
  },
  "dependencies": {
    // 项目依赖...
  },
  "devDependencies": {
    // 开发依赖...
  }
}

以上是 UI-TARS Desktop 的基本目录结构、启动文件和配置文件介绍。开发者可以参照这些信息来开始项目的开发工作。

UI-TARS-desktop A GUI Agent application based on UI-TARS(Vision-Lanuage Model) that allows you to control your computer using natural language. 项目地址: https://gitcode.com/gh_mirrors/ui/UI-TARS-desktop