■はじめに
サイボウズが開発するコマンドラインでkintoneのレコードデータを入出力できるツール「cli-kintone(クリキントーン)」を使って、kintoneアプリの内容を参照していきます。
■cli-kintoneとは
CLI(Command Line InterFace)でkintoneの処理を行う機能となっております。
【CLI】と【kintone】が合わさって【cli-kintone(クリキントーン】と呼ばれております。
■cli-kintoneのインストール
まず、cli-kintoneをインストールする必要があります。GitHubのReleasesページから、使用するOSに対応した実行ファイルをダウンロードしてください。
<Releasesページ>
https://github.com/kintone/cli-kintone/releases
Windows: cli-kintone-win.zip
macOS : cli-kintone-macos.zip
Linux : cli-kintone-linux.zip
■APIトークンの取得
①kintoneにログインします。
②対象のアプリの「アプリの設定」から「設定」タブ⇒「APIトークン」を選択します。
③上部にある【生成する】ボタンを押下する。
※APIトークンには「レコード追加」「レコード編集」のアクセス権を付与します。
④生成されたAPIトークンを保存して、「保存する」ボタンを押下⇒「アプリを更新」します。
■コマンドラインツールの起動
Windowsの場合、「コマンドプロンプト」があります。
※Windows画面左下のタスクバーに「cmd」と入力すると「コマンドプロンプト」が表示されるので、クリックして起動できます。
もしくは、Windowsのスタートメニューから「Windows システムツール」⇒「コマンドプロンプト」でも起動できます
起動すると下記画像のように表示されます。
上記でcli-kintoneをインストールしたフォルダに移動してください。
※「cd(chdir):ディレクトリの移動」を使用して移動します。
例)以下のファイル構成の場合
【cd c:\users\cli-kintone】を入力することで指定したファイルに移動することができます。
■対象アプリのレコード取得
試しに指定したアプリのレコードが取得できるかを確認していきます。
アプリ内容は以下になります。
以下のコマンドを実行していきます。
<cli-kintone.exe record export --app @@@ --base-url https://@@@.cybozu.com --api-token @@@>
※オプション名
--app:アプリID
--base-url:ドメイン情報
--api-token:APIトークン
@@@:それぞれの値を設定
上記の結果をファイルに書き出す場合、「--encoding sjis > sample.csv」を足すとフォルダ内にファイルが作成されます。
この場合、「users/cli-kintone」内にsample.csvファイルが追加されます。
■まとめ
今回はcli-kintoneのインストールからkintoneにアクセスして指定アプリの内容をコマンドプロンプト内に表示させました。
次回は、CSVファイルの内容をcli-kintoneを使って、特定アプリの内容を追加/更新させていきたいと思います。