Skip to content

Commit 8ff45ae

Browse files
committed
expand and clarify mssql-cli install instructions
1 parent 67292cf commit 8ff45ae

1 file changed

Lines changed: 31 additions & 2 deletions

File tree

docs/tools/mssql-cli.md

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,14 +17,43 @@ monikerRange: "=azuresqldb-current||=azure-sqldw-latest||>=sql-server-2016||=sql
1717

1818
[!INCLUDE[appliesto-ss-asdb-asdw-xxx-md](../includes/appliesto-ss-asdb-asdw-xxx-md.md)]
1919

20-
mssql-cli is an interactive command-line tool for querying SQL Server, install it on Windows, macOS, or Linux.
20+
mssql-cli is an interactive command-line tool for querying SQL Server and runs on Windows, macOS, or Linux.
2121

2222
## Install mssql-cli
2323

24-
For detailed installation instructions, see the [Installation Guide](https://github.com/dbcli/mssql-cli/tree/master/doc/installation), or if you know pip, install by running the following command:
24+
For detailed installation instructions, see the [Installation Guide](https://github.com/dbcli/mssql-cli/tree/master/doc/installation). The most common install scenarios are summarized below.
25+
26+
### Windows and macOS Installation
27+
28+
mssql-cli is installed on Windows and macOS using `pip`:
2529

2630
```$ pip install mssql-cli```
2731

32+
For more detailed instructions, please see the [Installation Guide](https://github.com/dbcli/mssql-cli/tree/master/doc/installation).
33+
34+
### Linux Installation
35+
36+
After registering the Microsoft repository, mssql-cli can be installed and upgraded through package managers on several Linux distributions.
37+
38+
The following example applies to Ubuntu 18.04 (Bionic), more information and examples for other distributions can be found in the [Installation Guide](https://github.com/dbcli/mssql-cli/tree/master/doc/installation).
39+
40+
```
41+
# Import the public repository GPG keys
42+
curl https://packages.microsoft.com/keys/microsoft.asc | sudo apt-key add -
43+
44+
# Register the Microsoft Ubuntu repository
45+
sudo apt-add-repository https://packages.microsoft.com/ubuntu/18.04/prod
46+
47+
# Update the list of products
48+
sudo apt-get update
49+
50+
# Install mssql-cli
51+
sudo apt-get install mssql-cli
52+
53+
# Install missing dependencies
54+
sudo apt-get install -f
55+
```
56+
2857
## mssql-cli documentation
2958

3059
Documentation for mssql-cli is located in the [mssql-cli GitHub repository](https://github.com/dbcli/mssql-cli).

0 commit comments

Comments
 (0)