thorstenkampe / sql-shell

a frontend for SQL shells

README

Table of Contents

• 1. Introduction
• 2. Requirements
• 3. Installation
• 4. Usage

1. Introduction

Modern SQL shells like mssql-cli, mycli, SQLcl and pgcli are very convenient: they offer auto-completion, syntax highlighting, query history, a multi-line editor, and much more.

SQL Shell makes using SQL clients even more convenient:

• a standard interface to enter connection parameters so you don’t have to remember command line options

• pre-defined connection strings for connection without typing

• automatic tunneling if your database is behind a firewall or listening only on localhost interface

2. Requirements

• SQL shell clients (mssql-cli, mycli, SQLcl, pgcli, litecli)

• Linux only: Python modules click, npyscreen, pycompat, and sshtunnel

3. Installation

1. download release

2. verify requirements

4. Usage

1. optional: edit sql shell.ini and tunnel.ini to match your environment

2. run sql shell.exe (Windows) or sql shell.py (Linux)

ℹ️	If you can’t get SQL Shell running or have questions, open a ticket

4.1. standard

4.2. DSN

4.3. tunnel