kldx 是 「飞书低代码平台」提供给用户在命令行中进行低代码开发的辅助工具,在安装 kldx 的过程中我们需要处理诸多的前置条件,这篇文档希望详细介绍安装的过程以及可能遇到的问题,帮助你成功安装并使用 kldx。
本篇文档主要包含如下五个部分:
- 命令行工具准备
- Node.js 版本选择
- 安装 kldx
命令行工具准备
因为 kldx 是一个命令行中的命令,所以我们需要通过命令行工具去安装这个命令,而用户可能使用 Windows/Linux/Mac OS 等操作系统,所以我们针对各个操作系统下的我们推荐使用对应的命令行工具:
- Windows:PowerShell
- Linux:自带的命令行工具
- Mac OS:自带的 “终端”,或者 iTerm
Node.js 安装
kldx 是一个发布到 Npm 源的一个 NPM 包模块,我们需要通过 Node.js 自带的包管理工具 Npm 来安装它,所以为了安装 kldx,我们需要确保在本机安装了 Node.js 环境,安装 Node.js 时会自动安装对应的 Npm 包管理工具。
当安装完 Node.js 之后,我们就可以打开命令行工具来测试是否安装成功。打开命令行工具,输入如下命令:
node -v # v18.9.0
npm -v # 8.19.1
当命令行中出现对应的输出时,代表 Node.js 与 Npm 包管理工具已经成功安装 🎉。
安装 kldx
当经过前四步的确认并且没有问题之后,我们就准备好了所有的前置条件,这时你就可以正式安装 kldx 命令了!
我们打开命令行工具,在其中运行如下命令:
注意:kldx 命令安装时的包名为 @kunlun-dx/cli ,版本指定为 latest ,这样可以保持每次安装的 kldx 版本都是最新的内容,安装成功之后,我们就可以使用 kldx 在命令行中使用 「飞书低代码平台」低代码的功能。
由于 kldx 集成了比较复杂的功能集合,因此包体相对较大,耐心等待安装命令执行成功即可。安装成功后,可执行如下命令检验安装是否成功:
kldx -v
至此,正式完成所有的准备工作!后续我们就可以在项目目录下,使用 kldx 执行命令来与「飞书低代码平台」低代码系统进行交互。
常见问题
如果你按照上述安装过程进行 kldx 安装时仍然遇到了问题,可以参考下述常见问题中的对应内容进行排错:
- 常见问题 FAQ