SDK&Tools

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

目次

cli-kintoneとは

固定リンクがコピーされました

kintoneコマンドラインツール（cli-kintone）は、コマンドでkintoneのレコード情報をCSVファイル（Excelで開くことができるデータ）で入出力できるツールです。
コマンドラインツールとして提供されているため、シェルスクリプトファイルから呼び出して実行できます。

レコード情報の入出力だけでなく、kintoneの画面からレコードを一括登録・更新する機能ではできない、次の操作もできます。

  • 一括でレコードの添付ファイルをダウンロードする。
  • 一括で添付ファイルをレコードに添付する。
  • 一括で添付ファイルを削除する。

詳細については、 添付ファイルをダウンロード・アップロード・削除してみよう を参照してください。

information

この記事では、cli-kintoneの基本的な使い方を説明しています。
バージョンがv1.0.0より前のcli-kintoneの使い方は、次のページを参照してください。
kintoneコマンドラインツール（cli-kintone v0）

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

この記事では、cli-kintoneの基本的な使い方を説明しています。
詳しい使い方や活用方法を知りたい場合は、次のチュートリアルを参照してください。
はじめようcli-kintone

サポート方針

固定リンクがコピーされました

cli-kintoneは、運用環境で利用することを想定して、サイボウズ社が開発、提供しています。
バージョンがv1.0.0以降のcli-kintoneの仕様の確認やトラブルに関する質問は、APIサポート窓口に問い合わせ可能です。
問い合わせ方法は、次のページを確認してください。
サポートへのお問い合わせ方法 (External link)

ソースコードの変更、再配布および商用利用等は、ライセンスにしたがって利用できます。
ライセンスの種別は各クライアントライブラリのページまたはGitHubのリポジトリで確認してください。
ただし、ソースコードを変更していることに起因して発生したトラブルは、サポート対象外です。

GitHub

固定リンクがコピーされました

https://github.com/kintone/cli-kintone (External link)

ライセンス

固定リンクがコピーされました

MIT License (External link)

ドキュメント

固定リンクがコピーされました

cli-kintone(英語) (External link)

注意事項

固定リンクがコピーされました

  • cli-kintoneを使ってレコードを入出力するには、スタンダードプランの契約が必要です。
  • 大量のレコードデータを操作すると、kintoneに負荷がかかり、パフォーマンスに影響することがあります。

導入方法

固定リンクがコピーされました

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. ファイルを解凍し、実行ファイルを任意のディレクトリに置きます。

Windowsユーザー向け：コマンドプロンプトを起動する

固定リンクがコピーされました

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

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

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

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

    1
2

    # デスクトップの「works」ディレクトリの下にcli-kintone.exeをおいた場合
cd Desktop\works

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

固定リンクがコピーされました

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

1
2
3
4

cli-kintone.exe --version

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

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

使い方

固定リンクがコピーされました

データをエクスポートする

固定リンクがコピーされました

レコードの情報を表示するには、record exportを指定します。
また、次のオプションに、操作するkintoneのドメイン名とアプリIDを指定します。

  • --base-url：操作するkintoneのドメイン名（例：https://sample.cybozu.com）
  • --app：アプリID（例：123）
APIトークンでレコードの情報を表示する

APIトークンを使ってレコードの情報を表示するには、--api-tokenオプションにAPIトークンを指定します。

1
2

cli-kintone.exe record export --base-url https://サブドメイン.cybozu.com --app アプリID ^
  --api-token APIトークン
  • --api-token：APIトークン（例：BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL）
    レコードの内容を表示するには、APIトークンに「レコード閲覧」のアクセス権が必要です。
    APIトークンの発行方法は、次のページを参照してください。
    APIトークンを生成する (External link)

コマンドを実行すると、CSV形式でアプリのレコード情報が表示されます。
項目の見出し名はフィールドコードの値です。

実行例

1
2
3
4
5
6
7

cli-kintone.exe record export --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL

