Readyset Docs

Install

Download the RDST desktop app for macOS, Windows, or Linux, or run the same interface in a browser on a machine where you cannot install software.

Desktop download

Go to readyset.io/downloads.

PlatformYou get
macOS (Apple Silicon)A .dmg disk image
Windows (x64)An .exe installer
LinuxAn .AppImage, .deb, or .rpm

Open the .dmg and drag RDST Desktop to Applications. The build is signed and notarized, so it opens without a Gatekeeper warning.

Apple Silicon only. On an Intel Mac, use the browser option below.

Run the .exe. It installs per-user, so it does not prompt for an administrator password.

The .AppImage is portable: mark it executable and run it, no installation step.

chmod +x rdst-desktop-*.AppImage
./rdst-desktop-*.AppImage

The .deb and .rpm install through your package manager instead, which is the better choice if you want the app in your launcher.

The app updates itself. When a new version is published it downloads in the background and the sidebar offers a restart to apply it.

Running in a browser

If you cannot install a desktop application on the machine, the same interface runs in a browser. It is the identical app, served locally rather than packaged, and it comes with the CLI.

Install the CLI.

curl -fsSL https://downloads.readyset.io/packages/rdst-cli/install.sh | sh

The installer uses user-owned directories and needs no sudo, no pip, and no preinstalled Python. Open a new shell afterwards.

uv tool install rdst
# or: pipx install rdst

RDST leaves these installations under the control of their package manager.

Start the server.

rdst web

Open it. The server prints a URL, http://127.0.0.1:8787 by default, and opens your browser for you.

Everything in this section applies to the browser version. The screens, the workflows, and the wording are the same. The only difference is where it runs.

rdst web binds to 127.0.0.1, so only your own browser can reach it. Passing --host 0.0.0.0 exposes it to your whole network, and the server has no authentication of its own. Put it behind SSH port forwarding or a reverse proxy rather than opening the port. The CLI reference for rdst web covers those deployment patterns.

First launch

The app opens on a setup screen that asks for two things.

A database. Add one by hand, import it from a cloud account, or reach a private one through an SSH jump host. See Connect a database.

LLM access. Ask, the written analysis in Analyze Query, and the reasoning in a health report call an LLM. Claim free credits in the app or paste your own Anthropic key. See AI credits and API keys.

RDST stores its configuration in ~/.rdst/config.toml, which the CLI reads from as well. Database passwords are never written there. RDST keeps them in your operating system keychain, or reads them from an environment variable you name.