Skip to main content

命令行工具（CLI）

介绍​

Zeus Cli是一个基于Zeus小程序框架的快速开发的工具，以实现为用户及开发人员提供更好的体验，提供以下功能：

  • 实现的交互式的项目脚手架
  • 使用来自 npm 的模板项目
  • 连接模拟器实时预览
  • 使用Zepp APP扫码真机预览
  • 编译打包应用

前置条件​

开始之前你需要在macOS、Windows(WSL)或Linux系统上安装14.x版本以上的Node.js

CLI (@zeppos/zeus-cli) 是一个全局安装的 npm 包，提供了终端里的 zeus 命令。

npm i @zeppos/zeus-cli -g

创建项目​

使用 @zeppos/zeus-cli 创建一个新项目：

zeus create hello-world

NOTE
hello-world 为创建的项目名


按照如下选择，生成项目：

? Which kind of template application need to created? Empty
? What type of application should be created? APP
? Should this application contain a app-side component? Yes
? Should this application contain a settings component? Yes
? Which platforms should this application be built for? GTR3 Pro, GTR3

创建完成，hello-world 项目目录结构如下：

└── hello-world
    ├── app-side
    │   ├── i18n
    │   │   └── en-US.po
    │   └── index.js
    ├── app.js
    ├── app.json
    ├── assets
    │   ├── 436x436-gtr-3
    │   └── 480x480-gtr-3-pro
    ├── pages
    │   ├── example
    │   │   └── index.js
    │   ├── i18n
    │   │   └── en-US.po
    │   └── index.js
    └── setting
        ├── i18n
        │   └── en-US.po
        └── index.js

登录​

执行 zeus login，自动跳转登录界面，输入开放平台账户/密码即可登录，登录后可使用部分与账户关联的功能。

开发调试​

进入项目根目录，执行 zeus dev 即可启动本地调试。

# 进入项目根目录
cd hello-world

# 启动开发调试
zeus dev

模拟器中可以看到应用已安装，修改项目代码会触发重新编译和重新安装。

真机预览​

进入项目根目录，执行 zeus preview 即可启动真机预览。

# 启动真机预览
zeus preview

NOTE
未登录时会主动跳转登录界面


选择对应设备的包。

? Which target would like you to build?
> 480x480-gtr-3-pro
  454x454-gtr-3


? Which target would like you to build? 480x480-gtr-3-pro
begin generate qrcode

此时终端将显示二维码，使用 Zepp APP 扫码即可安装至设备中。

真机预览示例二维码

NOTE
扫码入口：我的 > 进入已绑定设备的设置界面 > 开发者模式
未发现开发者模式？请查看开发者模式

developMode

应用安装包构建​

进入项目根目录，执行 zeus build 即可启动项目包构建。

# 启动项目包构建
zeus build

构建完成后，在项目 dist/ 目录中可获取项目的安装包。

设置配置​

  • zeus config list
    查看当前所有配置

  • zeus config set <key>=<value>
    新增配置

    NOTE
    多个设置用空格分隔

  • zeus config get <key>
    查看某个配置

  • zeus config delete <key>
    删除配置

Developer Bridge模式​

进入项目根目录，执行 zeus bridge 即可进入Developer Bridge模式。通过Developer Bridge模式可与运行环境建立连接。详细信息请查看Developer Bridge模式

查看状态​

执行 zeus status 即可查看当前登录状态及用户信息（昵称/userID）、模拟器连接状态等信息。

NOTE
已登录状态下才可查看用户信息