Ginue NPM | npm.io

ginue

ginue is the CLI tool to get settings of kintone via kintone REST API.

kintoneアプリの設定情報を取得するCLI版ツールです。kintone REST APIで情報を取得します。

以下で動作確認済み

macOS Sierra (Node.js v8.2.1)
Windows 10 (Node.js v8.2.1)

インストール方法

グローバルにインストールする場合

$ npm install -g ginue
 or
$ yarn global add ginue

プロジェクトごとにインストールする場合

$ npm install --save-dev ginue
 or
$ yarn add --dev ginue

使い方

現在、全JSONを一括保存するginue pullが使えます。（標準出力のginue show、kintoneに設定を反映するginue pushを今後実装予定）

$ ginue pull [OPTIONS]
$ ginue push [OPTIONS]

オプション一覧

-d, --domain=<DOMAIN>         kintone sub domain name
-u, --user=<USER>             kintone username
-p, --password=<PASSWORD>     kintone password
-a, --app=<APP-ID>            kintone app IDs
-g, --guest=<GUEST-SPACE-ID>  kintone guest space ID
-b, --basic=<USER[:PASSWORD]> kintone Basic Authentication user and password

ginue pull

カレントにアプリID名のディレクトリが作成され、その中に全JSONファイルが保存されます。
取得するJSONファイルはcommands.confに記載します。ginueコマンドファイルと同じディレクトリに格納してください。
app/settings.json preview/app/settings.json以外のJSONファイルでは、revision要素が無視されます。

実行例

$ ginue pull -d ginue.cybozu.com -g 5 -a 10,11,12 -u Administrator
$ ginue pull -d ginue.cybozu.com -b Administrator -a 10,11,12 -u Administrator

共通仕様

オプション引数を指定せずに起動した場合、標準入力を求められます。（-gオプション以外）
ゲストスペース内のアプリ情報を取得する場合は-gオプションが必須です。
アプリID（-aオプション or 標準入力）はカンマ区切りで複数指定可能です。
Basic認証を使用する場合は-bオプションが必須です。パスワードを省略した場合、標準入力を求められます。

.ginuerc.json

コマンドを実行するディレクトリに.ginuerc.jsonという設定ファイルを作成すると、ginue実行時に自動的に読み込まれてオプション指定を省略できます。プロジェクト単位で.ginuerc.jsonを作成すると便利です。

{
  "domain": "ginue.cybozu.com",
  "username": "Administrator",
  "password": "myKintonePassword",
  "app": [10, 11, 12],
  "guest": 5
}

トップレベルを配列にすると、異なる環境のアプリを複数指定して一括取得できます。
environmentプロパティで各環境に名前を付けることができ、その名前のディレクトリ内にJSONが保存されます。
appプロパティにオブジェクトを指定すると、アプリIDではなくアプリ名のディレクトリにJSONが保存されます。

[
  {
    "environment": "development",
    "domain": "ginue-dev.cybozu.com",
    "username": "Administrator",
    "password": "myKintonePassword",
    "app": {
      "user": 128,
      "order": 129,
      "bill": 130
    },
    "basic": "Administrator:myBasicAuthPassword"
  },
  {
    "environment": "production",
    "domain": "ginue.cybozu.com",
    "username": "Administrator",
    "password": "myKintonePassword",
    "app": {
      "user": 10,
      "order": 11,
      "bill": 12
    },
    "guest": 5
  }
]