跳到主要內容

blocklet

blocklet 命令是管理 Blocklet 專案整個生命週期的主要介面。它提供了一套完整的子命令，用於初始化、開發、打包、部署和管理 blocklet 及其元件。

全域選項

  • -y, --yes boolean (default: false) — 自動對任何互動式提示回答「是」。這對於腳本和自動化很有用。

專案設定

用於引導和初始化新 Blocklet 專案的命令。

blocklet create

從各種入門模板引導一個新的 Blocklet 專案。

用法

bash
blocklet create [name] [options]

參數

  • [name] string — 新 blocklet 專案的名稱。如果省略，系統將提示您輸入一個。

選項

  • --did string — 為新的 blocklet 指定一個已存在的 DID。
  • --did-only boolean — 僅建立一個 blocklet DID 而不建立專案。

blocklet init

在目前目錄中初始化一個空的 Blocklet 專案。此命令會建立 blocklet.yml 檔案和必要的專案結構。

用法

bash
blocklet init [options]

選項

  • --did [did] string — 為 blocklet 指定一個已存在的 DID。
  • -f, --force boolean (default: false) — 在沒有任何互動式提示的情況下初始化專案。
  • --monikers string — 用於建立 DID 的自訂標識。使用逗號分隔多個值。
  • --connectUrl string — 用於協助生成 DID 的連接 URL。

本地開發

用於在本地環境中執行、測試和偵錯您的 blocklet 的命令。

blocklet dev

從目前目錄以開發模式執行 blocklet，並將其連接到本地的 Blocklet Server。

用法

bash
blocklet dev [subcommand] [options]

選項

  • --open boolean (default: false) — blocklet 啟動後開啟瀏覽器。
  • --app-id string — 將 blocklet 作為元件開發，並將其掛載到指定的應用程式 DID。
  • --mount-point string — 指定在父應用程式中的掛載點。
  • --store-url string — 當元件的來源 store 未聲明時使用的預設 store URL。
  • --start-all-components boolean (default: false) — 自動啟動 blocklet 內的所有元件。

子命令

CommandDescription
install安裝開發模式的 blocklet。
start啟動已安裝的開發 blocklet。支援 --e2e 選項。
remove移除開發模式的 blocklet。
studio啟動 Blocklet Studio。
reset重置 blocklet 的資料。別名：clear。
faucet從水龍頭為您的應用程式提供測試代幣。支援 --host 和 --token 選項。

blocklet test

為您的 blocklet 設定和管理測試環境。

用法

bash
blocklet test [subcommand] [options]

子命令

CommandDescription
init初始化一個新的 blocklet 用於測試。支援 --app-sk、--owner-sk、--app-name 選項。
start啟動測試 blocklet。支援 --app-sk 選項。
remove完全刪除測試 blocklet。支援 --app-sk 選項。
reset重置測試 blocklet 的狀態。支援 --app-sk 選項。

blocklet exec

在 blocklet 的執行上下文中執行一個腳本。

用法

bash
blocklet exec <script> [options]

參數

  • [removed] string (required) — 要執行的腳本的路徑。

選項

  • --app-id string — 在指定的執行中應用程式的上下文中執行腳本。
  • --timeout number — 腳本執行的最長時間（秒）。

blocklet debug

為 blocklet 設定 DEBUG 環境變數。

用法

bash
blocklet debug <value> [options]

參數

  • string (required) — 要設定的偵錯字串（例如 *、my-app:*）。

選項

  • --app-id string — 為指定的應用程式設定偵錯配置。

元件管理

用於管理 blocklet 內元件依賴的命令。

blocklet add

將一個元件作為依賴項新增到您的 blocklet.yml 檔案中。

用法

bash
blocklet add <component> [options]

參數

  • string (required) — 要新增的元件（例如 component-name@1.0.0 或一個 URL）。

選項

  • --profile string (default: default) — 要使用的配置設定檔。
  • --store string — 指定從哪個 store 獲取元件。
  • --title string — 元件的自訂標題。
  • --mount-point string — 元件的掛載點。

blocklet remove

從您的 blocklet.yml 檔案中移除一個元件依賴。

用法

bash
blocklet remove <component>

參數

  • string (required) — 要移除的元件名稱。

blocklet component

從 Component Studio CLI 執行命令。

用法

bash
blocklet component [command...]

