kintone命令列工具(cli-kintone)
本頁面使用機器翻譯而成。
機器翻譯免責聲明
關於cli-kintone
kintone命令列工具(cli-kintone)是可以使用命令將kintone記錄資訊輸入和輸出為CSV檔(可在Excel中打開的數據)的工具。
它作為命令列工具提供,因此可以從殼層腳本檔案調用和執行它。
除了記錄資訊的匯入與匯出外,還可以執行在kintone畫面上無法實現的大量新增和更新記錄。
- 批量下載記錄附件。
- 將附件批量附加到記錄。
- 大量刪除附件
有關更多資訊,請參閱 下載、上傳和刪除附件 。
本文將對cli-kintone的基本用法進行說明。
關於v1.0.0之前版本的cli-kintone使用方法,請參考以下頁面。
kintone命令列工具(cli-kintonev0)
範例使用Windows命令提示符。
如果要在其他環境中運行,請根據需要替換路徑和檔名。
本文將對cli-kintone的基本用法進行說明。
如果您想瞭解更多關於如何使用它以及如何使用它的資訊,請參考以下教程。
kintone API入門
支援政策
cli-kintone由cybozu開發並提供,旨在用於正式環境。
如果您對cli-kintone版本v1.0.0及以上版本有疑問,或者有任何疑問,可以聯繫API支援台。
有關如何聯繫我們的資訊,請參閱以下頁面。
諮詢方法
原始程式碼的修改、再分發和商業用途可根據許可證使用。
您可以在每個用戶端庫的頁面或GitHub儲存庫中找到許可證類型。
但是,不支援因變更原始程式碼而引起的麻煩。
GitHub
https://github.com/kintone/cli-kintone
授權
文件
注意事項
- 需標準版或更高方案才時,需要訂閱標準版。
- 處理大量記錄數據時,會給kintone帶來負載,性能可能會受到影響。
如何導入
請參閱以下文章的「導入方法」部分:
cli-kintone入門系列|介紹
使用方法
匯出資料
要顯示紀錄的資訊,請指定record export。
此外,請在以下選項中指定要操作的kintone網域名稱與應用程式ID。
--base-url:需要操作的kintone網域名(例如:https://sample.cybozu.com)--app:應用程式ID(例如123)
使用API權杖查看記錄資訊
要使用API權杖顯示有關記錄的資訊,請在--api-token選項中指定API權杖。
|
|
--api-token:API權杖(例如BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL)
若要查看記錄的內容,API權杖必須具有「查看記錄」訪問許可權。
有關發行API權杖,請參閱以下頁面。
產生API權杖
運行該命令時,你將看到CSV格式的應用記錄資訊。
項目的標題名稱是欄位代碼的值。
執行範例
|
|
匯出到CSV檔案
您可以使用殼層的重定向函數(>)將結果輸出到檔案。
執行範例
|
|
指定篩選條件和排序
使用--condition和--order-by選項指定查詢。
有關查詢表示法說明,請參閱以下頁面。
如何在cli-kintone中編寫查詢
|
|
--condition選項:篩選條件的查詢--order-by選項:排序的查詢
執行範例
|
|
下載附件
要下載附加到記錄的檔案,請在--attachments-dir選項中指定要下載到的目錄的名稱。
目錄名稱是相對於運行的位置而言的。
|
|
--attachments-dir:附件下載到的目錄
執行範例
|
|
執行時,附件將下載到在指定目錄中創建的下一個目錄。
建立的目錄:欄位代碼-記錄號碼
|
|
查看表中的數據
與標準匯出檔案功能類似,單個記錄的表中數據分多行顯示。
從檔案的第一行的*到下一*的前一行為止,為單個記錄的數據。
執行範例
|
|
匯入數據
要新增或更新記錄,請指定record import。
此外,請在以下選項中指定要操作的kintone網域名稱與應用程式ID。
--base-url:需要操作的kintone網域名(例如:https://sample.cybozu.com)--app:應用程式ID(例如123)
新增記錄
要使用API權杖添加記錄,請在--api-token選項取中指定API權杖。
此外,在--file-path中指定要導入的檔。
|
|
--api-token:API權杖(例如BNk5wfOufWtPSTc6miMBTEa0SEm5ZokIcJWSSYXL)
要新增記錄,API權杖必須具有「新增記錄」的權限。要編輯記錄,需要具有「查看記錄」和「編輯記錄」的權限。
有關發行API權杖,請參閱以下頁面。
產生API權杖--file-path:包含要添加的記錄資訊的CSV檔案的路徑
CSV檔的第一行是標題行。
項目名稱的各行為對應欄位的欄位代碼。
CSV檔案範例
|
|
運行該命令時,將顯示已新增的記錄數。
執行範例
|
|
指定大量更新的索引鍵來新增或更新紀錄
用--update-key選項指定欄位的欄位代碼,該欄位代碼將成為大量更新的索引鍵。
可以將以下欄位指定為大量更新的索引鍵:
- 記錄號碼
- 已啟用「值為唯一」,以下欄位:
- 單行文字方塊
- 數值
|
|
與--update-key所指定欄位相對應的CSV檔案欄位值相符的紀錄,將會被覆寫。
如果沒有匹配項,則添加新記錄。
--update-key:批量更新的索引鍵欄位的欄位代碼
運行該命令時,將顯示新增/更新的記錄數。
執行範例
|
|
上傳檔案
新增附件
若要上載附件並將其附加到記錄,請用--attachments-dir選項指定放置要上傳的檔案的目錄。
目錄名稱是相對於運行的位置而言的。
CSV中附件欄位的值指定要附加的檔案的路徑。
路徑必須是--attachments-dir中指定的位置的相對路徑。
如果要在一個欄位中指定多個檔案,請使用換行符(LF)來間隔各檔案。
一個檔案的最大大小為1GB。
CSV示例
|
|
示例目錄結構
|
|
運行該命令時,將顯示新增/更新的記錄數。
執行範例
|
|
刪除附件
如果要刪除已附加檔的欄位中的附件,請將附件欄位的值留空。
CSV示例
|
|
執行範例
|
|
新增或更新帶有表表格的記錄
與標準匯出檔案功能一樣,對於表中的每個數據,一條記錄的內容在多行中列出。
從檔案的第一行的「*」到下一「*」的前一行,表示單個記錄中的數據。
檔的第一行爲「*」的項目名。
每條記錄的第一列的第一行為「*」,其餘部分應為空。
謹慎
更新現有記錄表時要記住的事項
- 即使有不需要變更資料的表格列,也請在CSV檔案中記載所有列的資料。
檔案中未包含的列資料將被刪除。 - 當有不需要更新資料的表格欄位時,請採取以下其中一種方式。
否則,檔中未列出的表中的欄位值將為空。- 填寫行ID。
使用record export查看表中的資料時,可以在表字段的值中找到行的ID。 - 填寫表中所有欄位的值。
- 填寫行ID。
CSV示例
|
|
執行範例
|
|
刪除資料
警告
在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權杖
刪除所有記錄
要刪除所有記錄,命令中不要帶--file-path。
|
|
執行範例
|
|
刪除部分記錄
如果要刪除某些記錄,請準備一個包含要刪除的記錄編號的CSV檔,並用--file-path中指定CSV檔。
--file-path:包含要刪除的記錄編號的CSV檔案的路徑
|
|
CSV檔的第一行是標題行。
欄位名稱指定記錄編號欄位的欄位代碼。
在第二列和後續列中,指定要刪除的記錄的記錄編號,或包含應用代碼的記錄編號。
有關應用代碼的詳細資訊,請參閱以下頁面。
應用程式代碼
CSV示例
|
|
運行該命令時,系統將提示您確認刪除。
如果確定要刪除,請鍵入「Y」並按Enter鍵。如果要取消,請輸入「n」。
使用--yes或-y選項執行命令,即可以刪除記錄,而不會提示確認刪除。
執行範例
|
|
選項清單
關於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權杖或登入名和密碼的組合。 |
--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身分驗證 |
--basic-auth-password |
如果您的環境設定了Basic身分驗證,請指定Basic身分驗證的密碼。 |
--guest-space-id |
如要對訪客空間內的應用程式進行操作,請指定訪客空間ID。 |
--encoding |
要匯出的資料的字元編碼。默認值為「utf8」。
|
--pfx-file-path |
如果您的環境設定了SecureAccess,請指定用戶端憑證檔的路徑。 有關詳細的SecureAccess,請參閱以下頁面。 SecureAccess |
--pfx-file-password |
如果您的環境設定了SecureAccess,請指定用戶端憑證檔的密碼。 |
--proxy |
如果通過代理伺服器運行,請指定代理伺服器的位址和埠號。 必須以「http://」或「https://」開頭。 如果代理伺服器需要使用者身份驗證,請在代理伺服器位址之前以「使用者名稱:密碼@」格式指定憑據。 例: --proxy http://使用者名稱:密碼@代理伺服器的IP位址:埠號 |
匯入
如在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身分驗證 |
--basic-auth-password |
如果您的環境設定了Basic身分驗證,請指定Basic身分驗證的密碼。 |
--guest-space-id |
如要對訪客空間內的應用程式進行操作,請指定訪客空間ID。 |
--encoding |
要匯入的檔的字元編碼。默認值為「utf8」。
|
--pfx-file-path |
如果您的環境設定了SecureAccess,請指定用戶端憑證檔的路徑。 有關詳細的SecureAccess,請參閱以下頁面。 SecureAccess |
--pfx-file-password |
如果您的環境設定了SecureAccess,請指定用戶端憑證檔的密碼。 |
--proxy |
如果通過代理伺服器運行,請指定代理伺服器的位址和埠號。 必須以「http://」或「https://」開頭。 如果代理伺服器需要使用者身份驗證,請在代理伺服器位址之前以「使用者名稱:密碼@」格式指定憑據。 例: --proxy http://使用者名稱:密碼@代理伺服器的IP位址:埠號 |
刪除記錄
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身分驗證 |
--basic-auth-password |
如果您的環境設定了Basic身分驗證,請指定Basic身分驗證的密碼。 |
--guest-space-id |
如要對訪客空間內的應用程式進行操作,請指定訪客空間ID。 |
--encoding |
這是要刪除的數據的字元編碼。默認值為「utf8」。
|
--pfx-file-path |
如果您的環境設定了SecureAccess,請指定用戶端憑證檔的路徑。 有關詳細的SecureAccess,請參閱以下頁面。 SecureAccess |
--pfx-file-password |
如果您的環境設定了SecureAccess,請指定用戶端憑證檔的密碼。 |
--proxy |
如果通過代理伺服器運行,請指定代理伺服器的位址和埠號。 必須以「http://」或「https://」開頭。 如果代理伺服器需要使用者身份驗證,請在代理伺服器位址之前以「使用者名稱:密碼@」格式指定憑據。 例: --proxy http://使用者名稱:密碼@代理伺服器的IP位址:埠號 |
限制事項
欄位限制
- 以下欄位僅在新增記錄時,能反映CSV檔的內容。
請使用已授予「應用程式管理權限」的API權杖或用戶帳戶。- 建立人
- 建立時間
- 更新人
- 更新時間
- 無法匯出以下欄位:
- 狀態
- 執行者
- 類別
- 相關記錄清單
- 即時匯入到以下欄位,也不會新增或更新值。
- 從Lookup複製來源的欄位
- 計算
- 具有自動計算功能的單行文字方塊欄位
- 狀態
- 執行者
- 類別
- 相關記錄清單
其他限制
- 如果設定了IP位址限制,請使用以下方法之一:
- 將執行命令的環境的IP位址設置為允許訪問。
如何設定IP位址限制 - 使用使用者身份驗證為已配置SecureAccess的使用者指定用戶端證書。
設置SecureAccess
- 將執行命令的環境的IP位址設置為允許訪問。
修訂記錄
關於cli-kintone的最新更新,請參考以下頁面。
ChangeLog
- 2022年10月1日:文章公開。
- 2023年3月2日:在v1.3.0中添加了刪除命令。
- 2023年5月1日:在v1.4.0中添加了對代理連接的使用者身份驗證的支援。
與先前版本(v0)的功能差異
在cli-kintonev1.0.0或更高版本中,實現了以下支援。
- 增強了同時添加和更新記錄數據的功能
- SecureAccess
指令選項和設定方法與v1.0.0(v0.x.x)之前的cli-kintone不同。
對cli-kintoned噁反饋
您還可以在GitHub問題中請求或詢問有關該功能的問題。
本文中提供的示例代碼已經過kintone的2022年8月版本和cli-kintone版本0.14.0的測試。