イントロダクション

目次

「はじめようcli-kintone」とは

「はじめようcli-kintone」シリーズは、cli-kintoneの基本的な使い方や定期的にデータをバックアップする実用的な方法を学ぶコンテンツです。

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

このシリーズで学べること

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

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

cli-kintoneとは

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

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

準備するもの

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

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

STEP 1. cli-kintoneの実行ファイルをダウンロードする

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

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

STEP 2. Windowsユーザー向け:コマンドプロンプトを起動する

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

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

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

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

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

STEP 3. cli-kintoneのバージョンを確認する

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

1
2
3
4
cli-kintone.exe --version

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

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

information

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

おわりに

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

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