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.
Read the section below to quickly get started with mssql-cli. Consult the usage guide for a deeper dive into mssql-cli features.
Platform-specific installation instructions are below:
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
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>
Press Ctrl+D or type
For general help content, pass in the
The mssql-cli tool includes a telemetry feature. Please refer to the telemetry guide for more information.
If you would like to contribute to the project, please refer to the development guide.
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
mssql-cli is licensed under the BSD-3 license.