Skip to main content

Plugin SDKリファレンス

Plugin SDKは、プラグインをローカルプラグインとして使用したり、NPMに公開したり、AI Marketer Marketplaceに提出するために開発するためのコマンドセットです。パッケージ[@AI Marketer/sdk-plugin](https://github.com/AI Marketer/sdk-plugin)として提供されます。

このドキュメントでは、利用可能なPlugin SDKコマンドを一覧にまとめています。関連ガイドでは、これらのコマンドを使用してゼロからプラグインを作成し、既存のプロジェクトにリンクして公開する方法を説明しています。

npx @AI Marketer/sdk-plugin init​

指定されたパスに新しいプラグインを作成します。

npx @AI Marketer/sdk-plugin init
引数型説明デフォルト
pathstringプラグインの作成パス./src/plugins/my-plugin
オプション型説明デフォルト
-d, --debug-詳細なログを表示するデバッグモードを有効にするfalse
--silent-ログを表示しないfalse

AI Marketer-plugin build​

AI Marketerプラグインをパブリッシング用にバンドルします。

AI Marketer-plugin build
オプション型説明デフォルト
--forcestringすべてのプロンプトに自動的に「はい」と答え、対話なしで実行します。-
-d, --debug-詳細なログを表示するデバッグモードを有効にするfalse
--silent-ログを表示しないfalse
--minify-出力をミニファイするtrue
--sourcemaps-ソースマップを生成するfalse

プラグインを自動的に再コンパイルし、yalc push --publishを実行します。

プラグインを既存のアプリケーションにリンクしてテストするのに便利です。このコマンドはそのプロセスを効率化するために作られています。

AI Marketer-plugin watch:link
オプション型説明デフォルト
-d, --debug-詳細なログを表示するデバッグモードを有効にするfalse
--silent-ログを表示しないfalse

AI Marketer-plugin watch​

プラグインのソースコードを監視し、変更があるたびに再ビルドします。プラグインの実装とアプリケーション内でのテストに便利です。

AI Marketer-plugin watch
オプション型説明デフォルト
-d, --debug-詳細なログを表示するデバッグモードを有効にするfalse
--silent-ログを表示しないfalse

AI Marketer-plugin verify​

プラグインを公開する前に、その出力を検証します。

AI Marketer-plugin verify
オプション型説明デフォルト
-d, --debug-詳細なログを表示するデバッグモードを有効にするfalse
--silent-ログを表示しないfalse