Documentation
BroadSQL is a command-line workbench for every database you manage, and for the APIs in front of them. The documentation is organized by domain, in the order you usually need it.
Latest release: BroadSQL 5.4.5. What's new ? lists every change since then, and how to check it; the release notes keep the detailed record of every release.
What's new
What changed since the last published release, by area, with how to see it.
Release notes
What each published release shipped, newest first.
Getting started
Install BroadSQL, check the requirements, configure it, add your first connection and run your first query.
Commands reference
The exact syntax of every command, with its arguments, aliases and examples.
User guide
Everyday work at the prompt: connections and environments, exploring a database, the console, list sources and the activity log.
Scripting
Reusable SQL automation: Scripts with variables, named arguments and error control, the Scripts Library and the Editor.
Import / Export
Move data between databases, files, spreadsheets and local H2 datasets, and load CSV files into tables.
API Client
Experimental: call the HTTP APIs in front of your databases from the same prompt, and keep their results.
Developers
JavaScript scripting, custom commands, bundled libraries and how credentials are protected.
BroadSQL