@chordio/neon-beacon

A CLI helper for navigating Neon databases locally

Installation

You can install @chordio/neon-beacon globally using npm:

npm install -g @chordio/neon-beacon

Or you can run it using npx

npx @chordio/neon-beacon 

Setup

Before using @chordio/neon-beacon, you need to set up your environment variables. Create a .env file in your working directory and add the following variables:

NEON_BEACON_PROJECT_ID=your_project_id
NEON_BEACON_API_KEY=your_api_key

Replace your_project_id and your_api_key with your actual NeonDB project ID and API key.

Usage

@chordio/neon-beacon [options] [command]

Commands:

• config
  Configure CLI properties

  • reset
    Reset the current configuration

  • show
    Show the details of the current configuration

• list
  List all branch databases

• current
  Show the current branch

• switch [options] [branch]
  Switch to a different branch database

Examples

Configure CLI properties

@chordio/neon-beacon config

List all branch databases

@chordio/neon-beacon list

Show the current branch

@chordio/neon-beacon current

Switch to a different branch database

@chordio/neon-beacon switch branch_name

License

This project is licensed under the MIT License. See the LICENSE file for details.