plugin-uploader

information

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

目錄

關於plugin-uploader

plugin-uploader是CLI工具,可以添加外掛程式檔到kintone中。

它以npm包的形式提供,因此可以在Windows/macOS/Linux環境中使用。

GitHub

https://github.com/kintone/js-sdk/tree/main/packages/plugin-uploader (External link)

授權

MIT授權 (External link)

文件

https://github.com/kintone/js-sdk/blob/main/packages/plugin-uploader/README.md (External link)

事先準備

要運行plugin-uploader,您需要Node.js和npm(一個包管理工具)。
安裝Node.js時,會自動安裝npm。

  1. Node.js從官方網站下載安裝程式。
    Node.js官方網站 (External link)
    對於所需的Node.js版本,請檢查以下存儲庫中的engines屬性。
    packages/plugin-uploader/package.json (External link)
    例如,以下要求Node.js版本14或更高版本。

    1
    2
    3
    
    "engines": {
      "node": ">=14"
    },
  2. 運行下載的安裝程式並按照畫面上的說明進行設置。

Quickstart

Step1:安裝所需的套件

安裝plugin-uploader。
下面是一個如何全域安裝外掛程式上傳器的示例。

1
npminstall-g@kintone/plugin-uploader

Step2:準備外掛程式檔

準備要添加到kintone的外掛程式檔。
本快速入門使用在plugin-packer快速入門中創建的外掛程式檔。

Step3:添加外掛程式至kintone

使用以下命令向kintone添加外掛程式檔。
在kintone中添加外掛程式檔時,必須具有kintone系統管理員權限。
kintone的系統管理員 (External link)
變更以下值以適合您的環境:

  • sample.cybozu.com:需要申請的kintone網域名稱
  • 登入名稱:kintone登入名
1
kintone-plugin-uploader --base-url https://examle.cybozu.com --username 登入名 plugin.zip

系統將提示您輸入密碼。
輸入kintone密碼后,按Enter鍵。

1
? 請輸入密碼: [hidden] [input is hidden]

Step4:確認動作

  1. 打開kintone的管理畫面。

  2. 點擊「其他」下的【外掛程式】。

  3. 在「導入的外掛程式」中,確保已添加示例外掛程式。

補充

與plugin-packer集成

若果可打包成外掛程式的plugin-packer和plugin-uploader組合使用,可在修改原始程式碼時自動打包外掛程式並上傳到kintone。
plugin-packer

  1. 打開終端軟體。

  2. 切換到外掛程式檔所在的目錄。

    1
    
    cd sample_plugin_project
  3. 使用--watch該選項運行plugin-packer。

    1
    
    kintone-plugin-packer --watch src --ppk 私鑰檔案.ppk
  4. 另外開啟一個新的終端軟體。

  5. 切換到外掛程式檔所在的目錄。

    1
    
    cd sample_plugin_project
  6. 指定選項,運行plugin-uploader--watch

    1
    
    kintone-plugin-uploader --watch plugin.zip

修訂記錄

確認CHANGELOG以獲取plugin-uploader的更新日誌。
CHANGELOG (External link)

information

本文中給出的示例代碼已經過kintone的2022年5月版本和@kintone/plugin-uploaderv7.0.0的測試。