kintone命令列工具（cli-kintone）

連結已複製

本頁面使用機器翻譯而成。
機器翻譯免責聲明

什麼是cli-kintone?

連結已複製

kintone命令行工具（cli-kintone）是帶有命令輸入和輸出kintone記錄資訊的工具。
它作為命令行工具提供，因此可以從shell文本檔調用和執行它。

除了記錄資訊的輸入/輸出外，還可以在kintone介面中批量註冊和更新記錄功能中執行以下操作。

批量下載記錄附件。
將附件批量附加到記錄。

本文將對cli-kintone的基本用法進行說明。
關於cli-kintone版本v1.0.0之前版本的使用方法，請參考kintone命令行工具（cli-kintone v0）。

執行範例使用 Windows 命令提示符。
如果要在其他環境中運行它，請根據需要替換路徑和檔名。

本文將對cli-kintone的基本用法進行說明。
如果您想瞭解更多的使用方法，請參考教程" cli-kintone 入門"。

支援政策

連結已複製

cli-kintone由Cybozu開發並提供，旨在用於生產環境。
如果您對cli-kintone版本v1.0.0及以上版本有疑問，或者有任何疑問，可以聯繫API支援台。
有關如何聯繫我們的資訊，請參閱以下頁面。
如何聯繫支持人員

原始程式碼的修改、再分發和商業用途可根據許可證使用。
您可以在每個用戶端庫的頁面或 GitHub 儲存庫中找到許可證類型。
但是，不支援因更改原始程式碼而引起的麻煩。

GitHub

連結已複製

https://github.com/kintone/cli-kintone

授權

連結已複製

MIT License

公文

連結已複製

https://github.com/kintone/cli-kintone/blob/main/README.md

注意事項

連結已複製

使用cli-kintone輸入輸出記錄時，需要訂閱標準版。
處理大量記錄數據時，kintone不堪重負，性能可能會受到影響。

如何開始

連結已複製

下載cli-kintone可執行檔

連結已複製

您可以在GitHub下載適用於Windows、macOS和Linux的cli-kintone可執行檔。

轉到 GitHub 上的「版本」頁面。
根據要從「資產」執行的環境下載檔。
- 在 Windows 上運行時：cli-kintone-win.zip
- 在 Linux 上執行時：cli-kintone-linux.zip
- 在 macOS 上：cli-kintone-macos.zip
解壓縮檔並將可執行檔放在您選擇的目錄中。

對於Windows用戶：啟動命令提示符

連結已複製

命令提示符會按照以下步驟啟動：命令提示符是運行cli-kintone所需的工具。

同時按下【Win】和【R】鍵。
運行打開。
在「名稱」欄位中輸入「cmd」，然後按兩下[確定]。
命令提示符將啟動。

使用 cd 命令切換到放置cli-kintone.exe的目錄。

1
2


# 如果你把cli-kintone.exe放在桌面上的"works"目錄下
cd Desktop\works

查看cli-kintone版本

連結已複製

查看cli-kintone版本，看看是否可以運行cli-kintone。

1
2
3
4


cli-kintone.exe --version

# 顯示版本號
1.0.0

如果顯示下載的版本號，則可以。

用

連結已複製

匯出數據

連結已複製

要顯示有關記錄的資訊，record export 請指定。
此外，在下一個選項中，請指定要操作的kintone功能變數名稱和應用ID。

--base-url：需要操作的kintone功能變數名稱（例如：https://sample.cybozu.com）
--app：App ID（例如 123）

使用 API 令牌查看記錄資訊

要使用 API 令牌顯示有關記錄的資訊，請在--api-token 選項中指定 API 令牌。

1
2


cli-kintone.exe record export --base-url https://subdomain.cybozu.com --app App ID ^
  --api-token API 令牌

--api-token：API 令牌（例如 BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL）
若要查看記錄的內容，API 令牌必須具有「查看記錄」訪問許可權。
有關如何頒發 API 令牌的資訊，請參閱生成 API 令牌。

運行該命令時，你將看到 CSV 格式的應用記錄資訊。
項目的標題名稱是域代碼的值。

執行範例

1
2
3
4
5
6
7


cli-kintone.exe record export --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL

# 輸出結果
"記錄編號"，"EmployeeId"，"名稱"，"JoinDate"，"Division"，"Author"，"Created"，"Modified By"，"Modified"
"2"，"0002"，"鈴木千花"，"2021-01-01"，"總務部"，"管理員"，"2022-07-12T01：49：00Z"，"管理員"，"2022-07-12T01：49：00Z"
"1"，"0001"，"Yukihiro Yamada"，"2020-01-01"，"總務部"，"管理員"，"2022-07-12T01：49：00Z"，"管理員"，"2022-07-12T01：49：00Z"

