功能简介
CLI 是在本地进行低代码开发时需要使用到的命令行辅助工具。
使用 CLI 可以方便地完成登录、模板代码生成、本地调试、代码同步、构建任务跟踪等工作。
目前 CLI 支持在本地对应用包中的前端自定义组件、云函数、微服务进行开发调试。
安装
安装 Nodejs 和 NPM
CLI 通过 NPM 进行包分发，使用 NPM 包管理工具即可方便地安装 CLI。
访问下面的地址，可以在 Nodejs 官方网站下载安装包，在安装完成 Nodejs 后会自动附带一个 NPM 的工具。
- 下载地址
- 推荐版本：10 <= Version < 17 以往的版本
- 安装完毕后，在 终端 输入node -v 命令查看版本信息。
字节内网用户可通过
*
设置为内网源，提前使用内部最新版本
安装 CLI
在终端中执行如下命令进行安装：
字节内网用户可通过
安装完成后，可以在终端中输入以下命令查看 CLI 版本，同时确保已经安装成功：
kldx -v
目前可以安装的版本查看：
- 内网 BNPM（仅字节使用）
查看命令帮助
使用 -h, --help 可以查看命令的帮助信息，在子命令下使用可以查看相应子命令的帮助信息，如下：
kldx -h # 查看所有支持的一级命令
250px|700px|reset
kldx auth login -h # 查看登录命令的参数
250px|700px|reset
Cheat sheet
# 查看帮助
kldx -h
# 查看配置
kldx config list
# 设置环境
kldx config set env-config=<env_url>
# 登录
kldx auth login
# 查看当前登录信息
kldx whoami
# 调起脚手架
kldx gen
# 调起反馈页面
kldx feedback
# 本地调试前端组件
kldx dev
# 本地调试小程序组件
kldx dev --mini
# 查看历史构建信息
kldx build list
# 取消构建任务
kldx build cnacel <build_id>
# 从远端克隆一个工程
kldx project clone <namespace>
# 拉取远端代码
kldx source pull
# 拉取远端代码（冲突以本地为准）
kldx source pull -u local
# 拉取远端代码（冲突以远端为准）
kldx source pull -u remote
# 推送代码
kldx source push
# 强制推送代码（代码未改变但期望触发构建）
kldx source push -f
# 推送代码（冲突以本地为准）
kldx source push -u local
# 推送代码（冲突以远端为准）
kldx source push -u remote
命令详情参考手册
whoami
打印当前默认使用的租户名和用户名
gen
调起脚手架，使用模板创建一个工程、组件、云函数、微服务等
feedback
调起反馈页面
dev
启动自定义组件调试服务
- Options
- --tenant：租户名，若不指定，则会读取缺省租户
- -m, --mini：小程序调试模式
- --mini-design：小程序设计态调试模式
- --mini-build：小程序本地构建
- --clear-cache：清除调试缓存
auth 授权管理
auth account
deprecated：请使用 auth login
使用用户名密码登录到租户（若租户支持密码登录）
- Options
- --tenant：租户名，若不指定，则通过交互式询问获得
- --email：邮箱，若不指定，则通过交互式询问获得
- --password：密码，若不指定，则通过交互式询问获得
auth login
alias：auth web
通过飞书低代码平台 OAuth 授权流程登录
- Options
- --tenant：租户名，若不指定，则通过交互式询问获得
auth logout
移除授权
- Options
- --tenant：租户名，若不指定，则通过交互式询问获得
- -a, --all：移除所有授权记录
- -s, --silent：跳过确认流程
auth list
打印所有已获得的授权记录
config 配置管理
config list
打印所有可用配置，如果在工程目录下执行，会优先选择工程级别的配置
config get [keys]
获取指定的配置
- Arguments
- [keys]：指定要获取的配置键，如果留空表示获取全部配置，多个 key 使用逗号分隔
config set [configs...]
添加配置
- Arguments
- [config...]：指定配置键值，格式如 foo=value foo.bar=value2
- Options
- --global：强制设置为全局配置
config unset <keys...>
移除配置
- Arguments
- <keys...>：指定要移除的键，格式如 foo foo.bar
- Options
- --global：移除全局配置
project 工程管理
project clone <namespace> [destination]
从远端克隆指定的应用包到指定的目录
- Arguments
- <namespace>：用包的命名空间
- [destination]：目标目录，如果不指定，则在当前工作目录下新建与 namespace 同名目录
- Options
- --tenant：租户名，若不指定，则会读取缺省租户
project create <project_name> [destination]
使用模板代码新建一个空的应用包工程
- Arguments
- <project_name>：工程名称
- [destination]：目标目录，如果不指定，则以工程名称作为目录
- Options
- --tenant：租户名，若不指定，则会读取缺省租户
component 组件管理
component create <component_api_name>
使用模板创建一个新的组件
- Arguments
- <component_api_name>：组件的唯一标识符
- Options
- -t, --template：指定使用的模板名称，如果不指定，则会通过交互式方式询问获得
component dev
启动自定义组件本地调试服务
- Options
- --tenant：租户名，若不指定，则会读取缺省租户
microservice 微服务管理
microservice create
使用模板创建一个微服务资源
- Options
- -n, --name：微服务名称
- -t, --type：微服务类型，可选值为 nodejs/golang/python3/java
microservice dev
调试指定的微服务资源
- Options
- -n, --name：微服务名称
source 源码管理
source status
打印本地和远端应用包源码的差异和冲突
- Options
- --tenant：租户名，若不指定，则会读取缺省租户
- -l, --local：仅检查本地的改动
- -r, --remote：仅检查远端的改动
- -f, --fetch：拉取最新的远端包，而不使用缓存
source pull
拉取远端应用包，并合入到本地工程
- Options
- --tenant：租户名，若不指定，则会读取缺省租户
- -u, --use：当发生变更冲突时选择哪个端的版本，可选值为 local/remote
source push
将远端应用包合入本地后，再推送应用包到远端
- Options
- --tenant：租户名，若不指定，则会读取缺省租户
- -u, --use：当发生变更冲突时选择哪个端的版本，可选值为 local/remote
- -f, --force：当本地和远端均无变更时，强制进行推送以触发构建
build 构建管理
build status [build_task_id]
查询指定的构建任务状态
- Arguments
- [build_task_id]：构建任务的 id，若不指定，则查询最近一次构建任务
- Options
- --tenant：租户名，若不指定，则会读取缺省租户
build list
打印构建任务记录列表
- Options
- --tenant：租户名，若不指定，则会读取缺省租户
- --limit：查询的记录条数，默认 20 条，最多 50 条
build cancel <build_task_id>
取消进行中的构建任务
- Arguments
- <build_task_id>：构建任务的 id
- Options
- --tenant：租户名，若不指定，则会读取缺省租户
推荐阅读
最后更新于 2022/07/08
