neon config status, plan, apply, and deploy reconcile neon.ts policies
Introduced 2026-06-09 · score 0.97
HOW TO USE IT
When reconciling a branch from a repository policy, define the policy in `neon.ts`; run `neon config status` to inspect it, `neon config plan` to preview changes, and `neon config apply` (or `neon deploy`) to apply them.
neon config status [--project-id <id>] [--branch <id|name>] [--config <path>]neon config plan [--project-id <id>] [--branch <id|name>] [--config <path>]neon config apply [--project-id <id>] [--branch <id|name>] [--config <path>] [--update-existing] [--allow-protected]WHY THIS HELPS
Inspect or reconcile a Neon branch's desired state from a repository policy.
REQUIREMENTS AND LIMITATIONS
- Version: v2.24.0
- --project-id <id>: Selects the project; otherwise the closest `.neon` file’s `projectId` is used, then a sole project accessible to the API key is auto-detected.
- projectId: Project ID in the closest `.neon` file; used after `--project-id`.
- --branch <id|name>: Selects a branch; defaults to the project’s default branch.
- --config <path>: Selects the policy file; otherwise neonctl walks up from the current directory for `neon.ts`.
- --update-existing: For apply/deploy, auto-confirms overriding existing remote settings; without it, drift in compute, TTL, or `protected` is a conflict and apply makes no changes.
- --allow-protected: For apply/deploy, auto-confirms applying to a branch Neon marks protected.
- --env <path>: Not documented in the v2.24.0 README; details not found.
- Prerequisite: Install neonctl; the README lists Node.js 18.0 or higher for npm installation.
- Prerequisite: Authenticate with `neonctl auth` or provide an API key with `--api-key`.
- Without `--update-existing`, drift on settings already present remotely (compute, TTL, `protected`) is reported as a conflict and apply makes no changes until resolved or the flag is passed.
- If the API key maps to exactly one project, that project is auto-detected when project resolution remains unresolved.
- The branch defaults to the project's default branch when `--branch` is omitted.
- The policy can include Preview features such as Functions and buckets.
FIRST-PARTY EVIDENCE
- https://github.com/neondatabase/neonctl/releases/tag/v2.24.0
- https://github.com/neondatabase/neonctl/pull/518
- https://github.com/neondatabase/neonctl/blob/v2.24.0/README.md
Check the installed version and the source before using it. Entry JSON