FlexCLI ツールのドキュメント
このドキュメントでは、プラグインおよび FlexDesigner と対話する CLI ツールの使用に関する概要とガイドを提供します。このツールは、プラグインのリンク、再起動、デバッグ、インストール、アンインストールなど、プラグインを管理するためのさまざまなコマンドを提供します。また、プラグイン プロジェクトの作成とプラグイン構造の検証もサポートされています。
インストール
前提条件
- Node.js バージョン 18 以降
- FlexDesigner バージョン 1.0.0 以降。
設定
次のコマンドを実行して、FlexDesigner の CLI ツール（FlexCLI）をインストールします。
npm install -g @eniactech/flexcliコマンド
plugin link
プラグインを FlexDesigner にリンクします。
オプション:
--path <path>: Path to the plugin directory (required)--uuid <uuid>: UUID of the plugin (required)--debug <debug>: Enable or disable debug mode (default: false)--skip-validate: 検証ステップをスキップします (デフォルト: false)--force: 既存のプラグインを強制的にオーバーライドします (デフォルト: false)--start <start>: Whether to start the plugin after linking (default: true)
説明:
このコマンドは、プラグインのパスと UUID を指定して、プラグインを FlexDesigner にリンクします。また、デバッグ モードを有効にし、検証をスキップし、強制的にオーバーライドし、リンク後にプラグインを開始するオプションも提供します。
plugin restart
プラグインを再起動します。
オプション:
--uuid <uuid>: UUID of the plugin to restart (required)
説明:
このコマンドは、指定された UUID を使用してプラグインを再起動します。
plugin unlink
FlexDesigner からプラグインのリンクを解除します。
オプション:
--uuid <uuid>: UUID of the plugin to unlink (required)--silent: 出力なしでサイレント モードで実行します (デフォルト: false)
説明:
このコマンドは、指定された UUID を使用して FlexDesigner からプラグインのリンクを解除します。
plugin debug
プラグインをデバッグします。
オプション:
--uuid <uuid>: UUID of the plugin to debug (required)
説明:
このコマンドは、UUID を指定してプラグインをデバッグするために使用します。プラグインに接続し、デバッグ情報を取得できます。
plugin list
インストールされているすべてのプラグインをリストします。
説明:
このコマンドは、FlexDesigner に現在インストールされているすべてのプラグインを一覧表示します。
plugin pack
プラグインを .flexplugin ファイルにパックします。
オプション:
--path <path>: Path to the plugin directory (required)--output <output>: Output path for the.flexpluginfile--skip-validate: 検証をスキップします (デフォルト: false)
説明:
このコマンドは、出力パスの指定と検証のスキップのオプションを使用して、プラグインを .flexplugin ファイルにパッケージ化します。
plugin install
.flexplugin ファイルからプラグインをインストールします。
オプション:
--path <path>: Path to the.flexpluginfile (required)--force: インストールを強制します (デフォルト: false)
説明:
このコマンドは、.flexplugin ファイルを使ってプラグインをインストールします。拡張子が .flexplugin でない場合はエラーが表示されます。--force オプションでインストールを強制できます。
plugin uninstall
プラグインをアンインストールします。
オプション:
--uuid <uuid>: UUID of the plugin to uninstall (required)
説明:
このコマンドは、指定された UUID を使用してプラグインをアンインストールします。
plugin validate
プラグインの構造とマニフェストを検証します。
オプション:
--path <path>: Path to the plugin directory (required)
説明:
このコマンドは、プラグイン ディレクトリとそのマニフェストを検証して、正しい構造に従っていることを確認します。
plugin create
基本的なプラグイン ワークスペースを作成します。
説明:
このコマンドは、新しいプラグインの基本的なワークスペースを作成し、プラグインのパス、名前、バージョン、作成者、説明、リポジトリ URL などの詳細を指定できるようにします。
次の情報の入力を求められます。
- プラグインのパス
- プラグイン名
- 著者名
- 逆引きドメイン UUID (例:
com.author.myplugin) - バージョン（
x.y.z形式） - 説明
- リポジトリ URL
作成されたワークスペースは、指定された情報で初期化されます。
plugin kill
プラグインスレッドを強制終了します。
説明:
このコマンドは、FlexDesigner のプラグイン スレッドを強制終了します。
共通オプション
--port <number>: Specifies the WebSocket server port (default: 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