Installation
Two things need to be on your machine: the builder CLI (which ships the engine) and
Bun, the runtime schematics execute in. The SDK itself is added per
project — usually automatically.
This guide was verified against CLI 0.6.0 and SDK 0.2.x.
macOS / Linux
Section titled “macOS / Linux”With Homebrew installed, grab the CLI (the builder binary) from the
tap:
brew install project-builder-schematics/tap/pbuilderThis needs a recent Homebrew — the cask install is verified on Homebrew 6.x; older versions refuse casks on Linux.
No Homebrew at all? Download the per-platform tarball from the
tap’s releases
(pbuilder_<version>_linux_amd64.tar.gz and friends) and put builder on your PATH —
no brew required.
Schematics execute through a Bun sidecar, so Bun must be installed too:
brew install oven-sh/bun/bun # or: curl -fsSL https://bun.sh/install | bashBun is only the schematics’ runtime — your project itself keeps whatever package manager and tooling it already uses (npm, pnpm, yarn, …).
Windows
Section titled “Windows”Windows builds of the CLI are on the roadmap; in the meantime the supported path on Windows is WSL2 (Ubuntu), using the Linux instructions above.
The SDK itself
Section titled “The SDK itself”You normally don’t install it by hand — builder init adds @pbuilder/sdk to your
project’s devDependencies automatically. To add it manually, use whichever package
manager your project already uses:
npm install -D @pbuilder/sdk # or: pnpm add -D / yarn add -D / bun add -dWith the CLI and Bun in place, you’re ready for your first schematic.