匯出到 CSV 檔

您可以使用shell的重定向函數（>）將結果輸出到檔案。

執行範例

1
2
3


# 將結果輸出到名為 「records.csv」 的檔案的範例
cli-kintone.exe record export --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL > records.csv

指定細化條件和數據順序

--condition 指定選項和 --order-by 選項的查詢。
關於查詢表示法，請參考 cli-kintone中查詢的編寫方法。

1
2
3


cli-kintone.exe record export --base-url https://subdomain.cybozu.com --app App ID ^
  --api-token API 令牌 ^
  --condition "查詢細化" --order-by "查詢排序"

--condition 可選：查詢精簡程式
--order-by 可選：查詢數據的順序

執行範例

1
2
3
4
5
6
7
8
9


# JoinDate 為 2014 年 1 月 1 日及以後的數據，按 JoinDate 的升序顯示
cli-kintone.exe record export --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --condition "JoinDate >= \"2014-01-01\"" --order-by "JoinDate asc"

# 輸出結果
"記錄編號"，"EmployeeId"，"名稱"，"JoinDate"，"Division"，"Author"，"Created"，"Modified By"，"Modified"
"1"，"0001"，"Yukihiro Yamada"，"2020-01-01"，"總務部"，"管理員"，"2022-07-12T01：49：00Z"，"管理員"，"2022-07-12T01：49：00Z"
"2"，"0002"，"鈴木千花"，"2021-01-01"，"總務部"，"管理員"，"2022-07-12T01：49：00Z"，"管理員"，"2022-07-12T01：49：00Z"

下載附件

要下載附加到記錄的檔案，請在--attachments-dir 選項中指定要下載到的目錄的名稱。
目錄名稱是相對於運行的位置而言的。

1
2
3


cli-kintone.exe record export --base-url https:// subdomain.cybozu.com --app App ID ^
  --api-token API 令牌 ^
  --attachments-dir 輸出附件的目錄

--attachments-dir：附件下載到的目錄

執行範例

1
2
3
4
5
6
7
8
9


# 輸出檔案附加到「附件」 下的記錄
cli-kintone.exe record export --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --attachments-dir ./attachments

# 輸出結果
"記錄編號"，"EmployeeId"，"名稱"，"JoinDate"，"部門"，"照片"，"作者"，"已創建"，"更新人"，"已修改"
"2"，"0002"，"鈴木千花"，"2021-01-01"，"總務部"，"suzuki-chika.png"，"管理員"，"2022-07-12T01：49：00Z"，"管理員"，"2022-07-12T01：49：00Z"
"1"，"0001"，"Yukihiro Yamada"，"2020-01-01"，"總務部"，"yamada-hiroyuki.png"，"管理員"，"2022-07-12T01：49：00Z"，"管理員"，"2022-07-12T01：49：00Z"

執行時，附件將下載到在指定目錄中創建的下一個目錄。
建立的目錄：欄位代碼-記錄號碼

1
2
3
4
5
6


Works # 帶cli-kintone.exe目錄
└─── attachments
    ├── Photo-1
    │    └── yamada-hiroyuki.png
    └── Photo-2
          └── suzuki-chika.png

查看表中的數據

與標準文件匯出功能類似，表中的數據顯示在單個記錄內容的多行中。
從*檔的第一列到下一列的行是*單個記錄的數據。

執行範例

1
2
3
4
5
6
7
8


cli-kintone.exe record export --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL

# 輸出結果
*，"記錄編號"，"EmployeeId"，"名稱"，"JoinDate"，"Division"，"AssignInformation"，"AssignDate"，" AssignDivision"，"作者"，"已創建"，"更新人"，"已修改"
*，"2"，"0001"，"鈴木千花"，"2021-01-01"，"總務部"，"3705"，"2021-01-01"，"總務部"，"管理員"，"2022-07-12T01：49：00Z"，"管理員"，"2022-07-12T01：49：00Z"
*，"1"，"0001"，"Yukihiro Yamada"，"2020-01-01"，"總務部"，"3703"，"2020-01-01"，"銷售部"，"管理員""，"2022-07-12T01：49：00Z"，"管理員"，"2022-07-12T01：49：00Z"
，"1"，"0001"，"Yukihiro Yamada"，"2020-01-01"，"總務部"，"3702"，"2021-01-01"，"總務部"，"管理員"，"2022-07-12T01：49：00Z"，"管理員"，"2022-07-12T01：49：00Z"

匯入數據

連結已複製

要新增或更新記錄，record import 請指定。
此外，在下一個選項中，請指定要操作的kintone功能變數名稱和應用ID。

--base-url：需要操作的kintone功能變數名稱（例如：https://sample.cybozu.com）
--app：App ID（例如 123）

新增記錄

要使用 API 令牌添加記錄，請在--api-token 可選取中指定 API 令牌。
此外，--file-path 請在中指定要導入的檔。

1
2
3


cli-kintone.exe record import --base-url https:// subdomain.cybozu.com --app app id ^
  --api-token API 令牌 ^
  --file-path 文件路徑

--api-token：API 令牌（例如 BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL）
要添加記錄，您必須具有對 API 令牌的「添加記錄」訪問許可權，以及「查看記錄」和「編輯記錄」訪問許可權才能對其進行編輯。
有關如何頒發 API 令牌的資訊，請參閱生成 API 令牌。
--file-path：包含要添加的記錄資訊的 CSV 檔案的路徑

CSV 檔的第一行是標題行。
欄位名稱指定與列對應的欄位的欄位代碼。

準備CSV檔案

1
2
3


"EmployeeId","Name","JoinDate","Division"
"0004"，"Yoshio Kato"，"2020-04-01"，"企劃部"
"0003","山本 慎吾","2020-04-01","人事部"

運行該命令時，將顯示已添加的記錄數。

執行範例

1
2
3
4
5
6


cli-kintone.exe record import --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --file-path ./example.csv

[2023-02-01T06:12:06.505Z] INFO: Starting to import records...
[2023-02-01T06:12:07.751Z] INFO: Imported 2 records successfully

通過指定批量更新的金鑰來添加或更新記錄

--update-key （可選）指定欄位的欄位代碼，該欄位代碼將成為批量更新的密鑰。
可以將以下欄位指定為大量更新的鍵：

記錄號碼
防止為以下欄位開啟重複值：
- 單行文字方塊
- 數值

1
2
3
4


cli-kintone.exe record  --base-url https:// subdomain.cybozu.com --app app id ^
  --api-token API 令牌 ^
  --file-path 檔路徑 ^
  --update-key 批量更新的關鍵欄位的欄位代碼

--update-key 與映射的 CSV 檔中指定的欄位值匹配的記錄和映射的 CSV 檔中的列將被覆蓋。
如果沒有匹配項，則添加新記錄。

--update-key：批量更新的關鍵欄位的欄位代碼

運行該命令時，將顯示添加/更新的記錄數。

執行範例

1
2
3
4
5
6
7
8


cli-kintone.exe record import --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --file-path ./example.csv ^
  --update-key "EmployeeId"

[2023-02-01T06:12:05.920Z] INFO: Preparing to import records...
[2023-02-01T06:12:06.505Z] INFO: Starting to import records...
[2023-02-01T06:12:07.751Z] INFO: Imported 2 records successfully

上傳CSV檔案

新增附件

若要上載附件並將其附加到記錄，--attachments-dir 可以選擇指定放置要上載的文件的目錄。
目錄名稱是相對於運行的位置而言的。

CSV 中附件欄位的值指定要附加的檔案的路徑。
路徑必須--attachments-dir 相對於中指定的位置。
如果要在欄位中指定多個檔案，請使用換行符分隔符元。

CSV 示例

1
2
3
4


"EmployeeId","Name","JoinDate","Division","Photo"
"0006","前田 友美","2021-04-01","人事部","maeda-tomomi.png"
"0005"，"Takumi Nakamura"，"2015-04-01"，"總務部"，"nakamura-takumi.png
nakamura-takumi-nekochan.png"

示例目錄結構

1
2
3
4
5


Works # 帶cli-kintone.exe目錄
└── attachments
  ├── maeda-tomomi.png
  ├── nakamura-takumi.png
  └── nakamura-takumi-nekochan.png

運行該命令時，將顯示添加/更新的記錄數。

執行範例

1
2
3
4
5
6
7


cli-kintone.exe record import --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --file-path ./example.csv ^
  --attachments-dir ./attachments

[2023-02-01T06:19:00.671Z] INFO: Starting to import records...
[2023-02-01T06:19:01.475Z] INFO: Imported 2 records successfully

刪除附件

