kintone（キントーン）のコマンドラインツール（cli-kintone）

こんにちは。kintone（キントーン）導入支援のギャンです。
今回は「kintone（キントーン）のコマンドラインツール（cli-kintone）」ということで、kintoneのコマンドラインツールであるcli-kintoneについてご紹介いたします。

cli-kintoneとは

kintoneにコマンドラインツールがあることをご存じでしょうか？知っていても、実際に使ったことがあるという方は少ないかもしれません。cli-kintone（クリキントーン）は、コマンドでkintone のレコード情報を入出力できるツールです。また、レコードの入出力だけではなくkintoneの画面ではできない一括でレコードの添付ファイルをダウンロードしたり、一括で添付ファイルをレコードに添付するということもできます。なお、cli-kintoneはコマンドラインツールとして提供されているため、コマンドプロンプトからだけではなく、シェルスクリプトファイルから呼び出しても実行できます。cli-kintoneはkintoneのREST APIを活用したコマンドラインのclientツールです。

入手方法

cli-kintoneはGitHub（https://github.com/kintone/cli-kintone）からダウンロードできます。

1. GitHub の Releases ページ  にアクセスします。
2. 「Assets」から実行する環境に合わせてファイルをダウンロードします。
   • Windows で実行する場合：cli-kintone-win.zip
   • Linux で実行する場合：cli-kintone-linux.zip
   • macOS で実行する場合：cli-kintone-macos.zip
3. ファイルを解凍し、実行ファイルを任意のディレクトリーに置きます。

できること

cli-kintoneでできることは以下の通りです。

1.kintoneのレコードをエクスポートする。
　指定したアプリのレコードをCSV形式でエクスポートできます。その際に絞り込み条件やデータの並び順を指定できます。なお、レコード内のテーブルのデータについてもエクスポートできます。

2.添付ファイルをダウンロードする。
　レコードに添付されたファイルを指定したディレクトリーにダウンロードできます。

3.kintoneのレコードをインポートする。
　指定したアプリにレコードを追加または更新することができます。インポートできるのはCSV形式のデータです。なお、レコード内のテーブルへの追加、更新もできます。

4.添付ファイルをアップロードする。
　添付ファイルをアップロードして指定したアプリのレコードに添付することができます。１つのフィールドに複数のファイルを添付することも可能です。また、すでにファイルが添付されているフィールドの添付ファイルを削除することもできます。

5.kintoneのレコードを削除する。
　指定したアプリのすべてのレコードを削除するだけでなく、指定したレコード番号のレコードだけ削除することもできます。

詳しい使い方については、cybozu developer network のkintoneコマンドラインツール（cli-kintone）を参照してください。

制限事項

IPアドレス制限を設定している場合、実行する環境のIPアドレスからのアクセスを許可するか、ユーザー認証を使って、セキュアアクセスを設定したユーザーのクライアント証明書を指定してください。

活用方法

cli-kintoneはシェルスクリプトファイルから実行することができますので、WindowsのタスクスケジューラーやMac、Linuxのcronから定期実行することができます。例えば毎月、CSVファイルを読み込んでレコードを追加、更新したりすることが可能です。また、定期的にアプリのレコードのバックアップを取ることも可能です。さらに、毎日、レコードを取得して他システムへ取り込むなど、他システム、他サービスとの連携に活用することもできます。

kintoneのコマンドラインツール（cli-kintone）のまとめ

cli-kintoneを活用することで、kintoneの標準機能やプラグインでは実現できない自動化を行うことができますので、kintoneの活用の幅を大きく広げることが可能になります。ぜひ、cli-kintoneを有効活用していただければと思います。