安装

Taro 项目基于 node，请确保已具备较新的 node 环境（>=8.0.0），推荐使用 node 版本管理工具 nvm 来管理 node，这样不仅可以很方便地切换 node 版本，而且全局安装时候也不用加 sudo 了。

CLI 工具安装

首先，你需要使用 npm 或者 yarn 全局安装@tarojs/cli，或者直接使用npx:

  1. # 使用 npm 安装 CLI
  2. $ npm install -g @tarojs/cli@next
  3. # OR 使用 yarn 安装 CLI
  4. $ yarn global add @tarojs/cli@next
  5. # OR 安装了 cnpm，使用 cnpm 安装 CLI
  6. $ cnpm install -g @tarojs/cli@next

注意事项

值得一提的是，如果安装过程出现sass相关的安装错误，请在安装mirror-config-china后重试。

  1. $ npm install -g mirror-config-china

项目初始化

使用命令创建模板项目

  1. $ taro init myApp

npm 5.2+ 也可在不全局安装的情况下使用 npx 创建模板项目

  1. $ npx @tarojs/cli init myApp

taro init myApp command screenshot

在创建完项目之后，Taro 会默认开始安装项目所需要的依赖，安装使用的工具按照 yarn>cnpm>npm 顺序进行检测，一般来说，依赖安装会比较顺利，但某些情况下可能会安装失败，这时候你可以在项目目录下自己使用安装命令进行安装

  1. # 使用 yarn 安装依赖
  2. $ yarn
  3. # OR 使用 cnpm 安装依赖
  4. $ cnpm install
  5. # OR 使用 npm 安装依赖
  6. $ npm install

进入项目目录开始开发，目前已经支持 微信/百度/支付宝/字节跳动/QQ 小程序、H5、快应用以及 ReactNative 等端的代码转换，针对不同端的启动以及预览、打包方式并不一致

运行

Taro 需要运行不同的命令，将 Taro 代码编译成不同端的代码，然后在对应的开发工具中查看效果。

image

微信小程序

选择微信小程序模式，需要自行下载并打开微信开发者工具，然后选择项目根目录进行预览。

微信小程序编译预览及打包（去掉 —watch 将不会监听文件修改，并会对代码进行压缩打包）

  1. # yarn
  2. $ yarn dev:weapp
  3. $ yarn build:weapp
  4. # npm script
  5. $ npm run dev:weapp
  6. $ npm run build:weapp
  7. # 仅限全局安装
  8. $ taro build --type weapp --watch
  9. $ taro build --type weapp
  10. # npx 用户也可以使用
  11. $ npx taro build --type weapp --watch
  12. $ npx taro build --type weapp

百度小程序

选择百度小程序模式，需要自行下载并打开百度开发者工具，然后在项目编译完后选择项目根目录下 dist 目录进行预览。

百度小程序编译预览及打包（去掉 —watch 将不会监听文件修改，并会对代码进行压缩打包）

  1. # yarn
  2. $ yarn dev:swan
  3. $ yarn build:swan
  4. # npm script
  5. $ npm run dev:swan
  6. $ npm run build:swan
  7. # 仅限全局安装
  8. $ taro build --type swan --watch
  9. $ taro build --type swan
  10. # npx 用户也可以使用
  11. $ npx taro build --type swan --watch
  12. $ npx taro build --type swan

支付宝小程序

选择支付宝小程序模式，需要自行下载并打开支付宝小程序开发者工具，然后在项目编译完后选择项目根目录下 dist 目录进行预览。

支付宝小程序编译预览及打包（去掉 —watch 将不会监听文件修改，并会对代码进行压缩打包）

  1. # yarn
  2. $ yarn dev:alipay
  3. $ yarn build:alipay
  4. # npm script
  5. $ npm run dev:alipay
  6. $ npm run build:alipay
  7. # 仅限全局安装
  8. $ taro build --type alipay --watch
  9. $ taro build --type alipay
  10. # npx 用户也可以使用
  11. $ npx taro build --type alipay --watch
  12. $ npx taro build --type alipay

字节跳动小程序

选择字节跳动小程序模式，需要自行下载并打开字节跳动小程序开发者工具，然后在项目编译完后选择项目根目录下 dist 目录进行预览。

字节跳动小程序编译预览及打包（去掉 —watch 将不会监听文件修改，并会对代码进行压缩打包）

  1. # yarn
  2. $ yarn dev:tt
  3. $ yarn build:tt
  4. # npm script
  5. $ npm run dev:tt
  6. $ npm run build:tt
  7. # 仅限全局安装
  8. $ taro build --type tt --watch
  9. $ taro build --type tt
  10. # npx 用户也可以使用
  11. $ npx taro build --type tt --watch
  12. $ npx taro build --type tt

QQ 小程序

选择 QQ 小程序模式，需要自行下载并打开QQ 小程序开发者工具，然后在项目编译完后选择项目根目录下 dist 目录进行预览。

