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