FlexCLI工具文档

本文档提供了与插件和FlexDesigner交互的CLI工具的概述和使用指南。该工具提供各种管理插件的命令，如链接、重启、调试、安装和卸载插件。它还支持创建插件项目和验证插件结构。

安装

前置要求

  • Node.js 18或更高版本

  • FlexDesigner 1.0.0或更高版本。

设置

通过运行以下命令安装FlexDesigner CLI工具。

npm install -g @eniactech/flexcli

命令

plugin restart

重启插件。

选项：

  • --uuid <uuid>：要重启的插件UUID（必需）

描述：

此命令使用提供的UUID重启插件。

plugin debug

调试插件。

选项：

  • --uuid <uuid>：要调试的插件UUID（必需）

描述：

此命令用于使用UUID调试插件。它连接到插件并提供调试信息。

plugin list

列出所有已安装的插件。

描述：

此命令列出FlexDesigner中当前安装的所有插件。

plugin pack

将插件打包成.flexplugin文件。

选项：

  • --path <path>：插件目录路径（必需）

  • --output <output>：.flexplugin文件的输出路径

  • --skip-validate：跳过验证（默认：false）

描述：

此命令将插件打包成.flexplugin文件，提供指定输出路径和跳过验证的选项。

plugin install

从.flexplugin文件安装插件。

选项：

  • --path <path>：.flexplugin文件路径（必需）

  • --force：强制安装（默认：false）

描述：

此命令使用.flexplugin文件安装插件。如果文件扩展名不是.flexplugin，将显示错误。--force选项允许强制安装。

plugin uninstall

卸载插件。

选项：

  • --uuid <uuid>：要卸载的插件UUID（必需）

描述：

此命令使用指定的UUID卸载插件。

plugin validate

验证插件的结构和清单。

选项：

  • --path <path>：插件目录路径（必需）

描述：

此命令验证插件目录及其清单，确保它遵循正确的结构。

plugin create

创建基本插件工作空间。

描述：

此命令为新插件创建基本工作空间，允许您指定插件路径、名称、版本、作者、描述和仓库URL等详细信息。

它将提示您输入以下信息：

  • 插件路径

  • 插件名称

  • 作者名称

  • 反向域名UUID（例如，com.author.myplugin）

  • 版本（格式为x.y.z）

  • 描述

  • 仓库URL

创建的工作空间将使用提供的信息进行初始化。

plugin kill

终止插件线程。

描述：

此命令终止FlexDesigner中的插件线程

通用选项

  • --port <number>：指定WebSocket服务器端口（默认：60109）

使用示例

链接插件：

flexcli plugin link --path /path/to/plugin --uuid com.example.plugin --debug true

重启插件：

flexcli plugin restart --uuid com.example.plugin

列出所有插件：

flexcli plugin list

创建新的插件工作空间：

flexcli plugin create