garoon-plugin-uploader

garoon-plugin-uploader とは

garoon-plugin-uploader は、プラグインファイルを Garoon に追加できる CLI ツールです。
npm パッケージとして提供されているため、Windows／macOS／Linux 環境で利用できます。

導入方法

下準備

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

Node.js 公式サイトからインストーラーをダウンロードします。
必要な Node.js のバージョンは、 package.json の engines プロパティの値を確認します。
たとえば次の記載の場合、Node.js のパージョン 14 以上が必要です。
1 2 3

"engines": { "node": ">=14" },
ダウンロードしたインストーラーを実行し、画面にしたがってセットアップします。

必要なパッケージのインストール

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

1

npm install -g @garoon/plugin-uploader

garoon-plugin-uploader のバージョンを確認する

garoon-plugin-uploader のバージョンを表示して、garoon-plugin-uploader を実行できるかを確認します。

1
2
3


garoon-plugin-uploader --version

1.0.1 # バージョン番号

操作方法

プラグインをアップロードする

Garoon にプラグインをアップロードするには、 --plugin-path にプラグインファイルを指定します。

アップロードするプラグインファイルを準備する。
Garoon に追加するプラグインの zip ファイルをあらかじめ準備します。

Garoon にプラグインファイルを追加する。
次のコマンドで、Garoon にプラグインファイルを追加します。
プラグインを Garoon に追加するには Garoon のシステム管理者の権限が必要です。

1
2


garoon-plugin-uploader --base-url https://sample.cybozu.com --username ログイン名 --password パスワード \
  --plugin-path プラグインファイルのパス

環境に合わせて、次の値を変更してください。

sample.cybozu.com：適用する Garoon のドメイン名
ログイン名：Garoon のログイン名
パスワード：Garoon のログインパスワード
プラグインファイルのパス：zip ファイルを配置している場所への相対パス

実行例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


garoon-plugin-uploader --base-url https://sample.cybozu.com --username yamada_taro --password Dj7m4hNL \
  --plugin-path ~/Downloads/create-company-portal-plugin-v1.0.0.zip

Open https://sample.cybozu.com/login?saml=off
Trying to login.....
Success Login!
Navigate to https://sample.cybozu.com/g/system/plugin/settings.csp
Start uploading file...........
End uploading file.
Waiting for reading file...........
Success submitting file!

Garoon にプラグインが追加されているか確認する。
Garoon システム管理画面よりプラグインの設定を開き、プラグインが追加されているか確認します。

プラグインを更新する

Garoon にすでに追加しているプラグインを更新するには、適用するプラグインファイルのパスと --plugin-id にプラグイン ID を指定します。
--plugin-id を指定しない場合、新しいプラグインとして追加されます。

更新するプラグインの zip ファイルを準備する。
更新するプラグインのプラグイン ID を調べる。
プラグイン ID はプラグインの詳細画面の URL 内で確認します。
次のような URL の場合、プラグイン ID は「1」です。
1

https://sample.cybozu.com/g/system/plugin/view.csp?id=1

プラグインを更新する。
次のコマンドで、Garoon に追加されているプラグインを更新します。
プラグインを更新するには、Garoon のシステム管理者の権限が必要です。

1
2


garoon-plugin-uploader --base-url https://sample.cybozu.com --username ログイン名 --password パスワード \
  --plugin-path プラグインファイルのパス --plugin-id プラグイン ID

環境に合わせて次の値を変更してください。

sample.cybozu.com：適用する Garoon のドメイン名
ログイン名：Garoon のログイン名
パスワード：Garoon のログインパスワード
プラグインファイルのパス：zip ファイルを配置している場所への相対パス
プラグイン ID：更新するプラグインのプラグイン ID

実行例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


garoon-plugin-uploader --base-url https://sample.cybozu.com --username yamada_taro --password Dj7m4hNL \
  --plugin-path ~/Downloads/sample-plugin-v2.0.0.zip --plugin-id 1

Open https://sample.cybozu.com/login?saml=off 
Trying to login..... 
Success Login! 
Navigate to https://sample.cybozu.com/g/system/plugin/view.csp?id=1 
Start uploading file........... 
End uploading file. 
Waiting for reading file........... 
Success submitting file!

プラグインが更新されているか確認する。
Garoon システム管理画面より該当するプラグインのプラグインの詳細を開き、プラグインが更新されているか確認します。

コマンド実行前（適用しているプラグインのバージョンが「ver.1.0.0」）

コマンド実行後（適用しているプラグインのバージョンが「ver.2.0.0」）

制限事項

garoon-plugin-uploader を利用するには、次のいずれかの権限が必要です。
- システム管理者（cybozu.com共通管理者）
- プラグインの管理権限がある基本システム管理者
SAML 認証を設定している場合には、システム管理者（cybozu.com 共通管理者）で実行してください。

更新履歴

garoon-plugin-uploader の最新の更新内容は、 Releases を確認してください。

2022 年 10 月 11 日：記事を公開しました。

この記事の内容は、2022 年 10 月版 Garoon および @garoon/plugin-uploader v1.0.1 で動作を確認しています。

SDK & Tools