plugin-uploaderは、プラグインファイルをkintoneに追加できるCLIツールです。

npmパッケージとして提供されているため、Windows／macOS／Linux環境で利用できます。

https://github.com/kintone/js-sdk/tree/main/packages/plugin-uploader

MITライセンス

https://github.com/kintone/js-sdk/blob/main/packages/plugin-uploader/README.md

plugin-uploaderを実行するには、Node.jsとパッケージ管理ツールのnpmが必要です。
Node.jsをインストールすると、npmは自動でインストールされます。

1. Node.js公式サイトからインストーラーをダウンロードします。
   Node.js公式サイト
   必要なNode.jsのバージョンは、下記リポジトリにあるenginesプロパティを確認してください。
   packages/plugin-uploader/package.json
   たとえば次の記載の場合、Node.jsのバージョン14以上が必要です。

   1 2 3

   "engines": { "node": ">=14" },

2. ダウンロードしたインストーラーを実行し、画面にしたがってセットアップします。

plugin-uploaderをインストールします。
ここでは、例としてplugin-uploaderをグローバルインストールする手順を説明します。

1

npm install -g @kintone/plugin-uploader

kintoneに追加するプラグインファイルを準備します。
このQuickstartでは、以下のplugin-packerのQuickstartのQuickstartで作成したプラグインファイルを使います。

• plugin-packerのQuickstart

次のコマンドで、kintoneにプラグインファイルを追加します。
プラグインファイルをkintoneに追加するには、kintoneのシステム管理者の権限が必要です。
kintoneのシステム管理者
環境に合わせて、次の値を変更してください。

• sample.cybozu.com：適用するkintoneのドメイン名
• ログイン名：kintoneのログイン名

1

kintone-plugin-uploader --base-url https://examle.cybozu.com --username ログイン名 plugin.zip

パスワードの入力を求められます。
kintoneのパスワードを入力して、Enterキーを押します。

1

? パスワードを入力してください: [hidden] [input is hidden]

1. kintoneシステム管理画面を開きます。

2. 「その他」の【プラグイン】をクリックします。

3. 「読み込んだプラグイン」に、sampleプラグインが追加されていることを確認します。
   

   

プラグインにパッケージングできるplugin-packerとplugin-uploaderを組み合わせると、ソースコードを修正したときに、自動でプラグインファイルにパッケージングしてアップロードできます。
plugin-packer

1. ターミナルソフトを開きます。

2. プラグインファイルがあるディレクトリに移動します。

   1	cd sample_plugin_project

3. plugin-packerを--watchオプションをつけて実行します。

   1	kintone-plugin-packer --watch src --ppk 秘密鍵ファイル.ppk

4. 1とは別に、ターミナルソフトを開きます。

5. プラグインファイルがあるディレクトリに移動します。

   1	cd sample_plugin_project

6. plugin-uploaderを--watchオプションをつけて実行します。

   1	kintone-plugin-uploader --watch plugin.zip

plugin-uploaderの変更履歴は、以下のCHANGELOGを確認してください。
CHANGELOG

この記事で紹介しているサンプルコードは、この記事の内容は、2022年5月版kintoneおよび @kintone/plugin-uploader v7.0.0で動作を確認しています。