# 出力結果
"レコード番号","EmployeeId","Name","JoinDate","Division","作成者","作成日時","更新者","更新日時"
"2","0002","鈴木 知香","2021-01-01","総務部","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"
"1","0001","山田 幸広","2020-01-01","総務部","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"
CSVファイルにエクスポートする

シェルのリダイレクト機能（>）を使うと、結果をファイルに出力できます。

実行例

1
2
3

# 「records.csv」というファイルに結果を出力する例
cli-kintone.exe record export --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL > records.csv
絞り込み条件やデータの並び順を指定する

--conditionオプションや--order-byオプションにクエリを指定します。
クエリ記法は、次のページを参照してください。
cli-kintoneでのクエリの書き方 

1
2
3

cli-kintone.exe record export --base-url https://サブドメイン.cybozu.com --app アプリID ^
  --api-token APIトークン ^
  --condition "絞り込みのクエリ" --order-by "並び替えのクエリ"
  • --conditionオプション：絞り込み条件のクエリ
  • --order-byオプション：データの並び順のクエリ

実行例

1
2
3
4
5
6
7
8
9

# 入社日（JoinDate）が2014年1月1日以降のデータを入社日（JoinDate）の昇順で表示する
cli-kintone.exe record export --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --condition "JoinDate >= \"2014-01-01\"" --order-by "JoinDate asc"

# 出力結果
"レコード番号","EmployeeId","Name","JoinDate","Division","作成者","作成日時","更新者","更新日時"
"1","0001","山田 幸広","2020-01-01","総務部","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"
"2","0002","鈴木 知香","2021-01-01","総務部","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"
添付ファイルをダウンロードする

レコードに添付されたファイルをダウンロードするには、--attachments-dirオプションに、ダウンロード先のディレクトリ名を指定します。
ディレクトリ名は、実行している場所からの相対パスまたは絶対パスです。

1
2
3

cli-kintone.exe record export --base-url https://サブドメイン.cybozu.com --app アプリID ^
  --api-token APIトークン ^
  --attachments-dir 添付ファイルを出力するディレクトリ
  • --attachments-dir：添付ファイルのダウンロード先のディレクトリ

実行例

1
2
3
4
5
6
7
8
9

# 「attachments」以下にレコードに添付されたファイルを出力する
cli-kintone.exe record export --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --attachments-dir ./attachments

# 出力結果
"レコード番号","EmployeeId","Name","JoinDate","Division","Photo","作成者","作成日時","更新者","更新日時"
"2","0002","鈴木 知香","2021-01-01","総務部","suzuki-chika.png","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"
"1","0001","山田 幸広","2020-01-01","総務部","yamada-hiroyuki.png","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"

実行すると、指定したディレクトリ内に作成される次のディレクトリへ、添付ファイルがダウンロードされます。
作成されるディレクトリ：フィールドコード-レコード番号

1
2
3
4
5
6

works # cli-kintone.exeがあるディレクトリ
└─── attachments
    ├── Photo-1
    │    └── yamada-hiroyuki.png
    └── Photo-2
          └── suzuki-chika.png
テーブルのデータを表示する

標準機能のファイル書き出しと同じように、テーブルのデータは、1レコードの内容が複数行に分かれて表示されます。
ファイルの先頭列の「*」から次の「*」の前までの行が、1つのレコードのデータです。

実行例

1
2
3
4
5
6
7
8

cli-kintone.exe record export --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL

# 出力結果
*,"レコード番号","EmployeeId","Name","JoinDate","Division","AssignInformation","AssignDate","AssignDivision","作成者","作成日時","更新者","更新日時"
*,"2","0001","鈴木 知香","2021-01-01","総務部","3705","2021-01-01","総務部","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"
*,"1","0001","山田 幸広","2020-01-01","総務部","3703","2020-01-01","営業部","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"
,"1","0001","山田 幸広","2020-01-01","総務部","3702","2021-01-01","総務部","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"

データをインポートする

固定リンクがコピーされました