如果要刪除已附加檔的欄位中的附件，請將附件欄位的值留空。

CSV 示例

1
2


"EmployeeId","Name","JoinDate","Division","Photo"
"0005","前田 友美","2021-04-01","人事部",""

執行範例

1
2
3
4
5
6
7
8
9


cli-kintone.exe record import --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --file-path ./example.csv ^
  --update-key "EmployeeId" ^
  --attachments-dir ./attachments

[2023-02-10T06:23:43.147Z] INFO: Preparing to import records...
[2023-02-10T06:23:43.498Z] INFO: Starting to import records...
[2023-02-10T06:23:44.243Z] INFO: Imported 1 records successfully

添加或更新表中的記錄

與標準文件匯出功能一樣，對於表中的每個數據，一條記錄的內容在多行中列出。
從*檔的第一列到下一列"*"的行表示單個記錄中的數據。

檔的第一列應命名為」。*
每條記錄的第一行數據的第一列應為"*"，其餘部分應為空。

謹慎

更新現有記錄表時要記住的事項

即使表中的行不會更改數據，也請確保在 CSV 檔中包含所有行資料。
刪除檔案中未包含的行數據。
如果表中有不想更新其數據的欄位，請執行下列操作之一：
否則，檔中未列出的表中的欄位值將為空。
- 包括行的ID。
  當您檢視表中的數據時，您可以在表欄位的值中找到該行的 ID。
- 包括表中所有欄位的數據。

CSV 示例

1
2
3
4


"*","EmployeeId","Name","JoinDate","Division","AssignInformation","AssignDate","AssignDivision"
"*"，"0007"，"小川裡沙"，"2021-04-01"，"銷售部"，"3705"，"2021-04-01"，"銷售部"
"*"，"0008"，"栗田健一"，"2020-04-01"，"企劃部"，"3703"，"2020-04-01"，"企劃部"
""，"0008"，"栗田健一"，"2020-04-01"，"企劃部"，"3702"，"2021-04-01"，"人力資源部"

執行範例

1
2
3
4
5
6


cli-kintone.exe record import --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --file-path ./example.csv

[2023-02-10T06:23:43.498Z] INFO: Starting to import records...
[2023-02-10T06:23:44.243Z] INFO: Imported 2 records successfully

刪除預先登錄資料

連結已複製

警告

record delete 刪除的記錄無法恢復。

要刪除記錄，record delete 請指定。
record delete 僅支援使用 API 令牌身份驗證刪除記錄。
在下一個選項中，指定需要操作的kintone功能變數名稱、應用ID和API Token。

--base-url：需要操作的kintone功能變數名稱（例如：https://sample.cybozu.com）
--app：App ID（例如 123）
--api-token：API 令牌（例如 BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL）
若要刪除記錄，API 令牌必須具有"刪除記錄"訪問許可權。
有關如何頒發 API 令牌的資訊，請參閱生成 API 令牌。

刪除所有記錄

要刪除所有記錄，--file-path 請運行不帶 .

1
2


cli-kintone.exe記錄刪除 --base-url https:// subdomain.cybozu.com --app app ID ^
  --api-token API 令牌

執行範例

1
2
3
4
5
6


cli-kintone.exe record delete --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL

）。 Are you sure want to delete records? Yes
[2023-02-27T07:20:29.148Z] INFO: Starting to delete all records...
[2023-02-27T07:20:29.632Z] INFO: 50 records are deleted successfully

刪除部分記錄

如果要刪除某些記錄，請準備一個包含要刪除的記錄編號的 CSV 檔，並在 --file-path 中指定它們。

--file-path：包含要刪除的記錄編號的 CSV 檔案的路徑

1
2
3


cli-kintone.exe記錄刪除 --base-url https:// subdomain.cybozu.com --app app ID ^
  --api-token API 令牌 ^
  --file-path 文件路徑

CSV 檔的第一行是標題行。
欄位名稱指定記錄編號欄位的欄位代碼。
在第二行和後續行中，指定要刪除的記錄的記錄編號，或包含應用代碼的記錄編號。

CSV 示例

1
2
3


"記錄號碼"
"sampleApp-1"
"sampleApp-2"

運行該命令時，系統將提示您確認刪除。
如果要刪除它，請鍵入 Y 並Enter 按鍵。如果要取消，請輸入"n"。
--yes 如果使用 or -y 選項執行命令，則可以刪除記錄，而不會提示確認刪除。

執行範例

1
2
3
4
5
6