此命令作為代理，將所有後續參數傳遞給 @blocklet/component-studio-cli。

打包與版本控制

用於準備您的 blocklet 以進行分發的命令。

blocklet bundle

將您的 blocklet 及其資產打包成一個可部署的套件。

用法

bash
blocklet bundle [options]

選項

  • --zip boolean (default: true) — 使用 zip 模式打包（預設）。
  • --simple boolean (default: false) — 使用 simple 模式打包。
  • --compact boolean (default: false) — 使用 compact 模式打包，包含所有依賴項。
  • --dependencies-depth number (default: 9) — 打包時要包含的依賴項深度。
  • --source-map boolean (default: false) — 建立一個 source map（僅限 compact 模式）。
  • --nosources-source-map boolean (default: false) — 建立一個不包含原始碼內容的 source map（僅限 compact 模式）。
  • --minify / --no-minify boolean (default: true) — 在 compact 模式中啟用或停用最小化。
  • --external string — 要從打包中排除的外部依賴項的逗號分隔列表。
  • --create-release boolean (default: false) — 為打包的 blocklet 建立一個發行 tarball 和元資料。
  • --create-archive boolean (default: false) — 為打包的 blocklet 建立一個 *.zip 存檔檔案。
  • --monorepo boolean (default: false) — 打包一個屬於 monorepo 一部分的 blocklet。
  • --changelog / --no-changelog boolean (default: true) — 在打包中包含或排除 CHANGELOG.md。
  • --store-url string — 當元件的來源 store 未聲明時使用的預設 store URL。

blocklet version

提升 blocklet.yml 中的 blocklet 版本。

用法

bash
blocklet version [newVersion] [options]

參數

  • [newVersion] string (default: patch) — 新版本或增量類型（例如 1.2.3、major、minor、patch）。

選項

  • --git-commit boolean — 提升版本後建立一個 git commit。
  • -f, --force boolean — 強制提升版本，即使是降級。

分發

用於將您的 blocklet 部署到伺服器或上傳到 store 的命令。

blocklet deploy

從本地目錄將一個 blocklet 部署到一個 Blocklet Server 實例。

用法

bash
blocklet deploy <folder> [options]

參數

  • string (required) — 包含已打包 blocklet 的目錄。

選項

  • --endpoint string — 遠端 Blocklet Server 儀表板的端點（例如 http://127.0.0.1/admin）。
  • --access-key string — 用於遠端 Blocklet Server 的存取金鑰。
  • --access-secret string — 用於遠端 Blocklet Server 的存取密鑰。
  • --app-id string — 元件將掛載到的應用程式 DID。
  • --mount-point string — 應用程式內的掛載點。
  • --incremental boolean (default: false) — 僅部署自上一版本以來已變更的檔案。

blocklet upload

將一個打包的 blocklet 上傳到一個 Blocklet Store。

用法

bash
blocklet upload [metafile] [options]

參數

  • [metafile] string — blocklet 的發行元資料檔案路徑（例如 .blocklet/release/blocklet.json）。

選項

  • --profile string (default: default) — 要使用的配置設定檔。
  • --access-token string — 用於 Blocklet Store 的存取權杖。

blocklet connect

將 CLI 連接到 Blocklet Store 並進行身份驗證。

用法

bash
blocklet connect <store-url> [options]

參數

  • string (required) — Blocklet Store 的 URL。

選項

  • --profile string (default: default) — 用於儲存連接詳細資訊的配置設定檔。

工具程式

用於管理配置和元資料的輔助命令。

blocklet config

管理 Blocklet CLI 的本地配置。

用法

bash
blocklet config [subcommand] [key] [value]

子命令

CommandDescription
set [key] [value]設定一個配置值。
get [key]獲取一個配置值。
delete [key]刪除一個配置值。
list列出所有配置值。別名：ls。

blocklet meta

從目前目錄解析並列印 blocklet.yml 元資料。

用法

bash
blocklet meta

blocklet document

管理 blocklet 的 DID 文件。

用法

bash
blocklet document update <app-id>

子命令

CommandDescription
update <app-id>更新指定 blocklet 的 DID 文件。

blocklet cleanup

為特定的 blocklet 執行清理任務。

用法

bash
blocklet cleanup [options]

選項

  • --target string — 要清理的目標。可用選項：cache、backup。
  • --app-did string — 要清理的 blocklet 的 DID。