Installation

Install the zfb CLI from npm.

@takazudo/zfb ships as an npm package that pulls a prebuilt platform binary via npm optional-deps — no Rust toolchain required.

Prerequisites

You will need:

• Node.js ≥ 22 — the config loader and some build steps invoke Node.

• pnpm — install via the official installer. zfb scaffolds projects that use pnpm and will run pnpm install for you when it can find pnpm on your PATH.

Install the CLI

Install @takazudo/zfb as a dev dependency in your project:

pnpm add -D @takazudo/zfb

npm install -D @takazudo/zfb

Verify the install

npx zfb --help

You should see five subcommands:

• zfb new — scaffold a new project

• zfb dev — start the dev server with watcher and live-reload

• zfb build — produce a static build

• zfb preview — serve the build output

• zfb check — typecheck the project and validate content collections against their schemas

If npx zfb --help prints all five, you're ready to move on to Your first site.

From source (contributors)

If you are contributing to zfb itself and need to build the CLI from source, see BUILDING.md for full instructions including the Rust toolchain prerequisites.

The short path:

git clone https://github.com/Takazudo/zudo-front-builder.git
cd zudo-front-builder
cargo install --path crates/zfb