How do I install mssql-cli on Ubuntu?

Use apt-get by following the Linux installation instructions in the README, or install via pip with 'python -m pip install mssql-cli', but ensure Python is correctly set up first.

Is mssql-cli being replaced by go-sqlcmd?

Yes, mssql-cli is on a deprecation path and will be fully replaced by go-sqlcmd once generally available, as stated in the README's deprecation notice.

Can I run a SQL script file with mssql-cli non-interactively?

Yes, use the non-interactive support feature by passing queries directly via command-line arguments, similar to traditional sqlcmd, but check the usage guide for exact syntax.

What's the difference between mssql-cli and the old sqlcmd utility?

mssql-cli offers modern features like auto-completion and syntax highlighting, while sqlcmd is more basic; however, mssql-cli is deprecated, so go-sqlcmd is now the recommended replacement.

Does mssql-cli support connecting to Azure SQL Database?

Yes, it should support connections to Azure SQL Database using standard SQL Server connection parameters, but verify in the documentation as deprecation might affect future compatibility.

mssql-cli

BSD-3-ClausePython1.0

An interactive command-line client for SQL Server with auto-completion and syntax highlighting.

GitHub

1.4k stars193 forks0 contributors

What is mssql-cli?

mssql-cli is an interactive command-line query tool for SQL Server that provides a modern CLI experience for database administrators and developers. It solves the problem of cumbersome, outdated command-line interfaces by offering features like auto-completion and syntax highlighting to improve productivity. It is cross-platform and part of the dbcli community, though it is currently on a deprecation path in favor of go-sqlcmd.

Target Audience

Database administrators and developers who work with SQL Server and prefer or require command-line tools for querying and managing databases. It is particularly suited for those seeking a more interactive and feature-rich alternative to traditional SQL Server CLI utilities.

Value Proposition

Developers choose mssql-cli for its modern CLI features like auto-completion, syntax highlighting, and query history, which streamline SQL Server interactions. Its cross-platform compatibility and integration with the dbcli ecosystem offer a consistent, user-friendly experience compared to basic tools like sqlcmd.

Overview

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

Use Cases

Best For

Interactive querying and exploration of SQL Server databases with real-time auto-completion for table and column names.

Related Projects

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub

Database administrators needing a cross-platform command-line tool for SQL Server with syntax highlighting for T-SQL.

Developers writing and testing multi-line SQL queries in a command-line environment without switching to a GUI.

Automating scripts or tasks that require non-interactive SQL query execution directly from the command line.

Users who prefer customizable CLI experiences via configuration files to tailor the tool to their workflow.

Teams seeking a modern, open-source alternative to traditional SQL Server CLI utilities with community-driven features.

Not Ideal For

Long-term projects requiring active maintenance and updates, as mssql-cli is deprecated in favor of go-sqlcmd.
Users needing a graphical interface for data visualization or drag-and-drop query building, since it's purely command-line.
Environments with strict dependency controls or aversion to Python setup, due to its pip-based installation and potential version conflicts.

Pros & Cons

Pros

Rich Auto-completion

Intelligently suggests table names, columns, and SQL keywords to speed up query writing, as demonstrated in the README's GIF showcasing reduced keystrokes.

Syntax Highlighting

Visually distinguishes T-SQL keywords during interactive sessions, improving code readability and reducing errors.

Query History and Suggestions

Stores and auto-suggests previously executed queries for quick re-use, enhancing productivity in repeated tasks.

Cross-Platform Compatibility

Works seamlessly on Windows, macOS, and Linux, making it versatile for diverse development and admin environments.

Cons

Active Deprecation

Explicitly marked as deprecated and being replaced by go-sqlcmd, meaning no new features, limited support, and a migration path is necessary.

Python Dependency Issues

Requires Python and pip for installation, which can lead to setup complexities, version conflicts, and maintenance overhead in controlled IT environments.

Limited GUI Integration

Lacks integration with modern IDEs or visual tools, making it less suitable for workflows that rely on graphical interfaces or extensive data exploration.

Frequently Asked Questions

Database Tools

mycli

A Terminal Client for MySQL with AutoCompletion and Syntax Highlighting.

Stars11,905

Forks688

Last commit10 hours ago

litecli

CLI for SQLite Databases with auto-completion and syntax highlighting

Stars3,230

Forks91

Last commit2 months ago