cli-kintone.exe record delete --base-url https://sample.cybozu.com --app 123 ^
  --api-token BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL ^
  --file-path ./example.csv -y

[2023-02-27T06:09:00.243Z] INFO: Starting to delete records...
[2023-02-27T06:09:00.938Z] INFO: 2 records are deleted successfully

選項

連結已複製

關於v1.0.0之前版本的cli-kintone選項清單，請參見cli-kintone v0|選項清單。

出口

連結已複製

record export --help 後跟該選項顯示匯出選項清單。

選項	說明
`--version`	顯示版本。
`--help`	顯示説明。
`--base-url`	必須 kintone的域名（例如，https://sample.cybozu.com）它在“https://”的開頭指定。
`--app`	必須待操作的kintone的應用ID。
`--api-token`	條件必填項 API 令牌。需要 API 令牌或登錄名和密碼組合。如果要指定多個 API 令牌，請`,`用逗號分隔 API 令牌。例：`--api-token "BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL,WjfkaoKncXlXFqIY0lLwfv8FZELUkv8YnZRnV104"`
`--username`	條件必填項這是kintone的登錄名。需要 API 令牌或登錄名和密碼組合。 `-u` 別名也可用。
`--password`	條件必填項 kintone的密碼。需要 API 令牌或登錄名和密碼組合。 `-p` 別名也可用。
`--attachments-dir`	如果要在「附件」字段中下載檔，請指定要輸出附件的目錄的路徑。
`--condition`	指定對記錄精簡程序的查詢。有關查詢表示法的詳細內容，請參考 CLI-kintone 細化條件中編寫查詢的方法。
`--order-by`	指定對記錄排序順序的查詢。有關查詢表示法，請參考如何使用cli-kintone 排序順序編寫查詢。
`--fields`	如果只想匯出特定欄位，請指定要匯出的欄位的欄位代碼 `,`，以逗號分隔。例如，如果只想匯出「JoinDate」和「Division」項，請指定 `--fields "JoinDate,Division"` 。無法將表格內的欄位指定為複製目標。如果要輸出表，請指定表欄位的域代碼。將列印表中的所有欄位。
`--basic-auth-username`	如果已設置基本身份驗證，請指定基本身份驗證的使用者名。
`--basic-auth-password`	如果配置了基本身份驗證，請指定基本身份驗證的密碼。
`--guest-space-id`	如果您在訪客空間中使用應用程式，請指定訪客空間ID。
`--encoding`	要匯出的數據的字元編碼。默認值為"utf8"。 utf8：UTF-8 sjis：Shift-JIS
`--pfx-file-path`	如果要配置安全訪問，請指定用戶端證書文件的路徑。
`--pfx-file-password`	如果要配置安全訪問，請指定客戶端憑證檔的密碼。
`--proxy`	如果通過代理伺服器運行，請指定代理伺服器的位址和埠號。以“http://”或“https://”開頭。如果代理伺服器需要使用者身份驗證，請在代理伺服器位址之前以「username：password@」格式指定憑據。例：`--proxy http://使用者名稱:密碼@代理伺服器的位址:埠號`

進口

連結已複製

record import --help 後跟「選項」顯示導入的選項清單。

選項	說明
`--version`	顯示版本。
`--help`	顯示説明。
`--base-url`	必須 kintone的域名（例如，https://sample.cybozu.com）它在“https://”的開頭指定。
`--app`	必須待操作的kintone的應用ID。
`--api-token`	條件必填項 API 令牌。需要 API 令牌或登錄名和密碼組合。如果要指定多個 API 令牌，請`,`用逗號分隔 API 令牌。例：`--api-token "BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL,WjfkaoKncXlXFqIY0lLwfv8FZELUkv8YnZRnV104"`
`--username`	條件必填項這是kintone的登錄名。需要 API 令牌或登錄名和密碼組合。 `-u` 但您可以指定它。
`--password`	條件必填項 kintone的密碼。需要 API 令牌或登錄名和密碼組合。 `-p` 但您可以指定它。
`--update-key`	欄位的欄位代碼，這是批量更新記錄的鍵。您可以指定以下欄位：記錄號碼防止為以下欄位開啟重複值：單行文字方塊數值
`--file-path`	必須要匯入的文件的路徑。僅支援帶有 `.csv` 擴展名的檔。
`--attachments-dir`	如果要在附件欄位中附加檔，請指定放置附件的目錄的路徑。
`--fields`	在文件中導入有限數量的專案時，請指定目標項目對應的欄位的欄位代碼 `,`，以（單位元組逗號）分隔。例如，如果只想導入檔中的「JoinDate」和「Division」項，請指定 `--fields "JoinDate,Division"` 。
`--basic-auth-username`	如果已設置基本身份驗證，請指定基本身份驗證的使用者名。
`--basic-auth-password`	如果配置了基本身份驗證，請指定基本身份驗證的密碼。
`--guest-space-id`	如果您在訪客空間中使用應用程式，請指定訪客空間ID。
`--encoding`	要導入的檔的字元編碼。默認值為"utf8"。 utf8：UTF-8 sjis：Shift-JIS
`--pfx-file-path`	如果要配置安全訪問，請指定用戶端證書文件的路徑。
`--pfx-file-password`	如果要配置安全訪問，請指定客戶端憑證檔的密碼。
`--proxy`	如果通過代理伺服器運行，請指定代理伺服器的位址和埠號。以“http://”或“https://”開頭。如果代理伺服器需要使用者身份驗證，請在代理伺服器位址之前以「username：password@」格式指定憑據。例：`--proxy http://使用者名稱:密碼@代理伺服器的位址:埠號`