レコードを追加または更新するには、record importを指定します。
また、次のオプションに、操作するkintoneのドメイン名とアプリIDを指定します。

  • --base-url：操作するkintoneのドメイン名（例：https://sample.cybozu.com）
  • --app：アプリID（例：123）
レコードを追加する

APIトークンを使ってレコードを追加するには、--api-tokenオプションにAPIトークンを指定します。
また取り込むファイルは、--file-pathに指定します。

1
2
3

cli-kintone.exe record import --base-url https://サブドメイン.cybozu.com --app アプリID ^
  --api-token APIトークン ^
  --file-path ファイルパス
  • --api-token：APIトークン（例：BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL）
    レコードを追加するには、APIトークンに「レコード追加」、編集するには「レコード閲覧」「レコード編集」のアクセス権が必要です。
    APIトークンの発行方法は、次のページを参照してください。
    APIトークンを生成する (External link)
  • --file-path：追加するレコードの情報を記載したCSVファイルのパス

CSVファイルの1行目は、見出し行です。
項目名には、列に対応するフィールドのフィールドコードを指定します。

CSVファイルの例

1
2
3

"EmployeeId","Name","JoinDate","Division"
"0004","加藤 義男","2020-04-01","企画部"
"0003","山本 慎吾","2020-04-01","人事部"

コマンドを実行すると、追加されたレコードの件数が表示されます。

実行例

1
2
3
4
5
6

cli-kintone.exe record import --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --file-path ./example.csv

[2023-02-01T06:12:06.505Z] INFO: Starting to import records...
[2023-02-01T06:12:07.751Z] INFO: Imported 2 records successfully
一括更新のキーを指定してレコードを追加または更新する

--update-keyオプションに、一括更新のキーとなるフィールドのフィールドコードを指定します。
一括更新のキーに指定できるフィールドは次のとおりです。

  • レコード番号
  • 「値の重複を禁止する」を有効にした、次のフィールド
    • 文字列（1行）
    • 数値
1
2
3
4

cli-kintone.exe record import --base-url https://サブドメイン.cybozu.com --app アプリID ^
  --api-token APIトークン ^
  --file-path ファイルパス ^
  --update-key 一括更新のキーとなるフィールドのフィールドコード

--update-keyに指定したフィールドと、対応付けられたCSVファイルの列の値が一致するレコードは、上書きされます。
一致しない場合には、新規にレコードが追加されます。

  • --update-key：一括更新のキーとなるフィールドのフィールドコード

コマンドを実行すると、追加／更新されたレコードの件数が表示されます。

実行例

1
2
3
4
5
6
7
8

cli-kintone.exe record import --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --file-path ./example.csv ^
  --update-key "EmployeeId"

[2023-02-01T06:12:05.920Z] INFO: Preparing to import records...
[2023-02-01T06:12:06.505Z] INFO: Starting to import records...
[2023-02-01T06:12:07.751Z] INFO: Imported 2 records successfully
添付ファイルをアップロードする
ファイルを添付する

添付ファイルをアップロードしてレコードに添付するには、--attachments-dirオプションにアップロードするファイルを配置したディレクトリを指定します。
ディレクトリ名は、実行している場所からの相対パスまたは絶対パスです。

CSVの添付ファイルフィールドの値には、添付するファイルのパスを指定します。
パスは、--attachments-dirに指定した場所からの相対パスを指定してください。
1つのフィールドに複数のファイルを指定する場合には、改行区切りで指定します。
1ファイルの最大容量は1GBです。

CSVの例

1
2
3
4

"EmployeeId","Name","JoinDate","Division","Photo"
"0006","前田 友美","2021-04-01","人事部","maeda-tomomi.png"
"0005","中村 匠","2015-04-01","総務部","nakamura-takumi.png
nakamura-takumi-nekochan.png"

ディレクトリ構成の例

1
2
3
4
5

works # cli-kintone.exeがあるディレクトリ
└── attachments
  ├── maeda-tomomi.png
  ├── nakamura-takumi.png
  └── nakamura-takumi-nekochan.png

