diff --git a/README.md b/README.md index 88cd15f..55baf3d 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ cli-kintone is a command line utility for exporting and importing kintone App da ## Version -0.13.1 +0.14.0 ## Downloads @@ -36,7 +36,7 @@ https://github.com/kintone-labs/cli-kintone/releases -g= Guest Space ID (default: 0) -o= Output format. Specify either 'json' or 'csv' (default: csv) -e= Character encoding (default: utf-8). - Only support the encoding below both field code and data itself: + Only support the encoding below both field code and data itself: 'utf-8', 'utf-16', 'utf-16be-with-signature', 'utf-16le-with-signature', 'sjis' or'euc-jp', 'gbk' or 'big5' -U= Basic authentication user name -P= Basic authentication password @@ -52,7 +52,7 @@ https://github.com/kintone-labs/cli-kintone/releases -h, --help Show this help message ``` ## Examples -Note: +Note: * If you use Windows device, please specify cli-kintone.exe * Please set the PATH to cli-kintone to match your local environment beforehand. @@ -68,11 +68,11 @@ cli-kintone --export -a -d -e sjis -c "$id, name1, name2" -t -d -e sjis -t -f ``` -Records are updated and/or added if the import file contains either an $id column (that represents the Record Number field), or a column representing a key field (denoted with a * symbol before the field code name, such as "\*mykeyfield"). +Records are updated and/or added if the import file contains either an $id column (that represents the Record Number field), or a column representing a key field (denoted with a * symbol before the field code name, such as "\*mykeyfield"). -If the value in the $id (or key field) column matches a record number value, that record will be updated. -If the value in the $id (or key field) column is empty, a new record will be added. -If the value in the $id (or key field) column does not match with any record number values, the import process will stop, and an error will occur. +If the value in the $id (or key field) column matches a record number value, that record will be updated. +If the value in the $id (or key field) column is empty, a new record will be added. +If the value in the $id (or key field) column does not match with any record number values, the import process will stop, and an error will occur. If an $id (or key field) column does not exist in the file, new records will be added, and no records will be updated. ### Export and download attachment files to ./mydownloads directory @@ -109,7 +109,7 @@ cli-kintone --import -a -d -t -b myuploads -f >The error message `The "$id" field and update key fields cannot be specified together in CSV import file.` will be displayed when both "$id" and key fields are specified in CSV import file. -The key to bulk update must be specified within the INPUT_FILE by placing an * in front of the field code name, +The key to bulk update must be specified within the INPUT_FILE by placing an * in front of the field code name, e.g. “update_date",“*id",“status". ``` @@ -127,15 +127,14 @@ printf "name,age\nJohn,37\nJane,29" | cli-kintone --import -a -d ## Restrictions * The limit of each file size for uploading to attachments field is 10MB. * Client certificates cannot be used with cli-kintone. -* The following record data cannot be retrieved: Category, Status, Field group. -* The following fields cannot be retrieved if they are set inside a Field group: Record number, Created by, Created datetime, Updated by, Updated datetime, Blank space, Label, Border. +* The following record data cannot be retrieved: Field group, Blank space, Label, Border, Related records, Status, Assignee, Category ## Restriction of Encode/Decode -* Windows command prompt may not display characters correctly like "譁�蟄怜喧縺�". +* Windows command prompt may not display characters correctly like "譁�蟄怜喧縺�". This is due to compatibility issues between Chinese & Japanese characters and the Windows command prompt. * Chinese (Traditional/Simplified): Display wrong even if exporting with gbk or big5 encoding. * Japanese: Display wrong even if exporting with sjis or euc-jp encoding. - + In this case, display the data by specifying utf-8 encoding like below: ``` cli-kintone --export -a -d -e utf-8 @@ -143,8 +142,8 @@ printf "name,age\nJohn,37\nJane,29" | cli-kintone --import -a -d *This issue only occurs when displaying data on Windows command prompt. Data import/export with other means work fine with gbk, big5, sjis and euc-jp encoding. ## Documents for Basic Usage -English: https://developer.kintone.io/hc/en-us/articles/115002614853 -Japanese: https://developer.cybozu.io/hc/ja/articles/202957070 +- English: https://kintone.dev/en/tutorials/tool-guides/features-of-the-command-line-tool/ +- Japanese: https://developer.cybozu.io/hc/ja/articles/202957070 ## How to Build