Skip to content
radix29 edited this page Oct 31, 2026 · 12 revisions

Welcome to the goSSMS wiki!

gossms
Manage SQL Server without leaving macOS or Linux

Last commit Latest release License

goSSMS

A terminal-based SQL Server Management Studio for Linux, macOS, and Windows. One executable — no GUI, no installer, no SQL client tools or drivers required.

Current release: v0.1.1. See RELEASE.md for what changed and CHANGELOG.md for the detail behind it. Supported servers: SQL Server 2016 SP1 and later, on Windows and Linux, and Azure SQL Managed Instance. Features unavailable on the connected version or engine edition are hidden or greyed with the reason, not left to fail at the server.

Two interfaces, one executable. Run gossms with no argument and you get the interactive TUI; give it any argument and you get the command line — scriptable, JSON-answerable, built for CI, cron and AI agents. The wiki is organised along those two topics.

Questions and feedback: goSSMS on Discord. Bugs and feature requests: issues.

Install

brew install radix29/tap/gossms          # macOS and Linux

Debian, Ubuntu and derivatives install from the APT repository at radix29.github.io/apt; single-file binaries for Windows (amd64 and arm64), Linux (amd64 and arm64) and macOS (Apple silicon and Intel) are on the releases page. The full instructions, including what to expect on first run, are in README.md.

The two topics

TUI — the interactive interface  ·  CLI — the command line

The terminal application: Object Explorer, the query editor, result grids, execution plans, Activity Monitor, and the SSMS feature families. Start here for the pages:

TUI overview The interface at a glance, and every TUI page indexed by area
Connecting · Options and the terminal · Keys and mouse Getting connected: the Connect dialog, configuration and themes, the keyboard and mouse (F1 is the always-current reference)
Object Explorer · Scripting · Query Editor Browsing, Script As, executing and results
Security · Encryption and keys · Server and database properties · Database tasks · Backup and Restore · SQL Server Agent Management dialogs, and the operations that only ever script
Execution plans · Query Store · Activity Monitor · Log File Viewer · Replication Diagnosing and tuning
Always On · Service Broker · Extended Events · Full-Text Search · Resource Governor · Database Mail · Azure SQL Managed Instance Server features, monitored — and partly editable

gossms <command> — one thing done, one parseable answer, one exit code. For scripts, pipelines, and AI agents; safe by default and auditable above a read.

Page
Command Line The hub: modes, a two-minute tour, global options, exit codes, the command groups
Getting started Syntax, response files, environment variables, help, profiles, connecting, passwords
Output and exit codes The envelope, six formats, limits, --out-file, every exit code
AI agents agent guide / agent schema / agent context, and how to drive gossms from an agent
Databases db — inventory, files, space, log usage, table sizes, options, create/drop, scoped configs
Server server — facts, memory, volumes, error log, sp_configure, trace flags
Objects and scripting object + script — browse, search, describe, dependencies, indexes, stats, Script As
Query and plans query + plan — run/parse/classify T-SQL, parameters, transactions, estimated/actual/cached plans
Data data — top, sample, count, profile, export, bulk import
Monitoring and Extended Events monitor + xevent — sessions, blocking, waits, top queries, Query Store, deadlocks, kill, capture
Security security — logins, users, roles, members, effective permissions
Safety and audit Operation classes, --allow and the profile ceiling, the write layer, --dry-run/--confirm, audit.jsonl

Reading this wiki next to the app

The F1 help dialog is the TUI's keyboard reference. It is part of the binary, so it is always the version you are running; the Keys and mouse page lists the keys people reach for most and does not try to replace it. The CLI's equivalents are gossms help and gossms agent guide, generated from the live command tree.

Sections marked (Screenshots for this section are not captured yet.) describe shipped behaviour whose capture has not landed yet — the feature is there, the picture is not. The captures live beside the wiki's source in the repository at screenshots/ in the wiki repository; a new one is a commit to that folder plus one line in the page that uses it.

The command line landed after v0.1.1: the CLI pages describe main, and ship with the next release.

License

goSSMS is © 2026 radix29 and licensed under GPL-3.0-or-later. The bundled sp_WhoIsActive is © 2007–2026 Adam Machanic and retains its own GPL-3.0 copyright.

Clone this wiki locally