---
title: 命令行工具
summary: 介绍 Ray 体系命令行工具的安装、调用方式及使用注意事项。
questions:
  - Ray 命令行工具需要安装哪些依赖？
  - 如何通过 npx 调用 ray start？
  - 如何在 package.json 中配置 scripts 使用 ray 命令？
  - 为什么项目内的依赖必须与 @ray-js/* 版本一致？
  - 依赖版本不一致时如何解决？
  - 如何更新 @ray-js 相关依赖？
---

# 命令行工具

Ray 体系提供配套的工程化解决方案。

由于多端构建的一些客观原因，在构建流程的设计上，必须将工程套件安装在项目内。

项目内的依赖至少包含以下内容：

```json
{
  "dependencies": {
    "@ray-js/ray": "latest"
  },
  "devDependencies": {
    "@ray-js/cli": "latest"
  }
}
```

并且安装的版本一致。注意由于 `yarn.lock` 等其他锁版本的配置造成影响。

> **提示**：如无法确定，可删除 `node_modules` 和 `yarn.lock` 后重装依赖。

## 命令行调用

在项目内安装完成后，可通过 `npx` 在终端调用唤起。

```json
{
  "devMode": "ray"
}
```

```shell
# 终端调用
npx ray start -t tuya
```

也可在 `package.json` 文件的 `scripts` 中直接使用。

```json
{
  "scripts": {
    "start:web": "ray start -t web",
    "start:wechat": "ray start -t wechat",
    "build:web": "ray build -t web",
    "build:wechat": "ray build -t wechat"
  }
}
```

## 注意事项

- 务必保证 `@ray-js/*` 依赖的版本最新，否则可能出现 bug。
- 可使用命令 `yarn upgrade --scope @ray-js --caret` 进行更新操作。