blockletコマンドは、Blockletプロジェクトのライフサイクル全体を管理するための主要なインターフェースです。blockletとそのコンポーネントの初期化、開発、バンドル、デプロイ、管理のための包括的なサブコマンド群を提供します。
グローバルオプション
- -y, --yes
boolean(default:false) — すべての対話型プロンプトに自動的に「はい」と回答します。これはスクリプトや自動化に便利です。
プロジェクトのセットアップ
新規Blockletプロジェクトをブートストラップおよび初期化するためのコマンド。
blocklet create
さまざまなスターターテンプレートから新しいBlockletプロジェクトをブートストラップします。
使用法
blocklet create [name] [options]引数
- [name]
string— 新しいblockletプロジェクトの名前。省略した場合は、入力を求められます。
オプション
- --did
string— 新しいblockletに既存のDIDを指定します。 - --did-only
boolean— プロジェクトを作成せずに、blockletのDIDのみを作成します。
blocklet init
現在のディレクトリに空のBlockletプロジェクトを初期化します。このコマンドはblocklet.ymlファイルと基本的なプロジェクト構造を作成します。
使用法
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に接続します。
使用法
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内のすべてのコンポーネントを自動的に起動します。
サブコマンド
| Command | Description |
|---|---|
install | 開発モードのblockletをインストールします。 |
start | インストール後に開発用blockletを起動します。--e2eオプションをサポートします。 |
remove | 開発モードのblockletを削除します。 |
studio | Blocklet Studioを起動します。 |
reset | blockletのデータをリセットします。エイリアス: clear。 |
faucet | フォーセットからテストトークンでアプリに資金を供給します。--hostと--tokenオプションをサポートします。 |
blocklet test
blockletのテスト環境をセットアップおよび管理します。
使用法
blocklet test [subcommand] [options]サブコマンド
| Command | Description |
|---|---|
init | テスト用の新しいblockletを初期化します。--app-sk、--owner-sk、--app-nameオプションをサポートします。 |
start | テスト用blockletを起動します。--app-skオプションをサポートします。 |
remove | テスト用blockletを完全に削除します。--app-skオプションをサポートします。 |
reset | テスト用blockletの状態をリセットします。--app-skオプションをサポートします。 |
blocklet exec
実行中のblockletのコンテキスト内でスクリプトを実行します。
使用法
blocklet exec <script> [options]引数
- [removed]
string(required) — 実行するスクリプトへのパス。
オプション
- --app-id
string— 指定された実行中のアプリケーションのコンテキスト内でスクリプトを実行します。 - --timeout
number— スクリプトが実行される最大時間（秒）。
blocklet debug
blockletのDEBUG環境変数を設定します。
使用法
blocklet debug <value> [options]引数
-
string(required) — 設定するデバッグ文字列（例：*、my-app:*）。
オプション
- --app-id
string— 指定されたアプリケーションのデバッグ設定を行います。
コンポーネント管理
blocklet内のコンポーネント依存関係を管理するためのコマンド。
blocklet add
コンポーネントを依存関係としてblocklet.ymlファイルに追加します。
使用法
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ファイルからコンポーネントの依存関係を削除します。
使用法
blocklet remove <component>引数
-
string(required) — 削除するコンポーネントの名前。
blocklet component
Component Studio CLIからコマンドを実行します。
使用法
blocklet component [command...]このコマンドはプロキシとして機能し、後続のすべての引数を@blocklet/component-studio-cliに渡します。
パッケージングとバージョニング
配布用にblockletを準備するためのコマンド。
blocklet bundle
blockletとそのアセットをデプロイ可能なバンドルにパッケージ化します。
使用法
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のリリース用tarballとメタデータを作成します。 - --create-archive
boolean(default:false) — バンドルされたblockletのアーカイブ*.zipファイルを作成します。 - --monorepo
boolean(default:false) — モノレポの一部であるblockletをバンドルします。 - --changelog / --no-changelog
boolean(default:true) — バンドルにCHANGELOG.mdを含めるか除外します。 - --store-url
string— コンポーネントのソースストアが宣言されていない場合に使用するデフォルトのストアURL。
blocklet version
blocklet.yml内のblockletのバージョンを上げます。
使用法
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 Serverインスタンスにblockletをデプロイします。
使用法
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にアップロードします。
使用法
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に接続し、認証します。
使用法
blocklet connect <store-url> [options]引数
-
string(required) — Blocklet StoreのURL。
オプション
- --profile
string(default:default) — 接続詳細を保存するために使用する設定プロファイル。
ユーティリティ
設定とメタデータを管理するためのヘルパーコマンド。
blocklet config
Blocklet CLIのローカル設定を管理します。
使用法
blocklet config [subcommand] [key] [value]サブコマンド
| Command | Description |
|---|---|
set [key] [value] | 設定値を設定します。 |
get [key] | 設定値を取得します。 |
delete [key] | 設定値を削除します。 |
list | すべての設定値を一覧表示します。エイリアス: ls。 |
blocklet meta
現在のディレクトリからblocklet.ymlのメタデータを解析して表示します。
使用法
blocklet metablocklet document
blockletのDIDドキュメントを管理します。
使用法
blocklet document update <app-id>サブコマンド
| Command | Description |
|---|---|
update <app-id> | 指定されたblockletのDIDドキュメントを更新します。 |
blocklet cleanup
特定のblockletのクリーンアップタスクを実行します。
使用法
blocklet cleanup [options]オプション
- --target
string— クリーンアップするターゲット。利用可能なオプション：cache、backup。 - --app-did
string— クリーンアップするblockletのDID。