kintone命令行工具(cli-kintone v0)
本頁面使用機器翻譯而成。
機器翻譯免責聲明
警告
本文介紹的CLI-kintone v0將於2023年10月31日結束包括安全更新在內的所有開發。
如果您使用的是cli-kintone v0,建議您遷移至2022年10月24日發佈的cli-kintone v1.0.0及以上版本。
詳情請參考
cli-kintone v0 終止維護通知 。
什麼是cli-kintone?
kintone命令行工具(cli-kintone)是可以使用命令將數據導入和導出到kintone的工具。
通過使用cli-kintone,可以執行以下操作,
這些操作是kintone介面中批量註冊和更新記錄功能
無法實現的。
- 批量下載記錄附件。
- 將附件批量附加到記錄。
cli-kintone作為CLI工具提供,可以從程式中導入和匯出kintone數據。
本文將對cli-kintone的基本用法進行說明。
如需詳細瞭解使用方法,
請參考kintone命令行工具 快速入門。
GitHub
https://github.com/kintone-labs/cli-kintone
授權
GNU General Public License v2.0
公文
https://github.com/kintone-labs/cli-kintone/blob/master/README.md
注意事項
- 如使用cli-kintone導入導出記錄,需要標準方案。
- 處理大量記錄數據時,kintone不堪重負,性能可能會受到影響。
如何開始
您可以在
GitHub
下載[適用於Windows、macOS和Linux的cli-kintone可執行檔。
下載檔后,將其解壓縮並將可執行檔放置在您選擇的位置。
Quickstart
以下是如何在 Windows 上使用它的示例。
匯出數據
STEP1:準備
-
使用以下欄位建立kintone應用:
欄位名稱 刪除欄位 欄位代碼 言論 員工編號 單行文字方塊 EmployeeId 身份 單行文字方塊 Name 到職日 日期 JoinDate 聯繫 下拉式選單 Division 為欄位設定以下值: - 研發部
- 總務部
- 銷售部
- 企劃部
- 人事部
頭像 附件 Photo -
添加兩條記錄作為測試數據。
-
在您創建的應用的 URL 中,找到應用 ID。
https://sample.cybozu.com/k/123
URL 末尾的數位是應用ID。 在上述情況下,123
應用 ID 為 。 -
生成具有「查看記錄」許可權的 API 令牌。
有關詳細說明, 請參閱生成 API 令牌。
步驟2:按登錄名/密碼顯示記錄資訊。
要顯示有關記錄的資訊,--export
請指定 。
--export
後跟功能變數名稱和應用ID。
-d
:網域名-a
: 應用 ID
登錄名是-u
可選的。
執行範例
|
|
系統將提示您輸入密碼。
輸入指定使用者的密碼時,應用的記錄資訊將以 CSV 格式顯示。
項目的標題名稱是域代碼的值。
執行範例
|
|
第 3 步:使用 API 令牌查看記錄資訊
您可以使用 API 令牌查看有關記錄的資訊。
API 令牌是-t
可選的。
執行範例
|
|
步驟4:使用Shift-JIS顯示記錄的內容
cli-kintone的標準字元編碼是UTF-8。
在 Shift-JIS 中顯示記錄的內容,-e
請指定選項 sjis
。
執行範例
|
|
第 5 步:匯出到檔
您可以使用 shell 重定向功能將輸出輸出到檔案。
執行範例
|
|
步驟6:指定過濾條件和數據順序。
如果要指定精簡程式或數據排序順序,-q
可以選擇指定查詢。
有關查詢表示法,
請參閱如何 編寫查詢。
執行範例
|
|
第 7 步:下載附件
如果要下載附加到記錄的檔案,請在-b
選項中指定要下載該文件的資料夾的名稱。
資料夾名稱是相對於您運行的位置的。
執行範例
|
|
附件將下載到指定資料夾下為每條記錄創建的資料夾中。
對於為每條記錄創建的資料夾,有兩種命名約定:
-
-c
如果未指定選項,或者-c
在「選項」中指定$id
資料夾名稱為"欄位代碼
-$idの値
"1 2 3 4 5 6 7
attachments ├── Photo-1 │ ├── yamada-taro.png ├── Photo-2 │ └── suzuki-hanako.png └── Photo-3 └── takahashi-ichiro.png
-
-c
如果未在選項中指定$id
資料夾名稱為"欄位代碼
-以 0 開頭的數位
"1 2 3 4 5 6 7
attachments ├── Photo-0 │ ├── yamada-taro.png ├── Photo-1 │ └── suzuki-hanako.png └── Photo-2 └── takahashi-ichiro.png
步驟 8:在表中顯示數據
下準備
-
將表的欄位添加到STEP1中創建的App中。
欄位名稱 刪除欄位 欄位代碼 言論 作業資訊 表格 AssignInformation 在表格中,放置「分配日期」和「分配的部門」。 分配日期 日期 AssignDate 清除「將記錄註冊時的日期設置為預設值」複選框。 指定部門 下拉式選單 AssignDivision 為欄位設定以下值: - 研發部
- 總務部
- 銷售部
- 企劃部
- 人事部
-
添加您建立的測試之一。
在「傳輸資訊」表中,添加兩行。
查看表中的數據
與
標準文件匯出類似,表中的數據顯示在單個記錄內容的多行中。
從*檔的第一列到下一列的行是*單個記錄的數據。
執行範例
|
|
步驟 9:指定欄位
若要指定要匯出的欄位,-c
請指定可選的。
如果要指定多個字段,請用逗號 (,
) 分隔欄位名稱。
如果要顯示表中的資料,請指定表的域代碼。無法將表格內的欄位指定為複製目標。
如果要指定欄位的順序,可以選擇排列欄位代碼,使它們-c
按照要輸出的欄位的順序排列。
執行範例
|
|
匯入數據
步驟1:準備
-
使用以下欄位建立kintone應用:
欄位名稱 刪除欄位 欄位代碼 言論 員工編號 單行文字方塊 EmployeeId 選中「禁止重複值」複選框 身份 單行文字方塊 Name 到職日 日期 JoinDate 聯繫 下拉式選單 Division 為欄位設定以下值: - 研發部
- 總務部
- 銷售部
- 企劃部
- 人事部
頭像 附件 Photo -
在您創建的應用的 URL 中,找到應用 ID。
https://sample.cybozu.com/k/123
URL 末尾的數位是應用ID。 在上述情況下,123
應用 ID 為 。 -
生成具有「添加記錄」、「編輯記錄」和「刪除記錄」許可權的 API 令牌。 有關詳細說明, 請參閱生成 API 令牌。
步驟2:添加記錄
要匯入記錄,--import
請指定 。
--import
後跟功能變數名稱和應用ID。
-d
:網域名-a
: 應用 ID
若要添加記錄,-f
可以選擇指定包含要添加到記錄的內容的 CSV 檔。
CSV 檔的第一行是欄位名稱。
欄位名稱指定相應欄位的欄位代碼。
準備CSV檔案
|
|
執行範例
|
|
步驟3:更新記錄
有兩種方法可以更新現有記錄:
方法 1:使用記錄 ID
方法 1 更新具有匹配記錄 ID 的記錄。
在 CSV 檔中,準備"$id"欄位。
對於 $id,請指定要更新的記錄 ID。
如果"$id"字段的值為空字串,則添加新記錄。
更新記錄 ID 為 1 的記錄並添加「坂本舞子」數據的範例 CSV 檔
|
|
執行範例
|
|
方法 2:使用域代碼
方法 2 更新與指定域代碼的值匹配的記錄。
欄位名稱前綴*
為 ,這是標識數據的關鍵。
對於鍵欄位,設置「禁止重複值」。
此外,您不能指定記錄編號欄位。
修改員工編號為"0005"的記錄的 CSV 檔示例
|
|
執行範例
|
|
步驟4:刪除並添加所有現有記錄。
若要刪除所有現有資料並添加記錄,請-D
指定該選項。
執行範例
|
|
步驟5:上傳附件
若要將檔案附加到記錄,-b
可以選擇指定放置要上載的檔的資料夾的名稱。
資料夾名稱是相對於您運行的位置的。
您為 CSV 中附件欄位的值指定的檔案是相對於您執行的位置的。
*CSV 示例
|
|
範例資料夾結構
|
|
執行範例
|
|
指定多個檔時
如果指定多個檔,請用換行符 (CR) 分隔它們。在 Microsoft Excel 中,可以鍵入 Alt+Enter。
*CSV 示例
|
|
如果要刪除附件
如果要刪除附加到附件欄位的所有檔,請將該值留空。
如果要刪除某些附件,請僅保留要保留的檔名。
刪除員工編號為 0006 的記錄的附件且僅刪除員工編號為 0007 的ishikawa-megumi.png附件的 CSV 示例
|
|
步驟6:更新表中的數據
下準備
-
將表的欄位添加到STEP1中創建的App中。
欄位名稱 刪除欄位 欄位代碼 言論 作業資訊 表格 AssignInformation 在表格中,放置「分配日期」和「分配的部門」。 分配日期 日期 AssignDate 清除「將記錄註冊時的日期設置為預設值」複選框。 指定部門 下拉式選單 AssignDivision 為欄位設定以下值: - 研發部
- 總務部
- 銷售部
- 企劃部
- 人事部
-
添加您建立的測試之一。
刷新表中的數據
與
標準檔載入功能類似,表中的數據是通過將單個記錄的內容劃分為多行來創建的。
從*檔的第一列到下一列"*"的行表示單個記錄中的數據。
檔的第一列應命名為」。*
每條記錄的第一行數據的第一列應為"*",其餘部分應為空。
準備CSV檔案
|
|
執行範例
|
|
補充
選項
如果在沒有任何選項的情況下運行它,則會顯示選項清單。
|
|
主要選項
匯入或匯出記錄
選項 | 說明 |
---|---|
--export | 從kintone中獲取數據並匯出為標準輸出。 如果要輸出到檔,請使用重定向,這是OS shell的一項功能。 有關詳細資訊, 請參閱匯出到 檔。 |
--import | 將標準輸入中的數據導入kintone。 如果要從檔案匯入, -f 請同時指定選項。有關更多資訊, 請參閱從 文件導入數據。 |
--export
或者 --import
選項 | 必須 | 說明 |
---|---|---|
-d | 必須 | 網域名 指定域,例如 exmaple.cybozu.com。 如果僅指定子功能變數名稱,則會看到 ".cybozu.com"將自動給出。 |
-a | 必須 | 應用程式ID |
-u | 條件必填項 | 登入名稱 如果要使用密碼進行身份驗證,則為必填項。 |
-p | 條件必填項 | 密碼 如果要使用密碼進行身份驗證,則為必填項。 |
-t | 條件必填項 | API 權杖 如果要使用 API 令牌進行身份驗證,則為必需。 |
-U | 自選 | 基本身份驗證登錄名 |
-P | 自選 | 基本身份驗證的密碼 |
-g | 自選 | 建立訪客空間 |
-o | 自選 | 輸出格式 指定以下值:
|
-e | 自選 | 檔編碼 指定以下值:
|
-q | 自選 | 記錄精簡程式 有關如何編寫條件表達式的更多資訊, 請參見如何 編寫查詢。 如果指定了此選項,並且查詢不包括 limit 或 offset ,則游標 API 將用於檢索記錄。 |
-c | 自選 | 要導出的域代碼 如果要指定多個字段,請用逗號分隔它們。 有關詳細資訊, 請參閱指定 欄位。 |
-f | 自選 | 要匯入的檔的名稱 |
-b | 自選 | 附件資料夾名稱 如果要匯出,請指定要保存附件的資料夾的名稱,如果要導入,請指定放置要按相對路徑上載的檔的資料夾的名稱。 |
-l | 自選 | 導入的起跑線 從指定行導入。 如果省略,則從第一行數據導入。 |
-D | 自選 | 是否要在匯入之前刪除所有現有記錄? |
限制
- 如果設置了IP位址限制,請確保允許存取執行該工具的環境的IP位址。
它不能使用用戶端證書執行 - 每個檔最多可以上傳 10MB 的附件。
- 無法匯出以下欄位:
- 狀態
- 執行者
- 類別
- 相關記錄清單
- 導入到以下欄位不會註冊或更新值。
- 從查找源複製的欄位
- 計算
- 具有自動計算功能的字串(單行)欄位
- 狀態
- 執行者
- 類別
- 建立人
- 建立時間
- 更新人
- 更新時間
- 相關記錄清單
相關提示
修訂記錄
有關詳細資訊, 請參閱 GitHub 上的版本 。
- 2018 年 01 月 10 日 Version 0.9.0
- 正確的使用者代理名稱
- 添加了一個函數,允許您指定導入數據的標準輸入。
- 添加了指定 CSV 匯入起始行的功能。
- 修正了導入過程中 100 行或更多行時未顯示錯誤資訊,而導入過程中每 100 行輸出一次結果的問題。
- 修復基本認證邏輯
- 2018 年 04 月 12 日 Version 0.9.1
- 修復了在對來賓空間中的應用使用以下命令時導致導入失敗的bug
cli-kintone.exe -d {DOMAIN_NAME} -a xx -g xx -t {API_TOKEN} -f {FILE_PATH}
- 修復了在對來賓空間中的應用使用以下命令時導致導入失敗的bug
- 2018 年 05 月 15 日 Version 0.9.2
- 將第三方庫的版本更改為使用指定版本而不是最新版本發佈。
- 2019 年 02 月 27 日 Version 0.9.3
- 如果使用 Shift-JIS 匯出,它將位於匯出檔的欄位中。
- 修復了一個 bug,即如果字段包含無法從 UTF-8 轉換為 Shift-JIS 的字元,則字段的值會移動
- 2019 年 04 月 2 日 Version 0.9.4
- 修復了與具有特殊字元編碼的字串相關的 bug。
- 2019 年 11 月 26 日 Version 0.10.0
- Go 版本從 1.9.3 更新到 1.13.3
-v
或--version
更新以使用獲取工具的版本
- 2019年11月28日 版本0.10.1
- 在沒有要導出的記錄時更改郵件
- 2020 年 02 月 12 日 Version 0.10.2
- 數據採集方法的變更如下
-q
更改為在指定選項時,如果查詢不包含"limit"或"offset",則執行遊標 API- 更改為在查詢包含「limit」或「offset」時執行批量記錄檢索 API
- 將使用者代理名稱更改為以下格式。
cli-kintone/Version(OS Information)
- 更新了自述檔,其中包含有關如何在Mac OS X/Linux和 Windows 上構建和處理數據的說明
- 數據採集方法的變更如下
- 2020 年 03 月 31 日 Version 0.11.0
- 支援以下編碼方案:
- GBK (簡體中文)
- Big5(繁體中文)
- 支援導入 UTF-8(帶 BOM)檔
- 將 Go 版本從 1.13.3 更新到 1.13.7
- 支援以下編碼方案:
- 2020 年 12 月 07 日 Version 0.11.3
- 將 Go 版本從 1.13.7 更新到 1.15.5
- 添加了刪除記錄附件的功能。
- 2022 年 09 月 07 日 Version 0.14.0
- 內部go-kintone版本從v0.4.1更新至v0.4.3
因此,可以導出的欄位會進行一些更改。- 現在,您可以匯出已放置在組欄位中的以下欄位:
- 記錄編號、建立者、建立者、修改者、修改日期和時間
- 不再匯出相關記錄欄位。
- 現在,您可以匯出已放置在組欄位中的以下欄位:
- 內部go-kintone版本從v0.4.1更新至v0.4.3
本文中提供的示例代碼已經過kintone的2022年8月版本和cli-kintone版本0.14.0的測試。