cli-kintoneは、CSVファイルを使ってkintoneのレコード操作できるツールです。
「はじめようcli-kintone」シリーズは、cli-kintoneの基本的な使い方や、バッチ処理で定期的にデータをバックアップする実用的な方法を学ぶコンテンツです。

実行例ではWindowsのコマンドプロンプトを使って説明しています。
ほかの環境で実行する場合には、適宜パスやファイル名を読み替えてください。

このシリーズを学習し終えると、次のことができるようになります。

• cli-kintoneを実行する環境を構築する。
• レコードのデータをCSVファイルにエクスポートする。
• CSVファイルのデータをkintoneアプリにインポートする。
• 添付ファイルを含むレコードのデータをダウンロード／アップロードする。
• 定期的にレコードのデータをバックアップするためのスクリプトを作成する。

kintoneコマンドラインツール（cli-kintone） とは、コマンドでkintoneのレコード情報を入出力できるツールです。
kintoneの標準機能でも、ExcelファイルやCSVファイルで、インポートやエクスポートできます。
ですが、cli-kintoneを利用すると、標準機能ではできない次の操作もできます。

• レコードの添付ファイルを、一括でダウンロード/アップロードする。
• 運用中のkintoneのアプリのデータを、別ドメインのkintoneアプリに定期的にバックアップする。
  

  

このチュートリアルでcli-kintoneの使い方を学ぶために、次の環境を用意しましょう。

• cli-kintoneの実行ファイル
• kintone開発者ライセンス
• cybozu.comの 推奨ブラウザ

kintone開発者ライセンス未取得の方は、 kintone開発者ライセンス（開発環境） から開発者ライセンスを申し込みましょう。

cli-kintoneのWindows／macOS／Linux向けの実行ファイルは、GitHubからダウンロードできます。

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

コマンドプロンプトは次の手順で起動します。コマンドプロンプトは、cli-kintoneを実行するために必要なツールです。

1. 【Win】キーと【R】キーを同時に押します。
   「ファイル名を指定して実行」が開きます。

2. 「名前」の欄に「cmd」を入力し、【OK】をクリックします。
   コマンドプロンプトが起動します。

   

3. cdコマンドで、cli-kintone.exeを置いたディレクトリに移動します。

   1 2	# デスクトップに「works」ディレクトリを作成し、作成したディレクトリにcli-kintone.exeをおいた場合 cd C:\Users\Desktop\works

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

1
2
3
4

cli-kintone.exe --version

# バージョン番号が表示される
1.8.0

ダウンロードしたバージョン番号が表示されれば完了です。

mac OSをご利用の方は、cli-kintoneコマンドを実行する前に、ダウンロードしていただいた「cli-kintone」へパスを通す必要があります。
bash_profileなどにcli-kintoneが保存されているディレクトリへパスを通すことで、cli-kintoneコマンドが実行可能になります。

今回は、cli-kintoneをダウンロードして、実行できるまでの手順を学びました。

次回は、 データのエクスポート で実際にcli-kintoneを使ってレコードの内容を取得してみましょう。

補足

kintoneの最新の技術情報は、X（旧Twitter）で紹介しています。
@kintonedevjp フォローし、チェックしましょう。