跳到主要內容

新增元件

blocklet add 命令會將一個新元件作為相依性新增到您的 blocklet 中。它會自動使用必要的配置更新您 blocklet.yml 檔案中的 components 部分。

此命令透過從指定的 blocklet store 或直接的 URL 取得元件的元資料，簡化了相依性管理，確保所有必要資訊都正確地新增到您的專案配置中。

命令語法

add 命令的基本語法如下：

bash
blocklet add <component> [options]

參數

  • string (required) — 您想新增的元件的識別碼。可以透過以下幾種格式指定： - 依名稱和版本：component-name@1.2.3。如果省略版本（例如，component-name），則預設為 latest。 - 依 DID：z8...（blocklet 的去中心化識別碼）。 - 依 URL：指向元件 blocklet.json 元資料檔案的直接 URL（例如，https://example.com/path/to/blocklet.json）。

選項

以下選項可用於自訂元件的新增方式：

  • --store string — 指定要搜尋元件的 blocklet store 的 URL。如果未提供，此命令將使用您 Blocklet CLI 設定檔中配置的 store，若無則退回使用預設的官方 blocklet store。
  • --title string — 在您的 blocklet.yml 中為元件設定自訂標題。如果省略，將使用元件自身元資料中的標題。
  • --mount-point string — 定義元件將被掛載的 URL 路徑。如果未指定，將根據元件名稱的 URL 友好版本產生預設掛載點（例如，/component-name）。
  • --profile string — 選擇要用於設定（例如預設 blocklet store）的特定配置設定檔。

使用範例

以下是一些如何使用 blocklet add 命令的實際範例。

從預設 Store 新增元件

要從預設的 blocklet store 新增名為 did-wallet 的元件的最新版本：

bash
blocklet add did-wallet

要新增元件的特定版本：

bash
blocklet add did-wallet@1.6.0

執行此命令後，您的 blocklet.yml 將會更新，新增一筆類似這樣的條目：

yaml
# blocklet.yml
components:
  - name: did-wallet
    title: DID Wallet
    mountPoint: /did-wallet
    source:
      store: 'https://store.blocklet.dev'
      name: did-wallet
      version: 1.6.0

從 URL 新增元件

如果元件不在 store 中，您可以直接從其元資料 URL 新增。

bash
blocklet add https://github.com/arcblock/did-wallet/releases/download/v1.6.25/blocklet.json

這將在您的 blocklet.yml 中新增一筆直接指向該 URL 的條目：

yaml
# blocklet.yml
components:
  - name: did-wallet
    title: DID Wallet
    mountPoint: /did-wallet
    source:
      url: 'https://github.com/arcblock/did-wallet/releases/download/v1.6.25/blocklet.json'

使用自訂選項新增元件

您可以覆寫元件的預設標題和掛載點。

bash
blocklet add did-wallet --title "My Custom Wallet" --mount-point "/my-wallet"

blocklet.yml 中的最終配置將反映這些自訂值：

yaml
# blocklet.yml
components:
  - name: did-wallet
    title: My Custom Wallet
    mountPoint: /my-wallet
    source:
      store: 'https://store.blocklet.dev'
      name: did-wallet
      version: latest

總結

blocklet add 命令是管理您 blocklet 專案中相依性的關鍵工具。它會自動更新您的 blocklet.yml 檔案，確保一致性並減少手動錯誤的機會。若要移除相依性，您可以使用對應的 blocklet remove 命令。