# Installation
URL: /docs/installation
LLM index: /llms.txt
Description: Install and configure SQL Studio.

# Installation

SQL Studio ships as a self-contained binary with no runtime dependencies. Pick the method that suits your platform.

## Shell Script (macOS and Linux)

The fastest way to get the latest release:

```bash
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/frectonz/sql-studio/releases/download/0.1.51/sql-studio-installer.sh | sh
```

Once the script completes, `sql-studio` is available on your `PATH`.

## PowerShell (Windows)

Run the following in a PowerShell terminal:

```bash
irm https://github.com/frectonz/sql-studio/releases/download/0.1.51/sql-studio-installer.ps1 | iex
```

## Nix

SQL Studio is available in Nixpkgs. Add it to your environment or run it directly:

```bash
nix run nixpkgs#sql-studio
```

## Docker

A Docker image is published on Docker Hub as `frectonz/sql-studio`. The following example launches SQL Studio against a PostgreSQL server and binds it on port 3030:

```bash
docker run -p 3030:3030 frectonz/sql-studio /bin/sql-studio \
  --no-browser \
  --no-shutdown \
  --address=0.0.0.0:3030 \
  postgres \
  postgres://localhost:5432/
```

When running in Docker, always pass `--no-browser` (there is no desktop browser in the container), `--no-shutdown` (keep the server alive), and `--address=0.0.0.0:3030` (bind to all interfaces so the host can reach it).

## Building from Source

You need Rust and Node.js installed. The UI must be built before the Rust binary because the binary statically embeds the frontend assets.

```bash
git clone git@github.com:frectonz/sql-studio.git
cd sql-studio
cd ui
npm install
npm run build
cd ..
cargo build --release
```

The compiled binary is at `target/release/sql-studio`.

## Updating

If you installed via the shell script or PowerShell installer, re-run the same install command to update to the latest release.

## Verify the Installation

```bash
sql-studio --help
```

You should see the list of subcommands and global options. From here, follow [Quickstart](/docs/quickstart) to launch the UI against a database.

## Sitemap

See the full [sitemap](/sitemap.md) for all pages.
Docs-scoped sitemap: [/docs/sitemap.md](/docs/sitemap.md).
Well-known sitemap: [/.well-known/sitemap.md](/.well-known/sitemap.md).