Skip to Content
Run Payne locally

Run Payne locally

The shortest path starts with the locally run simulation. Choose local-live when you need PostgreSQL-backed state and current evidence from the bundled DataHub scenario. Run every command below from the repository root.

Run the local simulation

Prerequisites: Node.js 22 or 24 LTS and pnpm 11. This path does not require an environment file, Docker, DataHub, PostgreSQL, or an inference provider.

CommandRun from the repository root
pnpm install --frozen-lockfile

CommandRun from the repository root
pnpm dev

Run local-live

Prerequisites: Docker Engine with Compose v2, 2 CPU, 8 GB RAM, 13 GB free disk, and the fixed ports 3000, 4310, 8080, and 9002 available. This profile creates Payne- and DataHub-owned containers, networks, and named volumes. It is for local development and evaluation only.

CommandRun from the repository root
cp .env.local-live.example .env.local-live

Replace the local-only example credentials before sharing or exposing the stack. Never use a NEXT_PUBLIC_ variable for a token, database URL, or provider key.

CommandRun from the repository root
pnpm local:up

Payne uses the current actor from the connected local DataHub instance. It does not add a separate user account. The current actor must match the accountable owner before Payne can record an acceptance or authorize the bounded write-back.

CommandRun from the repository root
pnpm db:seed

CommandRun from the repository root
pnpm local:verify

Continue with Create your first Shutdown Gate. If a service is unavailable, start at Troubleshooting rather than resetting the stack.

Before a repeatable rehearsal, use the deterministic reset. It names the Payne Compose project and every local volume it removes before doing any cleanup:

CommandRun from the repository root with .env.local-live configured
pnpm local:reset

Last updated on