home / databases / neon

Neon CLI

Official · Neon
100

CLI for managing Neon Postgres projects, branches, databases, roles, and connection strings.

$brew install neonctl
Language
TypeScript
Stars
100
Category
Databases
Agent
Ready
Agent Compatibility
JSON Output
Agent Skill
MCP Support
AI Analysis

Neon CLI is the shell interface for managing Neon Postgres projects and branch-oriented database workflows. It covers project lifecycle work, branch operations, access controls, and connection setup without relying on the web console.

What It Enables
  • Create, inspect, update, delete, and recover Neon projects, then save default org or project context for follow-up commands.
  • Create, reset, restore, diff, expire, and set default branches, plus add compute and inspect long-running operations.
  • Manage databases, roles, IP allowlists, and VPC endpoint restrictions, then generate branch-specific connection strings or open psql.
Agent Fit
  • Global --output json|yaml|table support makes inspect and mutation commands straightforward to parse in scripts or follow-up agent steps.
  • API key auth, explicit IDs, and saved context files make multi-step inspect/change/verify loops practical.
  • Fresh setups fall back to browser OAuth, and missing org context can trigger interactive prompts, so unattended runs should provide --api-key and explicit scope.
Caveats
  • Default auth opens a browser, and CI explicitly rejects interactive auth.
  • When org context is missing, some project commands can prompt you to choose and optionally save an organization.