← Back to CLIs
Melvynx

neon

Manage Neon Serverless Postgres via CLI - projects, branches, databases, roles, endpoints, connection strings. Use when user mentions 'neon', 'neonctl', 'serverless postgres', or wants to manage Neon databases.

Install

$ npx api2cli install neon

Details

Skill type: Official CLI
Auth type: bearer
Version: 1.0.0
Author: Melvynx
Views: 0

README

neon

Setup

npm i -g neonctl

Verify installation:

neonctl --version

Always use --output json flag when calling commands programmatically.

Authentication

neonctl auth

Resources

Projects

CommandDescription
neonctl projects listList all projects
neonctl projects create --name <name>Create a new project
neonctl projects delete <id>Delete a project
neonctl projects get <id>Get project details

Branches

CommandDescription
neonctl branches list --project-id <id>List all branches
neonctl branches create --project-id <id> --name <name>Create a branch
neonctl branches delete <branch-id> --project-id <id>Delete a branch
neonctl branches get <branch-id> --project-id <id>Get branch details
neonctl branches reset <branch-id> --project-id <id> --parentReset branch to parent

Databases

CommandDescription
neonctl databases list --project-id <id> --branch-id <id>List databases
neonctl databases create --project-id <id> --branch-id <id> --name <name>Create a database
neonctl databases delete <name> --project-id <id> --branch-id <id>Delete a database

Roles

CommandDescription
neonctl roles list --project-id <id>List all roles
neonctl roles create --project-id <id> --branch-id <id> --name <name>Create a role
neonctl roles delete <name> --project-id <id> --branch-id <id>Delete a role

Endpoints

CommandDescription
neonctl endpoints list --project-id <id>List all endpoints

Connection Strings

CommandDescription
neonctl connection-string --project-id <id>Get default connection string
neonctl connection-string --project-id <id> --branch-id <id>Get connection string for a branch
neonctl connection-string --project-id <id> --branch-id <id> --database-name <db> --role-name <role>Get connection string with specific db and role

Context

CommandDescription
neonctl set-context --project-id <id>Set project context to avoid passing --project-id

Global Flags

FlagDescription
--output jsonOutput result as JSON
--project-id <id>Specify project ID
--api-key <key>Use API key for authentication
--no-colorDisable colored output
Sponsors