インストール
zfb CLI を npm からインストールする。
@takazudo/zfb は npm パッケージとして配布され、npm の optional-deps 経由でビルド済みのプラットフォームバイナリを取得します。Rust ツールチェインは不要です。
Note
Node がない場合は? npm や Node なしでも、zfb をスタンドアロンバイナリとしてインストールできます。curl・Homebrew・Windows でのインストール手順は Install without Node を参照してください。
前提条件
以下が必要です。
Node.js ≥ 22 — npm CLI ラッパーと、
zfb checkを支えるtscサブプロセスに必要です。デフォルトの TypeScript 設定ローダー自体は Node ではなく、zfb の組み込み V8 ランタイム内で動きます。pnpm ≥ 10 — 公式インストーラー からインストールしてください。これは公開されている
@takazudo/zfbパッケージのenginesフィールドで宣言されている最小バージョンと一致します。zfb は pnpm を使うプロジェクトをスキャフォールドし、PATH上に pnpm が見つかる場合はpnpm installを自動で実行します。zfb モノレポ本体をビルドするコントリビューターは、より新しい pnpm が必要です — 下記の「ソースからビルドする(コントリビューター向け)」の節を参照してください。
サポートされているプラットフォーム
@takazudo/zfb は npm の optional-deps 経由で、以下のプラットフォーム向けにビルド済みバイナリを配布しています。
| プラットフォーム | アーキテクチャ | npm optional dependency |
|---|---|---|
| Linux(glibc) | x64 | @takazudo/zfb-linux-x64-gnu |
| Linux(glibc) | arm64 | @takazudo/zfb-linux-arm64-gnu |
| macOS | x64 | @takazudo/zfb-darwin-x64 |
| macOS | arm64(Apple Silicon) | @takazudo/zfb-darwin-arm64 |
| Windows | x64 | @takazudo/zfb-win32-x64-msvc |
musl / Alpine Linux はまだ未対応です
@takazudo/zfb-linux-*-musl パッケージは存在しません。Alpine(などの musl 系 ディストリビューション)では、zfb ラッパーが起動時に musl ランタイムを検出し、 glibc バイナリが引き起こすであろう分かりにくいダイナミックローダーのエラーの代わりに、musl/という分かりやすいエラーで終了します。glibc ベースの Linux イメージ(例: Debian/Ubuntu)を使ってください。
CLI のインストール
@takazudo/zfb をプロジェクトの開発依存としてインストールします。
pnpm add -D @takazudo/zfbnpm install -D @takazudo/zfbインストールの確認
npx zfb --help5 つのサブコマンドが表示されるはずです。
zfb new— 新しいプロジェクトをスキャフォールドするzfb dev— ウォッチャーとライブリロード付きの開発サーバーを起動するzfb build— 静的ビルドを生成するzfb preview— ビルド出力を配信するzfb check— プロジェクトを型チェックし、コンテンツコレクションをスキーマに照らして検証する
npx zfb --help で 5 つすべてが表示されれば、Your first site に進む準備ができています。
ソースからビルドする(コントリビューター向け)
zfb 本体にコントリビュートしていて CLI をソースからビルドする必要がある場合は、Rust ツールチェインの前提条件を含む詳しい手順を BUILDING.md で確認してください。
最短の手順:
git clone https://github.com/Takazudo/zudo-front-builder.git
cd zudo-front-builder
cargo install --path crates/zfb