A REPL for Postgres

Code coverage report Code Health

This is a postgres client that does auto-completion and syntax highlighting.

Home Page: http://mycli.net

Quick Start

If you already know how to install python packages, then you can simply do:

$ pip install -U pgcli

or

$ sudo apt-get install pgcli # Only on Debian based Linux (e.g. Ubuntu, Mint, etc)
$ brew install pgcli # Only on macOS

If you don't know how to install python packages, please check the psycopg docs for more information about this and how to force installation from source. psycopg2 2.8 has fixed these problems, and will build from source.

Usage

$ pgcli [database_name]

or

$ pgcli postgresql://[user[:password]@][netloc][:port][/dbname][?extra=value[&other=other-value]]

Examples:

$ pgcli local_database

$ pgcli postgres://amjith:pa$$w0rd@example.com:5432/app_db?sslmode=verify-ca&sslrootcert=/myrootcert

For more details:

$ pgcli --help

Usage: pgcli [OPTIONS] [DBNAME] [USERNAME]

Options:
 -h, --host TEXT Host address of the postgres database.
 -p, --port INTEGER Port number at which the postgres instance is
 listening.
 -U, --username TEXT Username to connect to the postgres database.
 -u, --user TEXT Username to connect to the postgres database.
 -W, --password Force password prompt.
 -w, --no-password Never prompt for password.
 --single-connection Do not use a separate connection for completions.
 -v, --version Version of pgcli.
 -d, --dbname TEXT database name to connect to.
 --pgclirc FILE Location of pgclirc file.
 -D, --dsn TEXT Use DSN configured into the [alias_dsn] section
 of pgclirc file.
 --list-dsn list of DSN configured into the [alias_dsn]
 section of pgclirc file.
 --row-limit INTEGER Set threshold for row limit prompt. Use 0 to
 disable prompt.
 --less-chatty Skip intro on startup and goodbye on exit.
 --prompt TEXT Prompt format (Default: "\u@\h:\d> ").
 --prompt-dsn TEXT Prompt format for connections using DSN aliases
 (Default: "\u@\h:\d> ").
 -l, --list list available databases, then exit.
 --auto-vertical-output Automatically switch to vertical output mode if
 the result is wider than the terminal width.
 --warn [all|moderate|off] Warn before running a destructive query.
 --help Show this message and exit.

pgcli also supports many of the same

Features

The pgcli is written using Config

A config file is automatically created at ~/.config/pgcli/config at first launch. See the file itself for a description of all available options.

Contributions:

If you're interested in contributing to this project, first of all I would like to extend my heartfelt gratitude. I've written a small doc to describe how to get this running in a development setup.

amjith.r@gmail.com, Twitter: Detailed Installation Instructions:

macOS:

The easiest way to install pgcli is using Homebrew.

$ brew install pgcli

Done!

Alternatively, you can install pgcli as a python package using a package manager called called pip. You will need postgres installed on your system for this to work.

In depth getting started guide for pip - Linux:

In depth getting started guide for pip - Docker

Pgcli can be run from within Docker. This can be useful to try pgcli without installing it, or any dependencies, system-wide.

To build the image:

$ docker build -t pgcli .

To create a container from the image:

$ docker run --rm -ti pgcli pgcli <ARGS>

To access postgresql databases listening on localhost, make sure to run the docker in "host net mode". E.g. to access a database called "foo" on the postgresql server running on localhost:5432 (the standard port):

$ docker run --rm -ti --net host pgcli pgcli -h localhost foo

To connect to a locally running instance over a unix socket, bind the socket to the docker container:

$ docker run --rm -ti -v /var/run/postgres:/var/run/postgres pgcli pgcli foo

IPython

Pgcli can be run from within Thanks:

A special thanks to Python Prompt Toolkit, which is quite literally the backbone library, that made this app possible. Jonathan has also provided valuable feedback and support during the development of this app.

psycopg for providing a rock solid interface to Postgres database.

Thanks to all the beta testers and contributors for your time and patience. :)