コンテンツへスキップ

はじめに

前提条件

  • Node.js 18 以上
  • ブロックをインストールする WordPress のテーマまたはプラグイン

blockstudio の npm パッケージはバージョン 0.0.1 です。このリリースは仮のもので、Adding block: <name> を表示して何も取得せずに終了する add コマンドしかありません。また、init、list、search、remove、--yes、--dry-run は不明なコマンドとして拒否されます。このページに記載されたコマンドは、Blockstudio リポジトリ (packages/registry) にあるレジストリ CLI のものです。

プロジェクトを初期化する

テーマまたはプラグインのルートで init を実行します:

シェル
npx blockstudio init

CLI が対話形式でセットアップを案内します:

  1. ブロックディレクトリ: ブロックのインストール先 (既定値: blockstudio)
  2. レジストリ: 名前を付けて1つ以上のレジストリ URL を追加

これにより、blocks.json ファイルが作成されます:

JSON
{
  "$schema": "https://blockstudio.dev/schema/blocks.json",
  "directory": "blockstudio",
  "registries": {
    "ui": "https://blocks.example.com/registry.json"
  }
}

対話形式のプロンプトをスキップすることもできます:

シェル
npx blockstudio init --yes

既定値を使って blocks.json を作成します。作成後に手動で編集できます。

ブロックを追加する

シェル
npx blockstudio add ui/tabs

形式は namespace/block です。namespace は registries 設定内のキーに一致します。

CLI は次の処理を行います:

  1. レジストリを取得する
  2. ブロックを見つける
  3. 依存関係を解決する (e.g。tabs は tab-item に依存)
  4. すべてのファイルをダウンロードする
  5. ブロックディレクトリに書き込む

ブロックが1つのレジストリにしか存在しない場合は、名前空間を省略できます:

シェル
npx blockstudio add tabs

複数のレジストリに存在する場合、ターミナルでは CLI が選択を求めます。ターミナルがない場合は、一致したレジストリを列挙したエラーで停止し、--yes は blocks.json 順で最初のものを選びます。

複数のブロックを追加する

シェル
npx blockstudio add ui/tabs ui/hero ui/accordion

すべてのブロックが1回の実行でインストールされます。

インストール前にプレビューする

シェル
npx blockstudio add ui/tabs --dry-run

ファイルを書き込まずに、インストールされる内容を確認できます。

利用可能なブロックを閲覧する

シェル
npx blockstudio list
npx blockstudio list ui
npx blockstudio search hero

list はすべてのレジストリ (または特定のレジストリ) のブロックを表示します。search はブロック名、タイトル、説明を対象に、大文字と小文字を区別しない部分一致検索を行います。

ブロックを削除する

シェル
npx blockstudio remove tabs

ブロックのフォルダーを削除します。対話モードでは確認を求められます。--yes を指定すると、確認をスキップできます。

CI と自動化

init、add、remove は --yes を指定すると、対話形式のプロンプトをスキップします。list と search はプロンプトを表示せず、--yes を不明なオプションとして拒否します。標準入力がターミナルでない場合 (CI ランナーやパイプ入力など)、CLI は非対話モードに切り替わります。この場合、init は既存の blocks.json を上書きし、add はブロックフォルダーがすでに存在する場合、またはブロック名が曖昧な場合にエラーで停止し、remove は確認なしで削除します。

シェル
npx blockstudio init --yes --directory blockstudio
npx blockstudio add ui/tabs --yes
npx blockstudio remove tabs --yes