Tips

cli-kintone（v1.x.x）と旧バージョン（v.0.x.x）との差異

目次

v1.0.0以降のcli-kintoneでは、 レコードデータの追加や更新を同時に行う機能の強化 や、セキュアアクセス対応などを実施しています。
バージョンがv1.0.0より前（v0.x.x）のcli-kintone との主要な差異については、後述の表を参照してください。

バージョンの確認方法

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

cli-kintoneのバージョンを確認するには、次のコマンドを実行します。

1
2
3
4
5

# Windowsの例
cli-kintone.exe --version

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

コマンドを実行して次のエラーが出た場合には、v0.10.0以前のcli-kintoneを使用しています。

1

> segmentation fault cli-kintone.exe --version

エクスポートの主要な差異

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

2022年10月24日時点でのエクスポートにおける主要な差異は、次のとおりです。

出力内容の形式

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

旧バージョン（v0.x.x）
-oオプションに、フォーマットを指定する。
指定できる値は次のとおり。
  • csv：CSV形式
  • json：JSON形式
v1.x.x以降
CSVファイルのみ出力できる。

kintone環境の指定方法

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

旧バージョン（v0.x.x）
-dオプションに、kintoneのサブドメインまたはFQDNを指定する。
v1.x.x以降
--base-urlオプションに、kintoneのベースURL（「https://」始まり）を指定する。

アプリの指定方法

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

旧バージョン（v0.x.x）
-aオプションに、kintoneのアプリIDを指定する。
v1.x.x以降
--appオプションにkintoneのアプリIDを指定する。

パスワード認証

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

旧バージョン（v0.x.x）
次のオプションに、ログイン情報を指定する。
  • -u：kintoneのログイン名
  • -p：kintoneのパスワード
v1.x.x以降
次のオプションに、ログイン情報を指定する。
  • --username：kintoneのログイン名
  • --password：kintoneのパスワード

APIトークン認証

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

旧バージョン（v0.x.x）
-tオプションに、APIトークンを指定する。
v1.x.x以降
--api-tokenオプションに、APIトークンを指定する。

Basic認証

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

旧バージョン（v0.x.x）
次のオプションに、Basic認証のユーザー名とパスワードを指定する。
  • -U：Basic認証のユーザー名
  • -P：Basic認証のパスワード
v1.x.x以降
次のオプションに、Basic認証の情報を指定する。
  • --basic-auth-username：Basic認証のユーザー名
  • --basic-auth-password：Basic認証のパスワード

セキュアアクセス

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

旧バージョン（v0.x.x）
なし
v1.x.x以降
次のオプションに、クライアント証明書の情報を指定する。
  • --pfx-file-path：クライアント証明書ファイルのパス
  • --pfx-file-password：クライアント証明書ファイルのパスワード

プロキシ経由でのエクスポートの実行

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

旧バージョン（v0.x.x）
なし
v1.x.x以降
--proxyオプションに、プロキシサーバーのURLを指定する。

ゲストスペース内アプリの操作

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

旧バージョン（v0.x.x）
-gオプションに、ゲストスペースIDを指定する。
v1.x.x以降
--guest-space-idオプションに、ゲストスペースIDを指定する。

添付ファイルを含むレコードデータのエクスポート

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

旧バージョン（v0.x.x）
-bオプションに、添付ファイルを出力するディレクトリのパスを指定する。
v1.x.x以降
--attachments-dirオプションに、添付ファイルを出力するディレクトリのパスを指定する。

エクスポート対象のフィールドの指定

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

旧バージョン（v0.x.x）
-cオプションに、エクスポート対象のフィールドのフィールドコードを指定する。
同じフィールドコードを複数回指定した場合は、指定した数の列が出力される。
v1.x.x以降
--fieldsオプションに、エクスポート対象のフィールドのフィールドコードを指定する。
同じフィールドコードを複数回指定した場合は、1列だけ出力される。

エクスポート対象の絞り込み方法

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

旧バージョン（v0.x.x）
-qオプションに、レコードの絞り込み条件および並び順を指定する。
v1.x.x以降
次のオプションに、レコードの絞り込み条件と並び順を指定する。
  • --condition：レコードの絞り込み条件
  • --order-by：レコードの並び順

エクスポートするデータの⽂字コード

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

旧バージョン（v0.x.x）
-eオプションに、文字コードを指定する。
指定できる値は次のとおり。
  • utf8：UTF-8
  • utf-16：UTF-16
  • utf-16be-with-signature：UTF-16BE
  • utf-16le-with-signature：UTF-16LE
  • sjis：Shift-JIS
  • euc-jp：EUC-JP
  • gbk：GBK（簡体字）
v1.x.x以降
--encodingオプションに、文字コードを指定する。
指定できる値は次のとおり。
  • utf8：UTF-8
  • sjis：Shift-JIS

インポートの主要な差異

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

2023年2月22日時点でのインポートにおける主要な差異は、次のとおりです。

インポートするファイルの指定

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

旧バージョン（v0.x.x）
-fオプションに、CSVファイルのファイルパスを指定する。
v1.x.x以降
--file-pathオプションに、CSVファイルのファイルパスを指定する。

kintone環境の指定方法

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

