Skip to content
Pgxcli

Getting Started

Installation

Section titled “Installation”

From Source

Section titled “From Source”

Ensure you have Go installed (version 1.21+ recommended).

Terminal window
git clone https://github.com/balaji01-4d/pgxcli.git
cd pgxcli
make build

The binary will be created in bin/app.

Quick Start

Section titled “Quick Start”

Connect to a database named mydb as user myuser:

Terminal window
./bin/app mydb myuser

Connection Options

Section titled “Connection Options”

Using Flags

Section titled “Using Flags”
Terminal window
./bin/app --host localhost --port 5432 --user postgres --dbname postgres

Using a Connection URI

Section titled “Using a Connection URI”
Terminal window
./bin/app postgres://user:password@localhost:5432/dbname

Interactive Mode

Section titled “Interactive Mode”

Once connected, you can:

  • Execute SQL queries with syntax highlighting
  • Use tab completion for suggestions
  • Access command history with arrow keys
  • Run PostgreSQL special commands (e.g., \d, \l)

Next Steps

Section titled “Next Steps”
  • Check out the CLI reference for all available flags and commands
  • Learn about configuration options and customization