plugin-uploader
plugin-uploader とは
plugin-uploader は、プラグインファイルを kintone に追加できる CLI ツールです。
npm パッケージとして提供されているため、Windows/macOS/Linux 環境で利用できます。
GitHub
https://github.com/kintone/js-sdk/tree/master/packages/plugin-uploader
ライセンス
ドキュメント
https://github.com/kintone/js-sdk/blob/master/packages/plugin-uploader/README.md
下準備
plugin-uploader を実行するには、Node.js とパッケージ管理ツールの npm が必要です。
Node.js をインストールすると、npm は自動でインストールされます。
-
Node.js 公式サイト
からインストーラーをダウンロードします。
必要な Node.js のバージョンは、リポジトリの packages/plugin-uploader/package.jsonにある engines プロパティを確認してください。
たとえば次の記載の場合、Node.js のバージョン 14 以上が必要です。1 2 3
"engines": { "node": ">=14" },
-
ダウンロードしたインストーラーを実行し、画面にしたがってセットアップします。
Quickstart
Step1:必要なパッケージのインストール
plugin-uploader をインストールします。
ここでは、例として plugin-uploader をグローバルインストールする手順を説明します。
|
|
Step2:プラグインファイルの準備
kintone に追加するプラグインファイルを準備します。
この Quickstart では、
plugin-packer の Quickstart で作成したプラグインファイルを使います。
Step3:kintone にプラグインを追加する
次のコマンドで、kintone にプラグインファイルを追加します。
プラグインファイルを kintone に追加するには、
kintone のシステム管理者
の権限が必要です。
環境に合わせて、次の値を変更してください。
- sample.cybozu.com:適用する kintone のドメイン名
- ログイン名:kintone のログイン名
|
|
パスワードの入力を求められます。
kintone のパスワードを入力して、Enter キーを押します。
|
|
Step4:動作確認
-
kintone システム管理画面を開きます。
-
「その他」の【プラグイン】をクリックします。
-
「読み込んだプラグイン」に、sample プラグインが追加されていることを確認します。
補足
plugin-packerとの連携
プラグインにパッケージングできる plugin-packer と plugin-uploader を組み合わせると、ソースコードを修正したときに、自動でプラグインファイルにパッケージングしてアップロードできます。
-
ターミナルソフトを開きます。
-
プラグインファイルがあるディレクトリーに移動します。
1
cd sample_plugin_project
-
plugin-packer を
--watch
オプションをつけて実行します。1
kintone-plugin-packer --watch src --ppk 秘密鍵ファイル.ppk
-
1 とは別に、ターミナルソフトを開きます。
-
プラグインファイルがあるディレクトリーに移動します。
1
cd sample_plugin_project
-
plugin-uploader を
--watch
オプションをつけて実行します。1
kintone-plugin-uploader --watch plugin.zip
更新履歴
plugin-uploader の変更履歴は、
CHANGELOG
を確認してください。
この記事で紹介しているサンプルコードは、この記事の内容は、2022 年 5 月版 kintone および @kintone/plugin-uploader v7.0.0 で動作を確認しています。