ginduc / mssql-cli

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

mssql-cli

mssql-cli is an interactive command line query tool for SQL Server. This open source tool works cross-platform and proud to be a part of the dbcli community.

mssql-cli supports a rich interactive command line experience, with features such as:

• Auto-completion: fewer keystrokes needed to complete complicated queries.
• Syntax highlighting: highlights T-SQL keywords.
• Query history: easily complete an auto-suggested query that was previously executed.
• Configuration file support: customize the mssql-cli experience for your needs.
• Multi-line queries: execute multiple queries at once using the multi-line edit mode.
• Non-interactive support: execute a query without jumping into the interactive experience.

Quick Start

Read the section below to quickly get started with mssql-cli. Consult the usage guide for a deeper dive into mssql-cli features.

Install mssql-cli

Platform-specific installation instructions are below:

Windows (preview)	macOS	Linux

Visit the installation reference guide to view all supported releases and downloads.

Install with Linux Package Manager

Follow the Linux installation instructions to install mssql-cli using apt-get, yum, and other Linux package managers.

Install with pip

python -m pip install mssql-cli

Please refer to the pip installation docs for more platform-specific information.

Connect to Server

Complete the command below to connect to your server:

mssql-cli -S <server URL> -d <database name> -U <username> -P <password>

Exit mssql-cli

Press Ctrl+D or type quit.

Show Options

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

mssql-cli --help

Usage Docs

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.

Telemetry

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

Contributing

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

Contact Us

If you encounter any bugs or would like to leave a feature request, 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 [email protected] with any additional questions or comments.

License

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