All apps/Neon CLI

Neon CLI

neonctl

The Neon CLI brings the Neon backend platform to your terminal.

Runs as neonctl|macOS, Linux, Windows|github.com

Command form

ai-draft · 2 tasks · 6 fields

Global options only; use the psql subcommand to open a psql session on a branch.

Opens the form; the finished command lands at your prompt, unrun
otty gui neonctl

neonctl psql

Open psql on a branch

Connect to a Neon branch with psql. Arguments for psql after -- are left out.

Open psql on a branchExample values, fixed in this page — nothing here reaches a terminal
Basic
Project ID
string
TasksEach one presets the form for one job
Default branch
project_id
Named branch
branchproject_idpooled
ParametersOnly these flags are editable in the form
Branch
Branch name, or branch@timestamp / branch@lsn. Leave empty for the default branch.
string · positional 0
Project ID
string
--project-id
Role
string
--role-name
Database
string
--database-name
Pooled connection
boolean
--pooled
Endpoint type
enum
--endpoint-typeread_onlyread_write
SourcesEvery flag above is checked against these
help
`neonctl psql [branch]` opens a psql session against a branch. neonctl psql main # a specific branch neonctl psql --pooled # use the pooled connection Options: `--project-id`, `--role-name`, `--database-name`, `--pooled`, `--endpoint-type` (`read_only` | `read_write`), `--ssl`, plus the [global options]…
manualHEAD 2026-10

raw.githubusercontent.com

Before it fills your prompt, Otty checks the installed neonctl against its version. A form that does not match your version is not offered.