zfb
GitHub repository

Type to search...

to open search from anywhere

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.

Note

Don't have Node? You can install zfb as a standalone binary without npm or Node. See Install without Node for curl, Homebrew, and Windows install paths.

Prerequisites

You will need:

  • Node.js ≥ 22 — required by the npm CLI wrapper and by the tsc subprocess that powers zfb check. The default TypeScript config loader itself runs inside zfb's embedded V8 runtime, not Node.

  • pnpm ≥ 10 — install via the official installer. This matches the minimum declared in the published @takazudo/zfb package's engines field; zfb scaffolds projects that use pnpm and will run pnpm install for you when it can find pnpm on your PATH. Contributors building the zfb monorepo itself need a newer pnpm — see From source (contributors) below.

Supported platforms

@takazudo/zfb ships a prebuilt platform binary via npm optional-deps for:

PlatformArchitecturenpm optional dependency
Linux (glibc)x64@takazudo/zfb-linux-x64-gnu
Linux (glibc)arm64@takazudo/zfb-linux-arm64-gnu
macOSx64@takazudo/zfb-darwin-x64
macOSarm64 (Apple Silicon)@takazudo/zfb-darwin-arm64
Windowsx64@takazudo/zfb-win32-x64-msvc

musl/Alpine Linux is not supported yet

No @takazudo/zfb-linux-*-musl package exists. On Alpine (or another musl-based distro), the zfb wrapper detects the musl runtime at startup and exits with a friendly error — musl/Alpine is not supported yet — no @takazudo/zfb-linux-*-musl package exists — instead of the confusing dynamic-loader failure the glibc binary would otherwise produce. Use a glibc-based Linux image (e.g. Debian/Ubuntu) instead.

Install the CLI

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

pnpm add -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

Revision History

CreatedUpdated