使用 AntCubeTool

本文介绍了一些使用 AntCubeTool 的常见场景中需要用到的 act 命令。

新建工程

act init:新建工程。

说明

配置中的 name 类字段会作为创建文件或文件夹的依据,仅支持字母、数字、下划线和中折线。

➜  ~ act init -h
Usage: act init [options]

在当前目录下初始化一个Cube应用

Options:
  -h, --help        display help for command

启动服务

act prepare:清理历史端口。

act server:开启连接监听。

➜  ~ act prepare --help
Usage: act prepare [options]

准备环境

Options:
  -h, --help  display help for command
  
➜  ~ act server --help
Usage: act server [options]

启动通信服务器

Options:
  -h, --help  display help for command

在 macOS 中一般会组合使用这两条命令。在终端中执行了这两条命令后,在启动成功前不可以关闭终端窗口。启动成功后,在终端可以看到以下信息。期间如需执行其他 act 命令,可打开新的终端窗口执行。

➜  ~ act prepare && act server
2021-1-7 16:38:25 [ACT] [INFO] cmd : kill -9 $(lsof -t -i:9001)
kill: usage: kill [-s sigspec | -n signum | -sigspec] pid | jobspec ... or kill -l [sigspec]
2021-1-7 16:38:25 [ACT] [INFO] 端口清理完毕
2021-1-7 16:38:26 [ACT] [INFO] 启动服务 [30.30.200.193:9001]
2021-1-7 16:38:26 [ACT] [INFO] 通信通道已就绪,请扫描二维码或输入端口号进行连接
2021-1-7 16:38:26 [ACT] [INFO]
▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
█ ▄▄▄▄▄ █▄▄████ ██▀█▄█▀▀ ▀█ █ █ ▄▄▄▄▄ █
█ █   █ █ ▀█ ▄▄▄▀ ▀▀█▀█▀▀▀ ▀▀▄█ █   █ █
█ █▄▄▄█ █▄ ▄▄▀▄ ▄▀▀▀ ▄ ██▄▀█▄▄█ █▄▄▄█ █
█▄▄▄▄▄▄▄█▄▀▄▀▄▀ █▄▀▄▀▄█▄▀ █ ▀ █▄▄▄▄▄▄▄█
█  ▄ ▀▀▄█ ▀███▄▄██▄█▀█▄ ▀▄ ▄▄█▄█▀▄  ▀▄█
█▀▀▄▀▀█▄▀▀ █▀▀▀ █ ██▀▄█▄ ▄▀ █▀ █▄  ▀▀██
█ █▄▀▄ ▄▄ ▀█ █▀█▀▄  ▀ █▄█ ▄   ▄ ▀ █▄▀ █
█ █▀▀▄ ▄▄▄▀▄█ ▀▄▀▀█▀ ▄  █ ▄▄▀▄█▀▄▄ █▄▀█
█▀█▀▀ ▀▄█▄█▀▄▀▀█  █▀██   ▀▄ ▀▄█▀▄█▄▄ ▀█
█▀ ▄▀ ▄▄▀ █▄▄ ██▄▀▀▄█▄█ █ █▄▄▄██ ▄▄▄▄▄█
███▄█ ▀▄██▄ ▄  ▀█▀ ▀▀▄▄█▀▀█▀▀ ██ ▄█▀█▄█
█  ▀▀▀▄▄▀▄█▀▄▄▄█▀▀█▄▀▄▄  █ ▄██▀ ██▄ ███
██ ▀▀▄█▄▄ █▄▀ █     ▀▄▀▄██▄█  ▄ ▀    ▀█
█▀▄ ▄█▄▄▀███ █▄▀█▀██▄▄ ███▄██▄▀█ █▄█ ▀█
█████▄▄▄█▀▀██▄█  █▀▀▄ ▄  ▄  ▀ ▄▄▄ ▄ ▄▀█
█ ▄▄▄▄▄ ████▀█  ▄█▀ ▀█▄ ▀▄█▀▀ █▄█  █▄ █
█ █   █ █▀█ ██▄▄█▀▄█ █ █▀ █▀█▄    █▀ ▀█
█ █▄▄▄█ █ ▄█▀▀▀ ▀██▀▀ ▄█ █▀▄██▀▄▄▄▀▀███
█▄▄▄▄▄▄▄█▄▄▄▄███▄█▄▄█▄█▄██▄████▄██▄▄▄▄█

2021-1-7 16:38:26 [ACT] [INFO] 路由模块启动完毕
2021-1-7 16:38:26 [ACT] [INFO] 服务启动完毕,请勿关闭终端窗口

建立连接

通过 蚂蚁动态卡片-开发工具 可以建立连接。更多详情,请参见:

编译工程

act build:编译工程。

➜  ~ act build --help
Usage: act build [options] [path]

编译指定路径下的卡片应用,未指定路径时使用当前路径

Options:
  -p, --path [v]  待编译路径,兼容老版本工具【已废弃: 请直接使用 build [path] 】
  -a, --all <v>   批量编译,兼容老版本工具【已废弃: 请使用 build [path] --batch 】
  --batch         是否为批量处理模式 (default: false)
  --watch         是否打开实时编译,不支持批量处理模式 (default: false)
  -h, --help      display help for command

配置了 --watch 参数时,即打开了实时编译时,ACT 将监听整个工程目录内的文件变更,并在文件保存时自动触发编译。

重要

开启实时编译时请勿关闭终端窗口。

预览工程

通过 蚂蚁动态卡片-开发工具 可以进行工程预览。更多详情,请参见:

​实时预览

通过 蚂蚁动态卡片-开发工具 可以进行实时预览。更多详情,请参见:

查看当前连接二维码

act qrcode:查看当前连接二维码。该命令用于需要重新连接 Playground 设备的场景。act server 长时间运行后,日志过多,无法看到 act server 之前输出的二维码内容,此时就可以通过 qrcode 命令再次查看二维码。

➜  ~ act qrcode --help
Usage: act qrcode [options]

显示可供连接的二维码

Options:
  -o, --onlyInfo  仅输出二维码内容,默认关闭,启用时不会输出二维码模拟图像内容 (default: false)
  -p, --pure      仅输出内容,不包含格式化信息(时间、前缀等) (default: false)
  -h, --help      display help for command

通过配置参数,可以仅输出二维码内容字符串。其他基于 ACT 的工具可以考虑通过这种方式获取到二维码内容。

act qrcode -o -p

查看当前连接设备

act device:查看当前连接设备。该命令主要用于查看当前的 server 上是否有已连接的 Playground 设备,设备未连接时 preview、alive 类预览功能无法工作。

➜  ~ act device --help
Usage: act device [options]

显示当前连接的设备列表

Options:
  -h, --help  display help for command

查看帮助

  • 查看支持的指令集

act -h
  • 查看指令相关参数

act [command] -h

查看信息

act info