Skip to content
pbkit

Install pbkit

How to install pbkit in your project.

Prerequisites

Section titled “Prerequisites”
  • Bun >= 1.3
  • A PocketBase instance or an exported schema JSON file

Install

Section titled “Install”

pbkit is a build-time code generator, so install it as a dev dependency. Keep pocketbase as a regular dependency — your app uses its SDK at runtime.

Terminal window
bun add -d @karnak19/pbkit
bun add pocketbase

Verify

Section titled “Verify”
Terminal window
bunx pbkit --help

You should see:

pbkit — PocketBase code generation toolkit


Usage:
  pbkit generate [--config <path>] [--watch]
  pbkit --help

Next steps

Section titled “Next steps”
Docs Reference

Tutorials

Your first typed SDK

How-to Guides

Install pbkit Configure collections Add TanStack Query Add Zod schemas Add realtime subscriptions Write a plugin Migrating from pocketbase-typegen Manage schema from the CLI

Reference

CLI Configuration Generated types Generated SDK Field type mapping Expand types Programmatic API

Explanation

How pbkit works The generated files Relations and expand paths Why a generated SDK