旧バージョン（v0.x.x）
-dオプションに、kintoneのサブドメインまたはFQDNを指定する。
v1.x.x以降
--base-urlオプションに、kintoneのベースURL（「https://」始まり）を指定する。

アプリの指定方法

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

旧バージョン（v0.x.x）
-aオプションに、kintoneのアプリIDを指定する。
v1.x.x以降
--appオプションにkintoneのアプリIDを指定する。

パスワード認証

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

旧バージョン（v0.x.x）
次のオプションに、ログイン情報を指定する。
  • -u：kintoneのログイン名
  • -p：kintoneのパスワード
v1.x.x以降
次のオプションに、ログイン情報を指定する。
  • --username：kintoneのログイン名
  • --password：kintoneのパスワード

APIトークン認証

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

旧バージョン（v0.x.x）
-tオプションに、APIトークンを指定する。
v1.x.x以降
--api-tokenオプションに、APIトークンを指定する。

Basic認証

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

旧バージョン（v0.x.x）
次のオプションに、Basic認証のユーザー名とパスワードを指定する。
  • -U：Basic認証のユーザー名
  • -P：Basic認証のパスワード
v1.x.x以降
次のオプションに、Basic認証の情報を指定する。
  • --basic-auth-username：Basic認証のユーザー名
  • --basic-auth-password：Basic認証のパスワード

セキュアアクセス

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

旧バージョン（v0.x.x）
なし
v1.x.x以降
次のオプションに、クライアント証明書の情報を指定する。
  • --pfx-file-path：クライアント証明書ファイルのパス
  • --pfx-file-password：クライアント証明書ファイルのパスワード

プロキシ経由でのエクスポートの実行

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

旧バージョン（v0.x.x）
なし
v1.x.x以降
--proxyオプションに、プロキシサーバーのURLを指定する。

ゲストスペース内アプリの操作

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

旧バージョン（v0.x.x）
-gオプションに、ゲストスペースIDを指定する。
v1.x.x以降
--guest-space-idオプションに、ゲストスペースIDを指定する。

レコードデータの一括登録

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

旧バージョン（v0.x.x）
$id列を含まないCSVファイルをインポートする。
v1.x.x以降
--update-keyを指定せずにCSVファイルをインポートする。

レコードデータの一括更新

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

旧バージョン（v0.x.x）
レコードの⼀括更新のキーとなる列を含むCSVファイルをインポートする。
レコードの⼀括更新のキーの列には、次のいずれかを指定できる。
  • $id列
  • *を先頭につけたフィールドコード名の列
レコードの⼀括更新のキーとなる列の値に応じて、レコードが追加または更新される。
そのため、目的の操作に応じて次の値を記載する。
  • 新規レコードを追加する場合：空文字
  • 既存レコードを更新する場合：既存レコードと一致する値
v1.x.x以降
--update-keyオプションに、レコードの⼀括更新のキーとなるフィールドのフィールドコードを指定してCSVファイルをインポートする。
--update-keyオプションには、次のフィールドを指定できる。
  • レコード番号
  • 「値の重複を禁⽌する」を有効にした以下のフィールド
    • 文字列1行
    • 数値
--update-keyオプションで指定した列の値に応じて、レコードが追加または更新される。
そのため、目的の操作に応じて次の値を記載する。
  • 新規レコードを追加する場合：既存レコードとは一致しない値、または空文字
  • 既存レコードを更新する場合：既存レコードと一致する値

レコードデータを削除後に一括登録

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

旧バージョン（v0.x.x）
-Dオプションを指定する。
このオプションを指定すると、レコードデータを削除後にインポートが実行される。
削除するレコードを絞り込む場合は、-qオプションに、レコードの絞り込み条件を指定する。
v1.x.x以降
deleteコマンド を実行してレコードを削除した後、 importコマンド でデータをインポートする。
削除するレコードを指定する場合は、--file-pathオプションで削除対象のレコード番号を記載したCSVファイルを指定する。
--file-pathオプションを省略した場合は、すべてのレコードが削除される。

添付ファイルを含むレコードデータのインポート

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

旧バージョン（v0.x.x）
-bオプションに、添付ファイルを配置したディレクトリのパスを指定する。
v1.x.x以降
--attachments-dirオプションに、添付ファイルを配置したディレクトリのパスを指定する。

インポート対象のフィールドの指定

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

旧バージョン（v0.x.x）
なし
v1.x.x以降
--fieldsオプションに、インポート対象のフィールドのフィールドコードを指定する。

インポート開始行の指定

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

旧バージョン（v0.x.x）
-lオプションに、インポートの開始行を指定する。
v1.x.x以降
なし

インポートするデータの⽂字コード

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

旧バージョン（v0.x.x）
-eオプションに、文字コードを指定する。
指定できる値は次のとおり。
  • utf8：UTF-8
  • utf-16：UTF-16
  • utf-16be-with-signature：UTF-16BE
  • utf-16le-with-signature：UTF-16LE
  • sjis：Shift-JIS
  • euc-jp：EUC-JP
  • gbk：GBK（簡体字）
v1.x.x以降
--encodingオプションに、文字コードを指定する。
指定できる値は次のとおり。
  • utf8：UTF-8
  • sjis：Shift-JIS