SDK & Tools

kintone控制台（cli-kintone）

information

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

目錄

關於cli-kintone

連結已複製

kintone命令行工具（cli-kintone）是可以使用命令將kintone記錄資訊輸入和輸出為CSV檔（可在Excel中打開的數據）的工具。
它作為控制台提供，因此可以從殼層腳本檔案調用和執行它。

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

  • 批量下載記錄附件。
  • 將附件批量附加到記錄。
  • 如果要刪除附件

有關更多資訊，請參閱 讓我們下載、上傳和刪除附件看。

information

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

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

本文將對cli-kintone的基本用法進行說明。
如果您想瞭解更多關於如何使用它以及如何使用它的資訊，請參考以下教程。
讓我們開始使用kintone API

支援政策

連結已複製

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

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

GitHub

連結已複製

https://github.com/kintone/cli-kintone (External link)

授權

連結已複製

MIT License (External link)

文件

連結已複製

cli-kintone (External link)

注意事項

連結已複製

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

如何開始

連結已複製

下載cli-kintone可執行檔案

連結已複製

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

  1. 存取以下頁面：
    GitHub 上Release頁面 (External link)

  2. 根據要從「Assets」執行的環境下載檔。

    • 在 Windows 上運行時：cli-kintone-win.zip
    • 在 Linux 上執行時：cli-kintone-linux.zip
    • 在 macOS 上：cli-kintone-macos.zip

  3. 解壓縮檔並將可執行檔放在您選擇的目錄中。

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

連結已複製

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

  1. 同時按下【Win】和【R】鍵。
    「執行」打開。

  2. 在「名稱」欄位中輸入「cmd」，然後點擊[確定]。
    命令提示符將啟動。

  3. 使用 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：應用ID（例如 123）
使用 API 權杖查看記錄資訊

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

1
2

cli-kintone.exe record export --base-url https://子域.cybozu.com --app 應用ID ^
  --api-token API權杖
  • --api-token：API 權杖（例如 BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL）
    若要查看記錄的內容，API 權杖必須具有「查看記錄」訪問許可權。
    有關發行API權杖，請參閱以下頁面。
    生成 API 令牌 (External link)

運行該命令時，你將看到 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","Name","JoinDate","Division","建立人","建立時間","更新人","更新時間"
"2","0002","鈴木 知香","2021-01-01","総務部","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"
"1","0001","山田 幸広","2020-01-01","総務部","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"
匯出到 CSV 檔案

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

執行範例

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://子域.cybozu.com --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","Name","JoinDate","Division","建立人","建立時間","更新人","更新時間"
"1","0001","山田 幸広","2020-01-01","総務部","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"
"2","0002","鈴木 知香","2021-01-01","総務部","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"
下載附件

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

1
2
3

cli-kintone.exe record export --base-url https://子域.cybozu.com --app 應用ID ^
  --api-token API 權杖 ^
  --attachments-dir 輸出附件的目錄
  • --attachments-dir：附件下載到的目錄

執行範例

1
2
3
4
5
6
7
8
9

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

# 輸出結果
"記錄編號","EmployeeId","Name","JoinDate","Division","Photo","建立人","建立時間","更新人","更新時間"
"2","0002","鈴木 知香","2021-01-01","総務部","suzuki-chika.png","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"
"1","0001","山田 幸広","2020-01-01","総務部","yamada-hiroyuki.png","Administrator","2022-07-12T01:49:00Z","Administrator","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","Name","JoinDate","Division","AssignInformation","AssignDate","AssignDivision","建立人","建立時間","更新人","更新時間"
*,"2","0001","鈴木 知香","2021-01-01","総務部","3705","2021-01-01","総務部","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"
*,"1","0001","山田 幸広","2020-01-01","総務部","3703","2020-01-01","営業部","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"
,"1","0001","山田 幸広","2020-01-01","総務部","3702","2021-01-01","総務部","Administrator","2022-07-12T01:49:00Z","Administrator","2022-07-12T01:49:00Z"

匯入數據

連結已複製

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

  • --base-url：需要操作的kintone功能變數名稱（例如：https://sample.cybozu.com）
  • --app：應用ID（例如 123）
新增記錄

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

1
2
3

cli-kintone.exe record import --base-url https://子域.cybozu.com --app 應用ID ^
  --api-token API 權杖 ^
  --file-path 檔案路徑
  • --api-token：API 權杖（例如 BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL）
    要添加記錄，您必須具有對 API 權杖的「添加記錄」訪問許可權，以及「查看記錄」和「編輯記錄」訪問許可權才能對其進行編輯。
    有關發行API權杖，請參閱以下頁面。
    生成 API 令牌 (External link)
  • --file-path：包含要添加的記錄資訊的 CSV 檔案的路徑

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

示例 CSV 檔案*

1
2
3

"EmployeeId","Name","JoinDate","Division"
"0004","加藤 義男","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 import --base-url https://子域.cybozu.com --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
上傳檔案
新增附件

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

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

CSV 示例

1
2
3
4

"EmployeeId","Name","JoinDate","Division","Photo"
"0006","前田 友美","2021-04-01","人事部","maeda-tomomi.png"
"0005","中村 匠","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
添加或更新表中的記錄

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

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

