メインコンテンツまでスキップ

はじめに

備考

基本的な使い方については、こちらのチュートリアルもご参照ください。

cli-kintoneとは？​

cli-kintoneは、kintoneのレコードをインポート・エクスポートするためのCLIツールです。バッチ処理によるレコード操作に適しています。

  • Kintoneレコードのバックアップ/リストア
  • KintoneとBIプラットフォーム間のデータ同期
  • 他システムからのデータ移行
発音

cli-kintoneは「クリキントーン」と発音します。名前は日本の和菓子栗きんとんに由来しています。

なぜcli-kintoneなのか？​

cli-kintoneは、kintoneの導入/運用に関わるIT人材（SI、情シス）の方々の業務パフォーマンスを向上させます。

Web GUI、CLI、APIの比較は以下の通りです：

  • Web GUI
    • 学習コストが低い
    • 操作が簡単
    • 自動化が困難
    • 主にエンドユーザー向け
  • CLI
    • 学習コストは中程度
    • 操作はある程度簡単
    • シェルスクリプトで自動化が容易
    • 主にIT担当者が使用
  • API
    • 学習コストが高い
    • 操作にはアプリケーション開発が必要
    • 高度な自動化が可能
    • 主にプラグイン開発者が使用

cli-kintoneを使用すれば、エンジニアでない方でも少しのシェルスクリプトスキルで日常的・定期的なタスクを自動化できます。

cli-kintoneを試してみる​

このセクションでは、cli-kintoneのインストールとアプリケーションからのレコードエクスポートの手順を説明します。

要件​

cli-kintoneを実行するには、APIアクセスが可能なkintoneの契約が必要です。

インストール​

  1. Releasesページに移動します。
  2. 最新のcli-kintone ZIPファイルをダウンロードして展開します。

詳細はインストールページをご覧ください。

動作確認​

--versionオプション付きでcli-kintoneを実行します。

./cli-kintone --version

# バージョンが表示されます
# 1.10.0

ダウンロードしたバージョンが表示されれば、準備完了です！

設定​

cli-kintoneからKintoneにアクセスするには、認証情報を設定する必要があります。 繰り返しを減らすため、環境変数を設定することをお勧めします。

設定する環境変数は以下の通りです。

キー説明
KINTONE_BASE_URLアクセスしたいKintoneのベースURL。
例：https://example.cybozu.com
KINTONE_API_TOKENアクセスしたいアプリのAPIトークン
ヒント

または、KINTONE_USERNAMEとKINTONE_PASSWORDを設定してパスワード認証を使用することもできます。

export KINTONE_BASE_URL='https://example.cybozu.com'
export KINTONE_API_TOKEN='YourAPIToken'

レコードのエクスポート​

それでは始めましょう。record exportコマンドを使用してKintoneアプリからレコードを取得します。

./cli-kintone --app 123

# エクスポートされたレコードがCSV形式で表示されます

次のステップ​

すべての機能を確認するには、コマンドセクションをご覧ください。