Skip to content
forked from dbcli/pgcli

Postgres CLI with autocompletion and syntax highlighting

License

Notifications You must be signed in to change notification settings

pombredanne/pgcli

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

38 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

** WIP - DO NOT USE **

A REPL for Postgres

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

image

image

Quick Start

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

$ pip install pgcli

If you don't know how to install python pacakges, please check the detailed instructions.

Usage

$ pgcli [database_name]

or

$ pgcli postgresql://[user[:password]@][netloc][:port][/dbname] 

Examples:

$ pgcli local_database

$ pgcli postgres://amjith:pa$$w0rd@example.com:5432/app_db

Features

The pgcli is written using prompt_toolkit.

  • Auto-completion 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.
  • Config file is automatically created at ~/.pglirc at first launch.
  • Primitive support for psql back-slash commands.

Detailed Installation Instructions:

OS X:

For installing Python pacakges it is recommended to use the package manager called pip. Check if pip is installed on the system.

$ 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

Linux:

Check if pip is already available in your system.

$ which pip

If it does then install pgcli using the pip command as follows:

$ sudo pip install pgcli

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

$ sudo apt-get install python-pip

or

$ sudo yum install python-pip

Then you can install pgcli:

$ sudo pip install pgcli

About

Postgres CLI with autocompletion and syntax highlighting

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%