跳到主要内容

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 — 当组件的源商店未声明时使用的默认商店 URL。
  • --start-all-components boolean (default: false) — 自动启动 Blocklet 内的所有组件。

子命令

命令说明
install安装开发模式的 Blocklet。
start启动已安装的开发 Blocklet。支持 --e2e 选项。
remove移除开发模式的 Blocklet。
studio启动 Blocklet Studio。
reset重置 Blocklet 的数据。别名：clear。
faucet从水龙头为您的应用提供测试代币。支持 --host 和 --token 选项。

blocklet test

为您的 Blocklet 设置和管理测试环境。

用法

bash
blocklet test [subcommand] [options]

子命令

命令说明
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 — 指定从中获取组件的商店。
  • --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) — 创建源映射（仅限 compact 模式）。
  • --nosources-source-map boolean (default: false) — 创建不包含源内容的源映射（仅限 compact 模式）。
  • --minify / --no-minify boolean (default: true) — 在 compact 模式下启用或禁用代码压缩。
  • --external string — 要从包中排除的外部依赖项的逗号分隔列表。
  • --create-release boolean (default: false) — 为打包的 Blocklet 创建一个发布压缩包和元数据。
  • --create-archive boolean (default: false) — 为打包的 Blocklet 创建一个归档 *.zip 文件。
  • --monorepo boolean (default: false) — 打包一个属于 monorepo 的 Blocklet。
  • --changelog / --no-changelog boolean (default: true) — 在包中包含或排除 CHANGELOG.md。
  • --store-url string — 当组件的源商店未声明时使用的默认商店 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 提交。
  • -f, --force boolean — 强制提升版本，即使是降级。

分发

用于将您的 Blocklet 部署到服务器或上传到商店的命令。

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]

子命令

命令说明
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>

子命令

命令说明
update <app-id>更新指定 Blocklet 的 DID 文档。

blocklet cleanup

为特定的 Blocklet 执行清理任务。

用法

bash
blocklet cleanup [options]

选项

  • --target string — 要清理的目标。可用选项：cache、backup。
  • --app-did string — 要清理的 Blocklet 的 DID。