Installation

While all of the examples on this website uses the ggsql WebAssembly build to let you run it in the browser, you’ll likely want it on your own computer, interfacing with your local data.

ggsql provides native installers for Windows, macOS, and Linux. Choose the best option for your platform below.

All platforms

Jupyter kernel

To use ggsql in Jupyter or Quarto notebooks, install the Jupyter kernel using either uv (recommended) or cargo. The kernel is also part of the main installer linked to above.

Using uv

uv is the fastest way to install the binaries:

uv tool install ggsql-jupyter
ggsql-jupyter --install

Using cargo

If you have a Rust toolchain installed you can install with cargo:

cargo install ggsql-jupyter
ggsql-jupyter --install

VS Code / Positron extension

For syntax highlighting and language support in VS Code or Positron, install the ggsql extension. You can either install it directly from the extension marketplace from within the IDE or download and install it manually:

  1. Download ggsql.vsix
  2. Install via the command line:
# VS Code
code --install-extension ggsql.vsix

# Positron
positron --install-extension ggsql.vsix

Or install from within the editor: open the Extensions view, click the ... menu, select “Install from VSIX…”, and choose the downloaded file.