Differences between cli-kintone v1.x.x and v0.x.x

Contents

Overview

cli-kintone v1.0.0 or later has enhanced features such as bulk record updating and Client Certificate Authentication support.

For more details on the main differences between v1.x.x and v0.x.x, refer to the table below.

How to Install cli-kintone v1.x.x

Refer to the Installation section of the cli-kintone (External link) GitHub repository for details on how to install cli-kintone v1.x.x.

How to Check cli-kintone version

Run the following command in the terminal to check which cli-kintone version is being used:

1
2
3
4
5

# Windows
cli-kintone.exe --version

# macOS and Linux
cli-kintone --version

If v1.0.0 is used, the following will be displayed:

1
2

# version number
1.0.0

If versions before v0.10.x is used, the following error will be displayed:

1
2
3
4
5

# Windows
> segmentation fault cli-kintone.exe --version

# macOS and Linux
> segmentation fault cli-kintone --version

Differences Between cli-kintone v1.x.x and v0.x.x

Export Features

As of October 24, 2022, the main differences in export features are as follows:

v0.x.x v1.x.x
Export format -o: The export format
Values:
  • json: JSON file
  • csv: CSV file
 -o: The export format
Values:
  • csv: CSV file
Specify Kintone environment -d: The Kintone subdomain --base-url: The Kintone base URL (Starting with "https://")
Specify App -a: The App ID --app: The App ID
Password authentication -u: The Kintone username
-p: The Kintone password		 --username: The Kintone username
--password: The Kintone password
API token authentication -t: The API token of the app --api-token: The API token of the app
Basic authentication -U: The basic authentication login name
-P: The basic authentication password		 --basic-auth-username: The basic authentication login name
--basic-auth-password: The basic authentication password
Client Certificate Authentication --pfx-file-path: The client authentication file path
--pfx-file-password: The client authentication file password
Export via proxy --proxy: The proxy server URL
Working with Apps in Guest Spaces -g: The guest space ID --guest-space-id: The guest space ID
Export record data including attachments -b: The directory to download attachment files to --attachments-dir: The directory to download attachment files to
Specify fields to export -c: The field code of the field to export
When specifying the same field code multiple times, the field will also be exported multiple times.		 --fields: The field code of the field to export
When specifying the same field code multiple times, the field will only be exported one time.
Specify condition -q: The filter condition and sort order --condition: The filter condition
--order-by: The sort order
Character encoding of the exported data -e: The encoding format
Values:
  • 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
 -encoding: The encoding format
Values:
  • utf8: UTF-8
  • sjis: Shift-JIS

Import Features

As of February 22, 2023, the main differences in import features are as follows:

v0.x.x v1.x.x
Import path -f: The file path --file-path: The file path
Specify Kintone environment -d: The Kintone subdomain --base-url: The Kintone base URL (Starting with "https://")
Specify App -a: The App ID --app: The App ID
Password authentication -u: The Kintone username
-p: The Kintone password		 --username: The Kintone username
--password: The Kintone password
API token authentication -t: The API token of the app --api-token: The API token of the app
Basic authentication -U: The basic authentication login name
-P: The basic authentication password		 --basic-auth-username: The basic authentication login name
--basic-auth-password: The basic authentication password
Client Certificate Authentication --pfx-file-path: The client authentication file path
--pfx-file-password: The client authentication file password
Import via proxy --proxy: The proxy server URL
Working with Apps in Guest Spaces -g: The guest space ID --guest-space-id: The guest space ID
Create records in bulk Import a CSV file that does not contain $id column Import a CSV file without specifying --update-key
Update records in bulk Import a CSV file that contains key column to update records in bulk.
Specify one of the following as the key column:
  • $id column
  • Column of field code name with * at the beginning
Records will be updated according to the value of the key column.
  • Pass empty string to add new records.
  • Enter a value that matches the existing record to update record.
 --update-key: Field code of the key field to update or add records in bulk.
  • Enter a value that does not match any existing record, or pass empty string to add a new record.
  • Enter a value that matches the existing record to update record.
The types of fields that can be specified in --update-key are as follows:
  • Record number
  • The following fields with "Prohibit duplicate values" enabled
    • String in one line
    • Number
Create records in bulk after deleting record data -D: If this option is specified, cli-kintone will delete all existing records inside the App before importing.
Use the -q option to specify filter conditions for the records to be deleted.		 Run the delete command to delete all records, and then import data using the import command.
By specifying the --file-path option to a CSV with Record numbers, specific records can be deleted before importing. Not specifying the --file-path option will default to deleting all records.
Import record data including attachments -b: The directory to upload files from. --attachments-dir: The directory to upload files from.
Specifying Fields to Import
--fields: The field code of the field to import
Import start line -l: Position index of data in the input file
Character encoding of the imported data -e: The encoding format
Values:
  • 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
 -encoding: The encoding format
Values:
  • utf8: UTF-8
  • sjis: Shift-JIS

Limitations