Skip to content
This repository was archived by the owner on Oct 31, 2023. It is now read-only.

Commit 49d9f4a

Browse files
author
Nguyen Hoang Anh
committed
Merge branch 'master' into dev_v0.14.0
# Conflicts: # README.md
2 parents d5951ab + ac0e184 commit 49d9f4a

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

README.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ https://github.com/kintone-labs/cli-kintone/releases
3636
-g= Guest Space ID (default: 0)
3737
-o= Output format. Specify either 'json' or 'csv' (default: csv)
3838
-e= Character encoding (default: utf-8).
39-
Only support the encoding below both field code and data itself:
39+
Only support the encoding below both field code and data itself:
4040
'utf-8', 'utf-16', 'utf-16be-with-signature', 'utf-16le-with-signature', 'sjis' or'euc-jp', 'gbk' or 'big5'
4141
-U= Basic authentication user name
4242
-P= Basic authentication password
@@ -52,7 +52,7 @@ https://github.com/kintone-labs/cli-kintone/releases
5252
-h, --help Show this help message
5353
```
5454
## Examples
55-
Note:
55+
Note:
5656
* If you use Windows device, please specify cli-kintone.exe
5757
* Please set the PATH to cli-kintone to match your local environment beforehand.
5858

@@ -68,11 +68,11 @@ cli-kintone --export -a <APP_ID> -d <FQDN> -e sjis -c "$id, name1, name2" -t <AP
6868
```
6969
cli-kintone --import -a <APP_ID> -d <FQDN> -e sjis -t <API_TOKEN> -f <INPUT_FILE>
7070
```
71-
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").
71+
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").
7272

73-
If the value in the $id (or key field) column matches a record number value, that record will be updated.
74-
If the value in the $id (or key field) column is empty, a new record will be added.
75-
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.
73+
If the value in the $id (or key field) column matches a record number value, that record will be updated.
74+
If the value in the $id (or key field) column is empty, a new record will be added.
75+
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.
7676
If an $id (or key field) column does not exist in the file, new records will be added, and no records will be updated.
7777

7878
### Export and download attachment files to ./mydownloads directory
@@ -109,7 +109,7 @@ cli-kintone --import -a <APP_ID> -d <FQDN> -t <API_TOKEN> -b myuploads -f <INPUT
109109
>
110110
>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.
111111
112-
The key to bulk update must be specified within the INPUT_FILE by placing an * in front of the field code name,
112+
The key to bulk update must be specified within the INPUT_FILE by placing an * in front of the field code name,
113113
e.g. “update_date",“*id",“status".
114114
115115
```
@@ -127,23 +127,33 @@ printf "name,age\nJohn,37\nJane,29" | cli-kintone --import -a <APP_ID> -d <FQDN>
127127
## Restrictions
128128
* The limit of each file size for uploading to attachments field is 10MB.
129129
* Client certificates cannot be used with cli-kintone.
130+
<<<<<<< HEAD
130131
* The following record data cannot be retrieved: Field group, Blank space, Label, Border, Related records, Status, Assignee, Category
132+
=======
133+
* The following record data cannot be retrieved: Category, Status, Field group.
134+
* 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.
135+
>>>>>>> master
131136
132137
## Restriction of Encode/Decode
133-
* Windows command prompt may not display characters correctly like "譁�蟄怜喧縺�".
138+
* Windows command prompt may not display characters correctly like "譁�蟄怜喧縺�".
134139
This is due to compatibility issues between Chinese & Japanese characters and the Windows command prompt.
135140
* Chinese (Traditional/Simplified): Display wrong even if exporting with gbk or big5 encoding.
136141
* Japanese: Display wrong even if exporting with sjis or euc-jp encoding.
137-
142+
138143
In this case, display the data by specifying utf-8 encoding like below:
139144
```
140145
cli-kintone --export -a <APP_ID> -d <FQDN> -e utf-8
141146
```
142147
*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.
143148
144149
## Documents for Basic Usage
150+
<<<<<<< HEAD
145151
- English: https://kintone.dev/en/tutorials/tool-guides/features-of-the-command-line-tool/
146152
- Japanese: https://developer.cybozu.io/hc/ja/articles/202957070
153+
=======
154+
English: https://developer.kintone.io/hc/en-us/articles/115002614853
155+
Japanese: https://developer.cybozu.io/hc/ja/articles/202957070
156+
>>>>>>> master
147157
148158
## How to Build
149159

0 commit comments

Comments
 (0)