@neondatabase/config-runtime

@neon/config-runtime

Imperative runtime for @neon/config: run a neon.ts policy against the Neon API — inspect, plan, apply (push/pull) — and bundle + deploy Neon Functions.

This package pulls in esbuild, so import it from your CLI or CI — not from a neon.ts policy. Keep policies side-effect-free; that's what @neon/config is for. New code should import from @neon/config-runtime/v1 to pin a major.

Install

npm install @neon/config-runtime

Requirements: Node.js >= 20.19.

API

• inspect / plan / apply — read the current branch state, diff a policy against it, and apply the changes.
• pullConfig / pushConfig — lower-level pull/push primitives.
• createBranch — create a branch to target.
• buildFunctionBundle — bundle Neon Functions for deploy.

import { inspect, plan, apply } from "@neon/config-runtime/v1";

See @neon/config for authoring the neon.ts policy these operate on.