Skip to content
Postgres CLI with autocompletion and syntax highlighting
Python Gherkin Other
Branch: master
Clone or download

Latest commit

laixintao Support style for missing value. (#1186)
* Support style for missing value.

* update changelog.

* upgrade minimal version of cli_helpers, in order to use style for null.
Latest commit 0c24e8b May 29, 2020


Type Name Latest commit message Commit time
Failed to load latest commit information.
.github add optional but default squash merge request to PULL_REQUEST_TEMPLATE ( Sep 28, 2019
pgcli Support style for missing value. (#1186) May 28, 2020
screenshots Add an animated gif to the readme. Jul 23, 2015
tests Add pg_service.conf handling (#1155) Apr 17, 2020
.coveragerc Added coverage support for functional tests. Mar 31, 2017
.editorconfig Add editorconfig Jul 27, 2017
.git-blame-ignore-revs Add git-blame-ignore revs in anticipation of hyper-blame. May 17, 2018
.gitignore Respect \pset pager on expected behavior Sep 23, 2018
.pre-commit-config.yaml Fix the condition for <enter> key. (#1114) Oct 23, 2019
.travis.yml python3.8: add travis test and class. (#1157) Mar 18, 2020
AUTHORS Add info to changelog.rst and AUTHORS May 26, 2020
DEVELOP.rst Fix dead link of behave. Dec 31, 2019
Dockerfile Update python version from 2.7 to 3.8 in Dockerfile (#1181) May 11, 2020
LICENSE.txt Update license. Jun 26, 2017 exclude *.pyc from sdist and lower python3-keyring to >= 11.0.0 Jul 14, 2018
README.rst Add --help output to README (#1164) Mar 30, 2020
TODO Move refresh routines outside the loop. Jan 31, 2015
Vagrantfile Update repo references. Apr 19, 2015
changelog.rst Support style for missing value. (#1186) May 28, 2020
pgcli-completion.bash pgcli bash completion script (#892) Apr 3, 2020
post-install Packaging: first cut of working deb and rpm build Apr 11, 2015
post-remove Packaging: first cut of working deb and rpm build Apr 11, 2015
pylintrc Make pylint happier with Mar 17, 2017
pyproject.toml Drop Python3.5. (#1154) Mar 11, 2020 removed py2-related stuff Mar 14, 2020
release_procedure.txt Fixed release script and author email, because pypi made some breakin… Jan 12, 2017
requirements-dev.txt upgrade coverage to 5.x (#1158) Mar 18, 2020
sanity_checks.txt Corrected some typos Jan 8, 2015 Support style for missing value. (#1186) May 28, 2020
tox.ini python3.8: add travis test and class. (#1157) Mar 18, 2020


A REPL for Postgres

Build Status Code coverage report Latest Version Code Health Gitter Chat

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

Home Page:

MySQL Equivalent:



Quick Start

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

$ pip install -U pgcli


$ 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 detailed instructions.

If you are restricted to using psycopg2 2.7.x then pip will try to install it from a binary. There are some known issues with the psycopg2 2.7 binary - see 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.


$ pgcli [database_name]


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


$ pgcli local_database

$ pgcli postgres://amjith:pa$$

For more details:

$ pgcli --help


  -h, --host TEXT         Host address of the postgres database.
  -p, --port INTEGER      Port number at which the postgres instance is
  -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 PATH          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
  --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 / --no-warn      Warn before running a destructive query.
  --help                  Show this message and exit.

pgcli also supports many of the same environment variables as psql for login options (e.g. PGHOST, PGPORT, PGUSER, PGPASSWORD, PGDATABASE).


The pgcli is written using prompt_toolkit.

  • Auto-completes as you type for SQL keywords as well as tables and columns in the database.

  • Syntax highlighting using Pygments.

  • Smart-completion (enabled by default) will suggest context-sensitive completion.

    • SELECT * FROM <tab> will only show table names.
    • SELECT * FROM users WHERE <tab> will only show column names.
  • Primitive support for psql back-slash commands.

  • Pretty prints tabular data.


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


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.

Please feel free to reach out to me if you need help. My email:, Twitter: @amjithr

Detailed Installation Instructions:


The easiest way to install pgcli is using Homebrew.

$ brew install pgcli


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 -

$ which pip

If it is installed then you can do:

$ pip install pgcli

If that fails due to permission issues, you might need to run the command with sudo permissions.

$ sudo pip install pgcli

If pip is not installed check if easy_install is available on the system.

$ which easy_install

$ sudo easy_install pgcli


In depth getting started guide for pip -

Check if pip is already available in your system.

$ which pip

If it doesn't exist, use your linux package manager to install pip. This might look something like:

$ sudo apt-get install python-pip   # Debian, Ubuntu, Mint etc


$ sudo yum install python-pip  # RHEL, Centos, Fedora etc

pgcli requires python-dev, libpq-dev and libevent-dev packages. You can install these via your operating system package manager.

$ sudo apt-get install python-dev libpq-dev libevent-dev


$ sudo yum install python-devel postgresql-devel

Then you can install pgcli:

$ sudo pip install pgcli


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


Pgcli can be run from within IPython console. When working on a query, it may be useful to drop into a pgcli session without leaving the IPython console, iterate on a query, then quit pgcli to find the query results in your IPython workspace.

Assuming you have IPython installed:

$ pip install ipython-sql

After that, run ipython and load the pgcli.magic extension:

$ ipython

In [1]: %load_ext pgcli.magic

Connect to a database and construct a query:

In [2]: %pgcli postgres://someone@localhost:5432/world
Connected: someone@world
someone@localhost:world> select * from city c where countrycode = 'USA' and population > 1000000;
| id   | name         | countrycode   | district     | population   |
| 3793 | New York     | USA           | New York     | 8008278      |
| 3794 | Los Angeles  | USA           | California   | 3694820      |
| 3795 | Chicago      | USA           | Illinois     | 2896016      |
| 3796 | Houston      | USA           | Texas        | 1953631      |
| 3797 | Philadelphia | USA           | Pennsylvania | 1517550      |
| 3798 | Phoenix      | USA           | Arizona      | 1321045      |
| 3799 | San Diego    | USA           | California   | 1223400      |
| 3800 | Dallas       | USA           | Texas        | 1188580      |
| 3801 | San Antonio  | USA           | Texas        | 1144646      |
Time: 0.003s

Exit out of pgcli session with Ctrl + D and find the query results:

9 rows affected.
[(3793, u'New York', u'USA', u'New York', 8008278),
 (3794, u'Los Angeles', u'USA', u'California', 3694820),
 (3795, u'Chicago', u'USA', u'Illinois', 2896016),
 (3796, u'Houston', u'USA', u'Texas', 1953631),
 (3797, u'Philadelphia', u'USA', u'Pennsylvania', 1517550),
 (3798, u'Phoenix', u'USA', u'Arizona', 1321045),
 (3799, u'San Diego', u'USA', u'California', 1223400),
 (3800, u'Dallas', u'USA', u'Texas', 1188580),
 (3801, u'San Antonio', u'USA', u'Texas', 1144646)]

The results are available in special local variable _, and can be assigned to a variable of your choice:

In [3]: my_result = _

Pgcli only runs on Python3.6+ since 2.2.0, if you use an old version of Python, you should use install pgcli <= 2.2.0.


A special thanks to Jonathan Slenders for creating 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.

Click is used for command line option parsing and printing error messages.

Thanks to psycopg for providing a rock solid interface to Postgres database.

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

You can’t perform that action at this time.