Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neondatabase/neonctl
Neon CLI tool. The Neon CLI is a command-line interface that lets you manage Neon Serverless Postgres directly from the terminal.
https://github.com/neondatabase/neonctl
cli database postgres postgresql serverless
Last synced: 2 days ago
JSON representation
Neon CLI tool. The Neon CLI is a command-line interface that lets you manage Neon Serverless Postgres directly from the terminal.
- Host: GitHub
- URL: https://github.com/neondatabase/neonctl
- Owner: neondatabase
- License: apache-2.0
- Created: 2022-08-27T10:10:24.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-15T16:01:05.000Z (7 months ago)
- Last Synced: 2024-04-17T01:32:07.404Z (7 months ago)
- Topics: cli, database, postgres, postgresql, serverless
- Language: TypeScript
- Homepage: https://neon.tech/docs/reference/neon-cli
- Size: 1.24 MB
- Stars: 34
- Watchers: 9
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
The Neon CLI is a command-line interface that lets you manage [Neon Serverless Postgres](https://neon.tech/) directly from the terminal. For the complete documentation, see [Neon CLI](https://neon.tech/docs/reference/neon-cli).
## Install the Neon CLI
**npm**
```shell
npm i -g neonctl
```
Requires Node.js 18.0 or higher.
**Howebrew**
```shell
brew install neonctl
```
**Binary (macOS, Linux, Windows)**
Download a binary file [here](https://github.com/neondatabase/neonctl/releases).
### Upgrade
**npm**
```shell
npm update -g neonctl
```
Requires Node.js 18.0 or higher.
**Howebrew**
```shell
brew upgrade neonctl
```
**Binary (macOS, Linux, Windows)**
To upgrade a binary version, download the latest binary file, as described above, and replace your old binary with the new one.
## Connect
Run the following command to authenticate a connection to Neon:
```bash
neonctl auth
```
The `auth` command launches a browser window where you can authorize the Neon CLI to access your Neon account. Running a Neon CLI command without authenticating with [neonctl auth](https://neon.tech/docs/reference/cli-auth) automatically launches the browser authentication process.
Alternatively, you can authenticate a connection with a Neon API key using the `--api-key` option when running a Neon CLI command. For example, an API key is used with the following `neonctl projects list` command:
```bash
neonctl projects list --api-key
```
For information about obtaining an Neon API key, see [Authentication](https://api-docs.neon.tech/reference/authentication), in the _Neon API Reference_.
## Configure autocompletion
The Neon CLI supports autocompletion, which you can configure in a few easy steps. See [Neon CLI commands — completion](https://neon.tech/docs/reference/cli-completion) for instructions.
## Commands
| Command | Subcommands | Description |
| --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ---------------------------- |
| [auth](https://neon.tech/docs/reference/cli-auth) | | Authenticate |
| [projects](https://neon.tech/docs/reference/cli-projects) | `list`, `create`, `update`, `delete`, `get` | Manage projects |
| [ip-allow](https://neon.tech/docs/reference/cli-ip-allow) | `list`, `add`, `remove`, `reset` | Manage IP Allow |
| [me](https://neon.tech/docs/reference/cli-me) | | Show current user |
| [branches](https://neon.tech/docs/reference/cli-branches) | `list`, `create`, `rename`, `add-compute`, `set-default`, `delete`, `get` | Manage branches |
| [databases](https://neon.tech/docs/reference/cli-databases) | `list`, `create`, `delete` | Manage databases |
| [roles](https://neon.tech/docs/reference/cli-roles) | `list`, `create`, `delete` | Manage roles |
| [operations](https://neon.tech/docs/reference/cli-operations) | `list` | Manage operations |
| [connection-string](https://neon.tech/docs/reference/cli-connection-string) | | Get connection string |
| [set-context](https://neon.tech/docs/reference/cli-set-context) | | Set context for session |
| [completion](https://neon.tech/docs/reference/cli-completion) | | Generate a completion script |
## Global options
Global options are supported with any Neon CLI command.
| Option | Description | Type | Default |
| :-------------------------- | :---------------------------------------------------------- | :------ | :----------------------------- |
| [-o, --output](#output) | Set the Neon CLI output format (`json`, `yaml`, or `table`) | string | table |
| [--config-dir](#config-dir) | Path to the Neon CLI configuration directory | string | `/home//.config/neonctl` |
| [--api-key](#api-key) | Neon API key | string | "" |
| [--analytics](#analytics) | Manage analytics | boolean | true |
| [-v, --version](#version) | Show the Neon CLI version number | boolean | - |
| [-h, --help](#help) | Show the Neon CLI help | boolean | - |
Sets the output format. Supported options are `json`, `yaml`, and `table`. The default is `table`. Table output may be limited. The `json` and `yaml` output formats show all data.
```bash
neonctl me --output json
```
Specifies the path to the `neonctl` configuration directory. To view the default configuration directory containing you `credentials.json` file, run `neonctl --help`. The credentials file is created when you authenticate using the `neonctl auth` command. This option is only necessary if you move your `neonctl` configuration file to a location other than the default.
```bash
neonctl projects list --config-dir /home/dtprice/.config/neonctl
```
Specifies your Neon API key. You can authenticate using a Neon API key when running a Neon CLI command instead of using `neonctl auth`. For information about obtaining an Neon API key, see [Authentication](https://api-docs.neon.tech/reference/authentication), in the _Neon API Reference_.
```bash
neonctl --api-key
```
Analytics are enabled by default to gather information about the CLI commands and options that are used by our customers. This data collection assists in offering support, and allows for a better understanding of typical usage patterns so that we can improve user experience. Neon does not collect user-defined data, such as project IDs or command payloads. To opt-out of analytics data collection, specify `--no-analytics` or `--analytics false`.
Shows the Neon CLI version number.
```bash
$ neonctl --version
1.15.0
```
Shows the `neonctl` command-line help. You can view help for `neonctl`, a `neonctl` command, or a `neonctl` subcommand, as shown in the following examples:
```bash
neonctl --help
neonctl branches --help
neonctl branches create --help
```
## Contribute
To run the CLI locally, execute the build command after making changes:
```shell
npm run build
```
To develop continuously:
```shell
npm run watch
```
To run commands from the local build, replace the `neonctl` command with `node dist`; for example:
```shell
node dist branches --help
```