コマンドを実行すると、追加／更新されたレコードの件数が表示されます。

実行例

1
2
3
4
5
6
7

cli-kintone.exe record import --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --file-path ./example.csv ^
  --attachments-dir ./attachments

[2023-02-01T06:19:00.671Z] INFO: Starting to import records...
[2023-02-01T06:19:01.475Z] INFO: Imported 2 records successfully
添付済みのファイルを削除する

すでにファイルが添付されているフィールドの添付ファイルを削除する場合には、添付ファイルフィールドの値を空にします。

CSVの例

1
2

"EmployeeId","Name","JoinDate","Division","Photo"
"0005","前田 友美","2021-04-01","人事部",""

実行例

1
2
3
4
5
6
7
8
9

cli-kintone.exe record import --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --file-path ./example.csv ^
  --update-key "EmployeeId" ^
  --attachments-dir ./attachments

[2023-02-10T06:23:43.147Z] INFO: Preparing to import records...
[2023-02-10T06:23:43.498Z] INFO: Starting to import records...
[2023-02-10T06:23:44.243Z] INFO: Imported 1 records successfully
テーブルのあるレコードを追加または更新する

標準機能のファイル書き出しと同じように、テーブルのデータごとに、1レコードの内容を複数行に分けて記載します。
ファイルの先頭列の「*」から次の「*」の前までの行が、1つのレコードのデータを表します。

ファイルの先頭列は、「*」という項目名にします。
各レコードのデータの開始行の先頭列には「*」を記載し、それ以外は空にします。

warning
注意

既存のレコードのテーブルを更新する場合の注意点

  • データを変更しないテーブルの行があっても、CSVファイルにはすべての行データを記載してください。
    ファイルに記載していない行データは削除されます。
  • データを更新しないテーブルのフィールドがあるときは、次のどちらかを行ってください。
    行わない場合、ファイルに記載されていないテーブルのフィールドの値は空になります。
    • 行のIDを記載する。
      行のIDは、record exportを使ってテーブルのデータを表示したときのテーブルフィールドの値で確認できます。
    • テーブルに含まれるすべてのフィールドのデータを記載する。

CSVの例

1
2
3
4

"*","EmployeeId","Name","JoinDate","Division","AssignInformation","AssignDate","AssignDivision"
"*","0007","小川 里沙","2021-04-01","営業部","3705","2021-04-01","営業部"
"*","0008","栗田 健一","2020-04-01","企画部","3703","2020-04-01","企画部"
"","0008","栗田 健一","2020-04-01","企画部","3702","2021-04-01","人事部"

実行例

1
2
3
4
5
6

cli-kintone.exe record import --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --file-path ./example.csv

[2023-02-10T06:23:43.498Z] INFO: Starting to import records...
[2023-02-10T06:23:44.243Z] INFO: Imported 2 records successfully

データを削除する

固定リンクがコピーされました

caution
警告

record deleteで削除したレコードは元に戻せません。

レコードを削除するには、record deleteを指定します。
record deleteを使ったレコードの削除は、APIトークン認証のみ対応しています。
次のオプションに、操作するkintoneのドメイン名とアプリID、APIトークンを指定します。

  • --base-url：操作するkintoneのドメイン名（例：https://sample.cybozu.com）
  • --app：アプリID（例：123）
  • --api-token：APIトークン（例：BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL）
    レコードを削除するには、APIトークンに「レコード削除」のアクセス権が必要です。
    APIトークンの発行方法は、次のページを参照してください。
    APIトークンを生成する (External link)
すべてのレコードを削除する

すべてのレコードを削除するには、--file-pathをつけずに削除コマンドを実行します。

1
2

cli-kintone.exe record delete --base-url https://サブドメイン.cybozu.com --app アプリID ^
  --api-token APIトークン

実行例

1
2
3
4
5
6

cli-kintone.exe record delete --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL

? Are you sure want to delete records? Yes
[2023-02-27T07:20:29.148Z] INFO: Starting to delete all records...
[2023-02-27T07:20:29.632Z] INFO: 50 records are deleted successfully
一部のレコードを削除する

