neonctl

Neon offers several methods for working with your projects. Utilizing the Neon Command Line Interface (CLI), you can operate Neon directly from a terminal or via automation. The Neon CLI facilitates numerous functions, such as Neon authentication, project creation and management, and more.

Synopsis

The neonctl command can be called from command line. Without any arguments, it displays command usage and help:

usage: neonctl <cmd> [args]

Commands:
  neonctl auth                Authenticate
  neonctl projects [command]  Manage projects
  neonctl me                  Show current user
  neonctl branches            Manage branches

Options:
      --version     Show version number                                [boolean]
      --help        Show help                                          [boolean]
  -o, --output      Set output format
                  [string] [choices: "json", "yaml", "table"] [default: "table"]
      --api-host    The API host   [default: "https://console.neon.tech/api/v2"]
      --config-dir  Path to config directory
                              [string] [default: "/home/eduard/.config/neonctl"]
      --oauth-host  URL to Neon OAUTH host [default: "https://oauth2.neon.tech"]
      --client-id   OAuth client id                [string] [default: "neonctl"]
      --api-key     API key                               [string] [default: ""]

Install the Neon CLI

This topic describes how to install the neonctl command-line interface tool and connect to Neon.

Prerequisites

• Node.js 16.0 or higher. To check if you already have Node.js, run the following command:

  node -v
  

• The npm package manager. To check if you already have npm, run the following command:

  npm -v
  

If you need to install either Node.js or npm, refer to instructions on official nodejs page or you can use Node version manager.

Install

To download and install Neon CLI, run the following command:

npm i -g neonctl

Connect

To authenticate to Neon, run the following command:

neonctl auth

The command launches a browser window where you can authorize the Neon CLI to access your Neon account. After granting permission, your credentials are saved locally to a credentials file.

Commands

neonctl auth

Authenticates the user or caller to Neon. See Connect.

neonctl me

Returns information about the authenticated user.

$> neonctl me
┌────────────────┬──────────────────────────┬────────────┬────────────────┐
│ Login          │ Email                    │ Name       │ Projects Limit │
├────────────────┼──────────────────────────┼────────────┼────────────────┤
│ user1          │ [e-mail]        │ User1      │ 1              │
└────────────────┴──────────────────────────┴────────────┴────────────────┘

neonctl projects

For creating and managing Neon projects.

neonctl branches

For creating and managing Neon branches.

Options

version

Shows the neonctl version number

help

Shows the neonctl command-line help

output, o

Sets the output format.

api-host

Shows the API host

config-dir

Sets the path to the neonctl configuration directory

oauth-host

Sets the URL of Neon OAuth host

client-id

Sets the OAuth client id

api-key

Sets the API key