kintone コマンドラインツール(cli-kintone)

目次

cli-kintone とは

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

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

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

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

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

サポート方針

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

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

GitHub

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

ライセンス

MIT License (External link)

ドキュメント

https://github.com/kintone/cli-kintone/blob/main/README.md (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 オプションにクエリを指定します。
クエリ記法は、 クエリの書き方 を参照してください。

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
テーブルのデータを表示する

標準機能のファイル書き出し (External link) と同じように、テーブルのデータは、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 つのフィールドに複数のファイルを指定する場合には、改行区切りで指定します。

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
テーブルのあるレコードを追加または更新する

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

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

warning
注意

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

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

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 レコードの絞り込み条件のクエリを指定します。
クエリ記法は、 クエリの書き方 を参照してください。
--order-by レコードの並び順のクエリを指定します。
クエリ記法は、 クエリの書き方 を参照してください。
--fields 特定のフィールドだけをエクスポートする場合は、エクスポートするフィールドのフィールドコードを ,(半角カンマ)区切りで指定します。
たとえば「JoinDate」「Division」の項目だけをエクスポートしたい場合は --fields "JoinDate,Division" を指定します。
テーブル内のフィールドは指定できません。
テーブルを出力する場合はテーブルフィールドのフィールドコードを指定します。テーブル内のフィールドがすべて出力されます。
--basic-auth-username Basic 認証 (External link) を設定している場合、Basic 認証のユーザー名を指定します。
--basic-auth-password Basic 認証 (External link) を設定している場合の Basic 認証のパスワードを指定します。
--guest-space-id ゲストスペース内のアプリを操作する場合、ゲストスペース ID を指定します。
--encoding エクスポートするデータの文字コードです。初期値は「utf8」です。
  • utf8:UTF-8
  • sjis:Shift-JIS
--pfx-file-path セキュアアクセス (External link) を設定している場合は、クライアント証明書ファイルのパスを指定します。
--pfx-file-password セキュアアクセス (External link) を設定している場合は、クライアント証明書ファイルのパスワードを指定します。
--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 認証 (External link) を設定している場合、Basic 認証のユーザー名を指定します。
--basic-auth-password Basic 認証 (External link) を設定している場合の Basic 認証のパスワードを指定します。
--guest-space-id ゲストスペース内のアプリを操作する場合、ゲストスペース ID を指定します。
--encoding インポートするファイルの文字コードです。初期値は「utf8」です。
  • utf8:UTF-8
  • sjis:Shift-JIS
--pfx-file-path セキュアアクセス (External link) を設定している場合は、クライアント証明書ファイルのパスを指定します。
--pfx-file-password セキュアアクセス (External link) を設定している場合は、クライアント証明書ファイルのパスワードを指定します。
--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 認証 (External link) を設定している場合、Basic 認証のユーザー名を指定します。
--basic-auth-password Basic 認証 (External link) を設定している場合の Basic 認証のパスワードを指定します。
--guest-space-id ゲストスペース内のアプリを操作する場合、ゲストスペース ID を指定します。
--encoding 削除するデータの文字コードです。初期値は「utf8」です。
  • utf8:UTF-8
  • sjis:Shift-JIS
--pfx-file-path セキュアアクセス (External link) を設定している場合は、クライアント証明書ファイルのパスを指定します。
--pfx-file-password セキュアアクセス (External link) を設定している場合は、クライアント証明書ファイルのパスワードを指定します。
--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)との機能差異

information

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

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

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