一部のレコードを削除する場合、削除するレコード番号を記載したCSVファイルを用意し、--file-pathで指定します。

  • --file-path：削除するレコード番号を記載したCSVファイルのパス
1
2
3

cli-kintone.exe record delete --base-url https://サブドメイン.cybozu.com --app アプリID ^
  --api-token APIトークン ^
  --file-path ファイルパス

CSVファイルの1行目は、見出し行です。
項目名には、レコード番号フィールドのフィールドコードを指定します。
2行目以降に、削除するレコードのレコード番号、またはアプリコードを含むレコード番号のいずれか一方を指定します。
アプリコードの詳細は、次のページを参考してください。
アプリコード (External link)

CSVの例

1
2
3

"レコード番号"
"sampleApp-1"
"sampleApp-2"

コマンドを実行すると、削除を確認するメッセージが表示されます。
削除する場合は「Y」を入力して、Enterキーを押します。キャンセルする場合は「n」を入力します。
--yesまたは-yオプションをつけてコマンドを実行すると、削除確認のメッセージが表示されずにレコードを削除できます。

実行例

1
2
3
4
5
6

cli-kintone.exe record delete --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --file-path ./example.csv -y

[2023-02-27T06:09:00.243Z] INFO: Starting to delete records...
[2023-02-27T06:09:00.938Z] INFO: 2 records are deleted successfully

オプション一覧

固定リンクがコピーされました

バージョンがv1.0.0より前のcli-kintoneのオプション一覧は、次のページを参照してください。
cli-kintone v0 | オプション一覧

エクスポート

固定リンクがコピーされました

record exportに続けて--helpオプションを指定して実行すると、エクスポートに関するオプションの一覧が表示されます。

オプション名 説明
--version バージョンを表示します。
--help ヘルプを表示します。
--base-url 必須
操作するkintoneのドメイン名です（例：https://sample.cybozu.com）
「https://」始まりで指定します。
--app 必須
操作するkintoneのアプリIDです。
--api-token 条件必須
APIトークンです。
APIトークンか、ログイン名とパスワードの組み合わせのどちらかが必須です。
複数のAPIトークンを指定する場合には、,（半角カンマ）でAPIトークンを区切ります。
例：--api-token "BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL,WjfkaoKncXlXFqIY0lLwfv8FZELUkv8YnZRnV104"
--username 条件必須
kintoneのログイン名です。
APIトークンか、ログイン名とパスワードの組み合わせのどちらかが必須です。
-uのエイリアスも利用できます。
--password 条件必須
kintoneのパスワードです。
APIトークンか、ログイン名とパスワードの組み合わせのどちらかが必須です。
-pのエイリアスも利用できます。
--attachments-dir 添付ファイルフィールドのファイルをダウンロードする場合、添付ファイルを出力するディレクトリのパスを指定します。
--condition レコードの絞り込み条件のクエリを指定します。
クエリ記法は、次のページを参照してください。
cli-kintoneでのクエリの書き方｜絞り込み条件
--order-by レコードの並び順のクエリを指定します。
クエリ記法は、次のページを参照してください。
cli-kintoneでのクエリの書き方｜並び順
--fields 特定のフィールドだけをエクスポートする場合は、エクスポートするフィールドのフィールドコードを,（半角カンマ）区切りで指定します。
たとえば「JoinDate」「Division」の項目だけをエクスポートしたい場合は--fields "JoinDate,Division"を指定します。
テーブル内のフィールドは指定できません。
テーブルを出力する場合はテーブルフィールドのフィールドコードを指定します。テーブル内のフィールドがすべて出力されます。
--basic-auth-username Basic認証を設定している場合、Basic認証のユーザー名を指定します。
Basic認証の詳細は、次のページを参照してください。
Basic認証 (External link)
--basic-auth-password Basic認証を設定している場合のBasic認証のパスワードを指定します。
--guest-space-id ゲストスペース内のアプリを操作する場合、ゲストスペースIDを指定します。
--encoding エクスポートするデータの文字コードです。初期値は「utf8」です。
  • utf8：UTF-8
  • sjis：Shift-JIS