warning
謹慎

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

  • 即使表中的行不會變更數據，也請確保在 CSV 檔中包含所有行資料。
    刪除檔案中未包含的行數據。
  • 如果表中有不想更新其數據的欄位，請執行下列操作之一：
    否則，檔中未列出的表中的欄位值將為空。
    • 描述行的ID。
      查看表中的數據時record import`可以在表字段的值中找到行的 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

刪除資料

連結已複製

caution
警告

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

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

  • --base-url：需要操作的kintone功能變數名稱（例如：https://sample.cybozu.com）
  • --app：應用ID（例如 123）
  • --api-token：API 權杖（例如 BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL）
    若要刪除記錄，API 權杖必須具有「刪除記錄」訪問許可權。
    有關發行API權杖，請參閱以下頁面。
    生成 API 令牌 (External link)
刪除所有記錄

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

1
2

cli-kintone.exe record delete --base-url https://子域.cybozu.com --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 record delete --base-url https://子域.cybozu.com --app 應用ID ^
  --api-token API 權杖 ^
  --file-path 檔案路徑

CSV 檔的第一行是標題行。
欄位名稱指定記錄編號欄位的欄位代碼。
在第二行和後續行中，指定要刪除的記錄的記錄編號，或 包含應用代碼 的記錄編號。
有關應用代碼的詳細資訊，請參閱以下頁面。
應用程式代碼 (External link)

CSV 示例

1
2
3

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

運行該命令時，系統將提示您確認刪除。
如果要刪除它，請鍵入「Y」並Enter 按鍵。如果要取消，請輸入「n」。
--yes 如果使用或-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版本的選項清單，請參考以下頁面。
CLIkintone V0 （命令行介面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-如何在cli-kintone中編寫查詢｜篩選條件
--order-by 指定對記錄排序順序的查詢。
有關查詢表示法說明，請參閱以下頁面。
cli-如何在cli-kintone中編寫查詢｜排序順序
--fields 如果只想匯出特定欄位，請指定要匯出的欄位的欄位代碼 ,，以逗號分隔。
例如，如果只想匯出「JoinDate」和「Division」項，請指定 --fields "JoinDate,Division"。
無法將表格內的欄位指定為複製目標。
如果要輸出表，請指定表欄位的域代碼。將列印表中的所有欄位。
--basic-auth-username 如果已設置Basic身分驗證，請指定Basic身分驗證的使用者名稱。
有關詳細的Basic身分驗證，請參閱以下頁面。
Basic身分驗證 (External link)
--basic-auth-password 如果配置了Basic身分驗證 ，請指定Basic身分驗證的密碼。
--guest-space-id 如果您在訪客空間中使用應用程式，請指定訪客空間ID。
--encoding 要匯出的數據的字元編碼。默認值為「utf8」。
  • utf8：UTF-8
  • sjis：Shift-JIS
--pfx-file-path 如果配置了SecureAccess，請指定客戶端憑證檔的路徑。
有關詳細的SecureAccess，請參閱以下頁面。
SecureAccess (External link)
--pfx-file-password 如果要配置SecureAccess ，請指定客戶端憑證檔的密碼。
--proxy 如果通過代理伺服器運行，請指定代理伺服器的位址和埠號。
它在「https://」的開頭指定
如果代理伺服器需要使用者身份驗證，請在代理伺服器位址之前以「使用者名稱:密碼@」格式指定憑據。
例：--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身分驗證，請指定Basic身分驗證的使用者名稱。
有關詳細的Basic身分驗證，請參閱以下頁面。
Basic身分驗證 (External link)
--basic-auth-password 如果配置了Basic身分驗證 ，請指定Basic身分驗證的密碼。
--guest-space-id 如果您在訪客空間中使用應用程式，請指定訪客空間ID。
--encoding 要匯入的檔的字元編碼。默認值為「utf8」。
  • utf8：UTF-8
  • sjis：Shift-JIS
--pfx-file-path 如果配置了SecureAccess，請指定客戶端憑證檔的路徑。
有關詳細的SecureAccess，請參閱以下頁面。
SecureAccess (External link)
--pfx-file-password 如果要配置SecureAccess ，請指定客戶端憑證檔的密碼。
--proxy 如果通過代理伺服器運行，請指定代理伺服器的位址和埠號。
它在「https://」的開頭指定
如果代理伺服器需要使用者身份驗證，請在代理伺服器位址之前以「使用者名稱:密碼@」格式指定憑據。
例：--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身分驗證，請指定Basic身分驗證的使用者名稱。
有關詳細的Basic身分驗證，請參閱以下頁面。
Basic身分驗證 (External link)
--basic-auth-password 如果配置了Basic身分驗證 ，請指定Basic身分驗證的密碼。
--guest-space-id 如果您在訪客空間中使用應用程式，請指定訪客空間ID。
--encoding 這是要刪除的數據的字元編碼。默認值為「utf8」。
  • utf8：UTF-8
  • sjis：Shift-JIS
--pfx-file-path 如果配置了SecureAccess，請指定客戶端憑證檔的路徑。
有關詳細的SecureAccess，請參閱以下頁面。
SecureAccess (External link)
--pfx-file-password 如果要配置SecureAccess ，請指定客戶端憑證檔的密碼。
--proxy 如果通過代理伺服器運行，請指定代理伺服器的位址和埠號。
它在「https://」的開頭指定
如果代理伺服器需要使用者身份驗證，請在代理伺服器位址之前以「使用者名稱:密碼@」格式指定憑據。
例：--proxy http://ユーザー名:パスワード@プロキシサーバーのアドレス:ポート番号

限制事項

連結已複製

欄位限制

連結已複製

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

其他限制

連結已複製

  • 如果設定了IP位址限制，請使用以下方法之一：

修訂記錄

連結已複製

關於cli-kintone的最新更新，請參考以下頁面。
Change Log (External link)

  • 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）的功能差異

information

本文中提供的示例代碼已經過kintone的2022年8月版本和cli-kintone版本0.14.0的測試。

反饋給cli-kintone

連結已複製

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