kintoneプラグインをローカルPCから管理画面へアップロードする方法

2026/7/1

概要

kintoneのプラグインを開発していると、毎回手動でzipファイルを作成し、kintoneの管理画面(「cybozu developer network」)からプラグインのアップデートする作業が発生します。

プラグインを修正するたびに手作業でアップロードしていると、確認作業に時間がかかります。

そこで本記事では、ローカル環境で作成したkintoneプラグインを、コマンドを使ってkintoneの「システム管理」→「プラグイン」へアップロードする方法を紹介します。

kintoneプラグインの最小構成

今回は、以下の3ファイルで構成された最小プラグインをアップロードする前提で進めます。

1.manifest.json
2.desktop.js
3.icon.png

ディレクトリ構成

プラグインのディレクトリ構成は以下の通りです。

my-kintone-plugin/
├── manifest.json
├── js/
│   └── desktop.js
└── image/
    └── icon.png

desktop.jsの内容

今回は、kintoneの一覧画面を開いたときにアラートを表示するだけの簡単なプラグインを作成します。

(function () {
  'use strict';

  kintone.events.on('app.record.index.show', function (event) {
    alert('最小プラグインが動きました');
    return event;
  });
})();

manifest.jsonの内容

manifest.jsonには、プラグイン名、説明、アイコン、読み込むJavaScriptファイルなどを設定します。

{
  "manifest_version": 1,
  "version": "1.0.0",
  "type": "APP",
  "name": {
    "ja": "最小プラグイン"
  },
  "description": {
    "ja": "一覧画面でアラートを表示するだけの最小プラグインです。"
  },
  "icon": "image/icon.png",
  "desktop": {
    "js": [
      "js/desktop.js"
    ]
  }
}

秘密鍵を作成する

kintoneプラグインを「cybozu developer network」へアップロードするため、秘密鍵の作成を行います。

以下のコマンドを実行し、秘密鍵の作成を行います。

cli-kintone plugin keygen

実行すると、以下の２つのファイルが生成されます。

private.ppk
public.ppk

プラグインのzipファイルを作成する

次に、プラグインをzipファイルにまとめます。

以下のコマンドを実行します。

cli-kintone plugin pack \
  --input manifest.json \
  --private-key private.ppk \
  --output myplugin.zip

コマンドを実行すると、以下のzipファイルが作成されます。

myplugin.zip

このzipファイルが、kintoneにアップロードするプラグイン本体になります。

kintoneプラグインアップローダーをインストールする

ローカル環境からkintoneへプラグインをアップロードするために、kintone用アップローダー(kintone-plugin-uploader)をインストールします。

npm install -g @kintone/plugin-uploader

そして、kintone用のアップローダーがインストール完了したら、以下のコマンドでプラグインをアップロードします。

kintone-plugin-uploader myplugin.zip \
  --base-url https://xxxxx.cybozu.com \
  --username ユーザー名 \
  --password パスワード
https://xxxxx.cybozu.comの部分は、自分のkintone環境のURLに変更して下さい。
xxxxx.cybozu.comの部分は、自分のkintone環境のURLに変更して下さい。

このコマンドを実行すると、ローカルで作成した myplugin.zip がkintone環境にアップロードされます。

kintoneシステム管理でプラグインのアップロードを確認する

アップロードが完了したら、kintoneの管理画面（「cybozu developer network」）でプラグインが登録されているか確認します。

確認手順は、以下の通りです。

「kintoneシステム管理」→「プラグイン」内に今アップロードされた、プラグインがあるのか確認。

  1. kintoneにログインする
  2. 右上の歯車アイコンをクリックする
  3. 「kintoneシステム管理」を開く
  4. 「プラグイン」をクリック
  5. アップロードしたプラグインが表示されているか確認する

プラグインが一覧に表示されていれば、ローカル環境からkintoneへのアップロードは完了になります。

まとめ

今回は、ローカル環境で作成したkintoneプラグインを、コマンドを使ってkintoneの管理画面へアップロードする方法を紹介しました。

手動でzipファイルを作成して管理画面からアップロードする方法でも対応できますが、開発中は何度も修正と確認を繰り返すため、コマンドでアップロードできるようにしておくと作業効率が上がります。

kintoneプラグインを継続的に開発する場合は、cli-kintone plugin pack と kintone-plugin-uploader を使ったアップロード手順を用意しておくと便利です。

コメント