刪除記錄

連結已複製

record delete --help 後跟該選項顯示刪除選項清單。

選項	說明
`--version`	顯示版本。
`--help`	顯示説明。
`--base-url`	必須 kintone的域名（例如，https://sample.cybozu.com）它在“https://”的開頭指定。
`--app`	必須待操作的kintone的應用ID。
`--api-token`	必須 API 令牌。
`--file-path`	包含要刪除的記錄的資訊的檔案的路徑。僅支援帶有 `.csv` 擴展名的檔。
`--yes`	刪除記錄而不提示您確認刪除。 `-y` 別名也可用。
`--basic-auth-username`	如果已設置基本身份驗證，請指定基本身份驗證的使用者名。
`--basic-auth-password`	如果配置了基本身份驗證，請指定基本身份驗證的密碼。
`--guest-space-id`	如果您在訪客空間中使用應用程式，請指定訪客空間ID。
`--encoding`	這是要刪除的數據的字元編碼。默認值為"utf8"。 utf8：UTF-8 sjis：Shift-JIS
`--pfx-file-path`	如果要配置安全訪問，請指定用戶端證書文件的路徑。
`--pfx-file-password`	如果要配置安全訪問，請指定客戶端憑證檔的密碼。
`--proxy`	如果通過代理伺服器運行，請指定代理伺服器的位址和埠號。以“http://”或“https://”開頭。如果代理伺服器需要使用者身份驗證，請在代理伺服器位址之前以「username：password@」格式指定憑據。例：`--proxy http://使用者名稱:密碼@代理伺服器的位址:埠號`

限制

連結已複製

欄位限制

連結已複製

添加記錄時，以下欄位只能反映 CSV 檔的內容。
請使用已授予「管理應用許可權」的 API 令牌或用戶帳戶。
- 建立人
- 建立時間
- 更新人
- 更新時間
無法匯出以下欄位：
- 狀態
- 執行者
- 類別
- 相關記錄清單
導入到以下欄位不會註冊或更新值。
- 從查找源複製的欄位
- 計算
- 具有自動計算功能的字串（單行）欄位
- 狀態
- 執行者
- 類別
- 相關記錄清單

其他限制

連結已複製

如果設定了IP位址限制，請使用以下方法之一：
- 允許從運行環境的IP位址進行訪問。
  如何配置IP位址限制
- 使用使用者身份驗證為已配置安全訪問的使用者指定客戶端證書。
  設置安全訪問

修訂記錄

連結已複製

cli-kintone的最新更新，請參見變更日誌。

2022 年 10 月 1 日：文章發表。
2023 年 3 月 2 日：在 v1.3.0 中添加了刪除命令。
2023 年 5 月 1 日：在 v1.4.0 中添加了對代理連接的使用者身份驗證的支援。

與先前版本（v0）的功能差異

連結已複製

cli-kintone v1.0.0及之後版本增強了同時添加和更新記錄數據的能力，並實現了安全訪問支援。
與v1.0.0（v0.x.x）之前的cli-kintone版本的功能區別，請參考以下頁面。
與cli-kintone之前版本（v0）的功能差異

本文介紹的示例代碼已經過kintone的2022年9月版和cli-kintone的1.0.0版本測試。

反饋給cli-kintone

連結已複製

您還可以在 GitHub 問題中請求或詢問有關該功能的問題。

SDK & Tools