/mssql-cli

A command-line client for SQL Server with auto-completion and syntax highlighting

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

mssql-cli

We’re excited to introduce mssql-cli, a new and interactive command line query tool for SQL Server. This open source tool works cross-platform and proud to be a part of the dbcli.org community.

https://github.com/dbcli/mssql-cli/raw/master/screenshots/mssql-cli-autocomplete.gif

Features

  • Auto-completion
  • Syntax highlighting
  • Query history
  • Configuration file support
  • Multi-line queries

Get mssql-cli

Install Instructions
Windows (x64)
Windows (x86)
macOS 10.12+
Ubuntu 17.04
Ubuntu 16.04
Ubuntu 14.04
Debian 8.7+
Debian 9
CentOS 7
Red Hat Enterprise Linux 7
OpenSUSE 42.2+
Fedora 25
Fedora 26

Direct downloads

Direct downloads for both latest stable and preview bits can be found at Direct download.

Installation via apt, yum

Please refer to Get mssql-cli for detailed install instructions per platform.

Installation via pip

$ pip install mssql-cli

Please refer to Install via pip for detailed install instructions via pip on each platform

Usage

Please refer to the usage guide for details on options and example usage. If you are having any issues using mssql-cli, please see the troubleshooting guide.

For general help content, pass in the -h parameter:

$ mssql-cli --help

The mssql-cli tool includes a telemetry feature. Please refer to the telemetry guide for more information.

Configuration

Customization and persistence of settings can be achieved with a config file, whose path can be passed as the --mssqlclirc <file> command line argument. Otherwise it is read from the default path ~/.config/mssqlcli/config on macOS and Linux, and %LOCALAPPDATA%\dbcli\mssqlcli\config on Windows. See the config file itself for a description of all available options.

Contributing

If you would like to contribute to the project, please refer to the development guide.

Reporting issues and feedback

If you encounter any bugs with the tool please file an issue in the Issues section of our GitHub repo.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

License

mssql-cli is licensed under the BSD-3 license.