コンテンツへスキップ

追加

シェル
npx blockstudio add <blocks...> [options]

レジストリからブロックをダウンロードし、プロジェクトのブロックディレクトリに書き込みます。

引数

引数 説明
blocks 追加する1つ以上のブロック。形式はnamespace/blockまたはblockです。

オプション

オプション 説明
-y, --yes すべての確認(上書き、競合解決)を省略します。
--dry-run ファイルを書き込まず、インストール内容をプレビューします。

名前空間の解決

名前空間を指定すると、CLIは指定されたレジストリを検索します。

シェル
npx blockstudio add ui/tabs

名前空間を省略すると、CLIは設定済みのすべてのレジストリを検索します。

シェル
npx blockstudio add tabs

ブロックが1つのレジストリだけで見つかった場合は、自動的にそのレジストリが使われます。複数で見つかった場合は、CLIが選択用の対話プロンプトを表示します。

--yesを指定すると、blocks.jsonの順で最初に一致したレジストリが使われます。ターミナルがなく、--dry-runが指定されている場合、名前が曖昧だと、該当するレジストリの一覧を含むエラーを表示してコマンドを終了します。

コード
Block "hero" found in multiple registries: acme, starter. Specify one: blockstudio add acme/hero

ブロックを解決する前に、addは設定済みのすべてのレジストリを取得します。レジストリのいずれかに接続できない、または無効な場合、名前空間を明示したブロックでもコマンドは失敗します。

依存関係

ブロックは、同じレジストリ内の別のブロックへの依存関係を宣言できます。ブロックを追加すると、依存関係が解決され、自動的にインストールされます。

シェル
npx blockstudio add ui/tabs

tabsがtab-itemに依存している場合、両方のブロックがダウンロードされてインストールされます。依存先のブロックは、必ず依存元より先にインストールされます。

循環依存は検出され、エラーとして拒否されます。

上書きの動作

対象のディレクトリにブロックのフォルダーがすでに存在する場合:

  • 対話モード: 上書きするか確認します
  • --yes フラグ: 確認せずに上書きします
  • --dry-run フラグ: 上書きされる内容を表示します
  • --yes を指定しない非対話モード: ダウンロード前に停止し、 Block "<name>" already exists at <path>. Use --yes to overwrite. を表示します

依存関係もチェックされるため、tab-item がすでにインストールされている状態で tabs を追加するには、--yes が必要です。

複数のブロック

1つのコマンドで指定したブロックは順番に処理されます。いずれかが失敗すると、その時点でコマンドは停止します。同じ実行中に先にインストールされたブロックは、ディスク上に残ります。

例

ブロックを1つ追加する:

シェル
npx blockstudio add ui/hero

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

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

書き込みせずにプレビューする:

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

すべてのプロンプトをスキップする:

シェル
npx blockstudio add ui/tabs --yes