Skip to main content
Neon Postgres Docs
current

Search documentation

Type to search this documentation.

Neon CLI command: status

Show the branch's live Neon state

The status command shows the branch's live Neon state. It is an alias of neon config status, so it reports the same information without the config prefix.

Bash
neon status [options]
Option Description Type Default Required
--branch Branch ID or name string — No
--config-json Print only the branch's live config as neon.ts-shaped JSON (services + branch tuning + preview), to stdout. Useful for scripting or copying into a neon.ts. boolean false No
--current-branch Print only the linked branch name from the local .neon file (no network). Exits non-zero when no branch is pinned. boolean false No
--project-id Project ID string — No
Bash
neon status
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu