Repository navigation
TUI
The TUI is goSSMS's main interface: the terminal application you get by
running gossms with no arguments in a terminal. It is a SQL Server Management
Studio for the terminal — Object Explorer, query editor with IntelliSense,
result grids, execution plans, Activity Monitor, Agent, Always On, the whole
SSMS feature families — rendered with keys and mouse in any terminal, on Linux,
macOS and Windows.
Everything in this wiki that is not under the
CLI topic documents the
TUI. The two share one configuration (config.json and its profiles), so a
connection you saved in the Connect dialog is a
profile
the command line can use, and the CLI's script object emits exactly the text
the TUI's Script as ▸ writes.
| Area | |
|---|---|
| Object Explorer | The server tree and the Details pane: browse, filter, Rename/Delete/Move to Schema, drag a table into the editor. Object Explorer → |
| Query Editor | The editor: Execute, Execute at Cursor (Ctrl+Enter), Find and Replace, Format Document, IntelliSense, result grids, Messages, Results To File. Query Editor → |
| Execution plans | Estimated and actual plans, graph / tree / XML views, Live Query Statistics, .sqlplan files and Compare Showplan. Execution plans →
|
| Activity Monitor | The charts, Sessions and Block over sp_WhoIsActive, TempDB, a session's live plan, the Azure instance tab. Activity Monitor → |
| Connecting | The Connect dialog: saved connections, every authentication method, encryption and certificate validation, where passwords are kept |
| Options and the terminal | Tools ▸ Options, config and key files, themes and icon styles, update checks, clipboard, crash recovery |
| Keys and mouse | The keys and gestures people ask for most; F1 is the complete, always-current keyboard reference |
| Object Explorer | The tree and the Details pane, Filters Settings, drag-to-editor, and how permissions and editions grey a menu |
| Scripting | Script as ▸ and its destinations, Script Changes in every write dialog |
| Query Editor | The editor, Find and Replace, Format Document, IntelliSense, executing, the result tabs and export |
| Security | Logins, server and database roles, users, credentials, permissions and securables, auditing, row-level security |
| Encryption and keys | Database master keys, certificates, asymmetric and symmetric keys, Always Encrypted key stores |
| Server and database properties | Every properties page, what it writes, and what it shows when a value could not be read |
| Database tasks | New Database, snapshots, attach and detach, offline and online, Shrink, backup history, Background Tasks |
| Backup and Restore | The two dialogs: what each checks before it runs, and what it refuses to do at all |
| SQL Server Agent | Jobs, steps, schedules, alerts, operators and the Agent reports |
| Execution plans | Estimated and actual plans, the views, Live Query Statistics, .sqlplan and Compare Showplan |
| Query Store | The seven SSMS reports, the panel, forced plans and tracked queries |
| Activity Monitor | The charts, Block and Sessions, TempDB, live plans, the Azure instance tab |
| Log File Viewer | SQL Server and Agent logs and archives, the client filter, the server-side search |
| Replication | Publications, subscriptions and the Replication Monitor — monitored, not configured |
| Always On | Availability groups, the dashboards, replicas, listeners, backup preferences, read-only routing |
| Service Broker | The seven families, and the two you can edit |
| Extended Events | XEvent Profiler, the live/target viewer, sessions and their pages, merging .xel files |
| Full-Text Search | Catalogs, stoplists, search property lists, a table's full-text index and populations |
| Resource Governor | Pools, groups, the classifier function and the live counters beside each limit |
| Database Mail | Status, queues, profiles and accounts, the properties sheet, the test mail |
| Azure SQL Managed Instance | What works against a Managed Instance, and what the edition refuses |
| Use the TUI | Use the CLI |
|---|---|
| Browsing, dialogs, property sheets, wizards | Scripted, repeatable, scheduled calls |
| Visual plans, charts, grids |
-o json/jsonl/csv for a machine to parse |
| Editing and executing ad-hoc batches interactively | CI, cron, and AI agents (gossms agent guide) |
| The operations that only ever have a dialog (backup/restore, Agent jobs) |
--dry-run + --transaction rollback rehearsal of a fix |
Both talk to the same servers with the same permissions model; the CLI adds an operation ceiling per profile and an audit log for anything above a read.
→ The command line side of the wiki: Command Line.
- Getting connected
- Browsing and editing
- Diagnosing and tuning
- Server features