PageBridge

Installation

A complete walkthrough of installing and configuring PageBridge for your Sanity project.

Using the monorepo

PageBridge is organized as a Turborepo monorepo. For local development or if you want full control over all packages:

git clone https://github.com/PageBridge-IO/pagebridge.git
cd pagebridge
pnpm install
bash

Start a local PostgreSQL database:

docker compose up -d
bash

Copy the environment template and fill in your values:

cp .env.example .env
bash

Push the database schema and build all packages:

pnpm db:push
pnpm build
bash

Installing individual packages

If you only need specific packages, install them directly:

Sanity plugin

pnpm add @pagebridge/sanity
bash

This adds the Sanity schemas, the SearchPerformancePane component, and the RefreshQueueTool to your Studio. See Sanity plugin setup for full configuration.

CLI

pnpm add -D @pagebridge/cli
bash

The CLI provides the pagebridge command for syncing data, listing sites, and running diagnostics.

Core (programmatic use)

pnpm add @pagebridge/core @pagebridge/db
bash

For custom integrations where you want to call the sync engine, decay detector, or task generator from your own code.

Peer dependencies

The Sanity plugin requires these peer dependencies (which your Sanity project should already have):

  • sanity v5+
  • @sanity/ui v3+
  • @sanity/icons v3+
  • react v19+
  • react-dom v19+

Verify installation

Check that the CLI is available:

pnpm pagebridge --help
bash

List your accessible GSC properties:

pnpm pagebridge list-sites
bash

If the command returns your sites, the Google service account is configured correctly. If not, see Google Service Account setup.

Next steps