--pfx-file-path セキュアアクセスを設定している場合は、クライアント証明書ファイルのパスを指定します。
セキュアアクセスの詳細は、次のページを参照してください。
セキュアアクセス (External link)
--pfx-file-password セキュアアクセスを設定している場合は、クライアント証明書ファイルのパスワードを指定します。
--proxy プロキシサーバー経由で実行する場合は、プロキシサーバーのアドレスとポート番号を指定します。
「http://」または「https://」始まりで指定します。
プロキシサーバーでユーザー認証が必要な場合、プロキシサーバーのアドレスの前に「ユーザー名:パスワード@」の形式で認証情報を指定します。
例：--proxy http://ユーザー名:パスワード@プロキシサーバーのアドレス:ポート番号

インポート

固定リンクがコピーされました

record importに続けて--helpオプションを指定して実行すると、インポートに関するオプションの一覧が表示されます。

オプション名 説明
--version バージョンを表示します。
--help ヘルプを表示します。
--base-url 必須
操作するkintoneのドメイン名です（例：https://sample.cybozu.com）
「https://」始まりで指定します。
--app 必須
操作するkintoneのアプリIDです。
--api-token 条件必須
APIトークンです。
APIトークンか、ログイン名とパスワードの組み合わせのどちらかが必須です。
複数のAPIトークンを指定する場合には、,（半角カンマ）でAPIトークンを区切ります。
例：--api-token "BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL,WjfkaoKncXlXFqIY0lLwfv8FZELUkv8YnZRnV104"
--username 条件必須
kintoneのログイン名です。
APIトークンか、ログイン名とパスワードの組み合わせのどちらかが必須です。
-uでも指定できます。
--password 条件必須
kintoneのパスワードです。
APIトークンか、ログイン名とパスワードの組み合わせのどちらかが必須です。
-pでも指定できます。
--update-key レコードの一括更新のキーとなる、フィールドのフィールドコードです。
次のフィールドを指定できます。
  • レコード番号
  • 「値の重複を禁止する」を有効にした、次のフィールド
    • 文字列（1行）
    • 数値
--file-path 必須
インポートするファイルのパスです。
拡張子が.csvのファイルのみ対応しています。
--attachments-dir 添付ファイルフィールドにファイルを添付する場合、添付ファイルを配置したディレクトリのパスを指定します。
--fields ファイルの項目を限定してインポートする場合に、対象の項目に対応するフィールドのフィールドコードを,（半角カンマ）区切りで指定します。
たとえば、ファイル内の「JoinDate」「Division」の項目だけをインポートしたい場合は--fields "JoinDate,Division"を指定します。
--basic-auth-username Basic認証を設定している場合、Basic認証のユーザー名を指定します。
Basic認証の詳細は、次のページを参照してください。
Basic認証 (External link)
--basic-auth-password Basic認証を設定している場合のBasic認証のパスワードを指定します。
--guest-space-id ゲストスペース内のアプリを操作する場合、ゲストスペースIDを指定します。
--encoding インポートするファイルの文字コードです。初期値は「utf8」です。
  • utf8：UTF-8
  • sjis：Shift-JIS
--pfx-file-path セキュアアクセスを設定している場合は、クライアント証明書ファイルのパスを指定します。
セキュアアクセスの詳細は、次のページを参照してください。
セキュアアクセス (External link)
--pfx-file-password セキュアアクセスを設定している場合は、クライアント証明書ファイルのパスワードを指定します。
--proxy プロキシサーバー経由で実行する場合は、プロキシサーバーのアドレスとポート番号を指定します。
「http://」または「https://」始まりで指定します。
プロキシサーバーでユーザー認証が必要な場合、プロキシサーバーのアドレスの前に「ユーザー名:パスワード@」の形式で認証情報を指定します。
例：--proxy http://ユーザー名:パスワード@プロキシサーバーのアドレス:ポート番号

