イントロダクション

目次

はじめに

このシリーズでは cli-kintone の基本的な使い方や、定期的にデータをバックアップする実用的な方法などを学んでいきます。

この記事では、cli-kintone の実行環境を構築する手順を学びましょう。

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

cli-kintone とは

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

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

準備するもの

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

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

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 を使ってレコードの内容を取得してみましょう。