QQ 小程序编译预览及打包（去掉 —watch 将不会监听文件修改，并会对代码进行压缩打包）

  1. # yarn
  2. $ yarn dev:qq
  3. $ yarn build:qq
  4. # npm script
  5. $ npm run dev:qq
  6. $ npm run build:qq
  7. # 仅限全局安装
  8. $ taro build --type qq --watch
  9. $ taro build --type qq
  10. # npx 用户也可以使用
  11. $ npx taro build --type qq --watch
  12. $ npx taro build --type qq

常用 CLI 命令

查看 Taro 所有命令及帮助

  1. $ taro --help

环境及依赖检测

Taro 提供了命令来一键检测 Taro 环境及依赖的版本等信息，方便大家查看项目的环境及依赖，排查环境问题。在提 issue 的时候，请附上 taro info 打印的信息，帮助开发人员快速定位问题。

  1. $ taro info
  2. 👽 Taro v1.2.0-beta.15
  5.   Taro CLI 1.2.0-beta.15 environment info:
  6.     System:
  7.       OS: macOS High Sierra 10.13.5
  8.       Shell: 5.3 - /bin/zsh
  9.     Binaries:
  10.       Node: 8.11.2 - /usr/local/bin/node
  11.       Yarn: 1.8.0 - /usr/local/bin/yarn
  12.       npm: 5.6.0 - /usr/local/bin/npm
  13.     npmPackages:
  14.       @tarojs/components: ^1.2.0-beta.3 => 1.2.0-beta.3
  15.       @tarojs/plugin-babel: ^1.2.0-beta.3 => 1.2.0-beta.3
  16.       @tarojs/plugin-csso: ^1.2.0-beta.3 => 1.2.0-beta.3
  17.       @tarojs/plugin-sass: ^1.2.0-beta.4 => 1.2.0-beta.4
  18.       @tarojs/plugin-uglifyjs: ^1.2.0-beta.3 => 1.2.0-beta.3
  19.       @tarojs/rn-runner: ^1.2.0-beta.4 => 1.2.0-beta.4
  20.       @tarojs/router: ^1.2.0-beta.3 => 1.2.0-beta.3
  21.       @tarojs/taro: ^1.2.0-beta.3 => 1.2.0-beta.3
  22.       @tarojs/taro-alipay: ^1.2.0-beta.3 => 1.2.0-beta.3
  23.       @tarojs/taro-h5: ^1.2.0-beta.3 => 1.2.0-beta.3
  24.       @tarojs/taro-swan: ^1.2.0-beta.3 => 1.2.0-beta.3
  25.       @tarojs/taro-weapp: ^1.2.0-beta.3 => 1.2.0-beta.3
  26.       @tarojs/webpack-runner: ^1.2.0-beta.3 => 1.2.0-beta.3
  27.       eslint-config-taro: ^1.2.0-beta.3 => 1.2.0-beta.3
  28.       eslint-plugin-taro: ^1.2.0-beta.3 => 1.2.0-beta.3

Taro Doctor

Taro Doctor 就像一个医生一样，可以诊断项目的依赖、设置、结构，以及代码的规范是否存在问题，并尝试给出解决方案。

但和真正的医生不一样，Taro Doctor 不需要排队挂号，也不用花钱。你只需要在终端运行命令：taro doctor，就像图里一样：

Taro Doctor 诊断结果图

快速创建新页面

Taro create —name [页面名称] 能够在当前项目的pages目录下快速生成新的页面文件，并填充基础代码，是一个提高开发效率的利器。

CLI 配置

自 1.3.9 开始支持

1.3.9 开始 Taro 会在用户根目录下创建 .taro 文件夹，其中 .taro/index.json 用于存放 CLI 相关配置。

开发者可以使用 taro config 命令对配置项进行一系列操作：

  1. # 查看用法
  2. $ taro config --help
  3. # 设置配置项<key>的值为<value>
  4. $ taro config set <key> <value>
  5. # 读取配置项<key>
  6. $ taro config get <key>
  7. # 删除配置项<key>
  8. $ taro config delete <key>
  9. # 打印所有配置项
  10. $ taro config list [--json]

其他常见问题

回到某个版本

需要安装某个固定版本，或者回到某个版本，例如我们要安装 1.3.9 ， 则如下：

  1. # 使用 npm 安装 CLI
  2. $ npm install -g @tarojs/cli@1.3.9
  3. # OR 使用 yarn 安装 CLI
  4. $ yarn global add @tarojs/cli@1.3.9
  5. # OR 安装了 cnpm，使用 cnpm 安装 CLI
  6. $ cnpm install -g @tarojs/cli@1.3.9

保持 @tarojs/cli 的版本与各端依赖版本一致

在使用 Taro 进行多端开发中，请保持 Taro CLI 的版本与你项目的依赖版本一致，否则可能会出现编译错误或者运行时错误。

如果你所使用的 Taro CLI 版本为 1.3.9，而项目里使用的依赖版本为 1.3.20，则有可能会出现问题，这时请将你的 Taro CLI 版本更新至项目依赖版本号相同的版本，如果还是出现问题，请向我们提出 Issue。