レコード削除

固定リンクがコピーされました

record deleteに続けて--helpオプションを指定して実行すると、削除に関するオプションの一覧が表示されます。

オプション名 説明
--version バージョンを表示します。
--help ヘルプを表示します。
--base-url 必須
操作するkintoneのドメイン名です（例：https://sample.cybozu.com）
「https://」始まりで指定します。
--app 必須
操作するkintoneのアプリIDです。
--api-token 必須
APIトークンです。
--file-path 削除するレコードの情報を記載したファイルのパスです。
拡張子が.csvのファイルのみ対応しています。
--yes 削除を確認するメッセージを表示せずにレコードを削除します。
-yのエイリアスも利用できます。
--basic-auth-username Basic認証を設定している場合、Basic認証のユーザー名を指定します。
Basic認証の詳細は、次のページを参照してください。
Basic認証 (External link)
--basic-auth-password Basic認証を設定している場合のBasic認証のパスワードを指定します。
--guest-space-id ゲストスペース内のアプリを操作する場合、ゲストスペースIDを指定します。
--encoding 削除するデータの文字コードです。初期値は「utf8」です。
  • utf8：UTF-8
  • sjis：Shift-JIS
--pfx-file-path セキュアアクセスを設定している場合は、クライアント証明書ファイルのパスを指定します。
セキュアアクセスの詳細は、次のページを参照してください。
セキュアアクセス (External link)
--pfx-file-password セキュアアクセスを設定している場合は、クライアント証明書ファイルのパスワードを指定します。
--proxy プロキシサーバー経由で実行する場合は、プロキシサーバーのアドレスとポート番号を指定します。
「http://」または「https://」始まりで指定します。
プロキシサーバーでユーザー認証が必要な場合、プロキシサーバーのアドレスの前に「ユーザー名:パスワード@」の形式で認証情報を指定します。
例：--proxy http://ユーザー名:パスワード@プロキシサーバーのアドレス:ポート番号

制限事項

固定リンクがコピーされました

フィールドに関する制限

固定リンクがコピーされました

  • 次のフィールドは、レコードを追加するときのみ、CSVファイルの内容を反映できます。
    「アプリの管理権限」を付与したAPIトークン、またはユーザーのアカウントを使って実行してください。
    • 作成者
    • 作成日時
    • 更新者
    • 更新日時
  • 次のフィールドはエクスポートできません。
    • ステータス
    • 作業者
    • カテゴリー
    • 関連レコード
  • 次のフィールドにインポートしても値は登録・更新されません。
    • ルックアップ元からコピーされるフィールド
    • 計算
    • 自動計算が設定されている文字列（1行）フィールド
    • ステータス
    • 作業者
    • カテゴリー
    • 関連レコード

その他の制限

固定リンクがコピーされました

  • IPアドレス制限を設定している場合には、次のどちらかの方法で実行してください。

更新履歴

固定リンクがコピーされました

cli-kintoneの最新の更新内容は、次のページを参照してください。
Change Log (External link)

  • 2022年10月1日：記事を公開しました。
  • 2023年3月2日：v1.3.0で追加された削除コマンドについて追記しました。
  • 2023年5月1日：v1.4.0で対応した、プロキシ接続のユーザー認証について追記しました。

旧バージョン（v0）との機能差異について

固定リンクがコピーされました

v1.0.0以降のcli-kintoneでは、次のような対応を実施しています。

バージョンがv1.0.0より前（v0.x.x）のcli-kintoneとの機能差異は、次のページを参照してください。
cli-kintoneの旧バージョン（v0）との機能差異

cli-kintoneへのフィードバック

固定リンクがコピーされました

機能に対する要望や質問は、GitHub Issueでも受け付けています。

information

この記事で紹介しているサンプルコードは、2022年9月版kintoneおよびcli-kintone Version 1.0.0で動作を確認しています。