Readyset Docs

Get started

Install RDST Desktop, connect your database, and turn on RDST Agent.

Desktop download

Choose your platform at readyset.io/downloads. The stable download routes open the downloads page:

PlatformDownloadInstall
macOS, Apple SiliconDMGOpen the disk image and drag RDST Desktop to Applications
Windows, x64InstallerRun the installer. It installs for your user
Linux, x64AppImageMark it executable and run it
Linux, x64Debian package or RPMInstall with your package manager

For an AppImage, replace the filename with the one you downloaded:

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

First launch

Connect a database. Fill in the connection details, or paste a connection URL into Quick setup, and select Test & connect. You can also discover databases at AWS, Supabase, Neon or DigitalOcean, or hand it to your coding agent. See Connect a database.

Let RDST see your queries. RDST checks that it can read the database's query statistics and shows the fix for anything missing.

Select Turn on monitoring. It opens the turn-on dialog on the database's Database page. Pick how deep analysis reads a query, then select Sign up or sign in to get free AI with a Readyset account. Monitoring turns on once you're signed in, and the first readings arrive within seconds.

Let RDST see your queries, with every check passed and Turn on monitoring

You don't need an account to add a database. When you turn on monitoring, RDST asks you to sign in to Readyset for free AI. See AI access.

When your account's AI usage limit is reached, AI monitoring stops gracefully, local monitoring keeps running, and the app asks you to contact us.

Running in the tray

Closing the window hides it. RDST keeps monitoring from the system tray on Windows and Linux, or the menu bar on macOS. Select the icon to reopen it.

Start at login is enabled on the first packaged launch where supported. RDST starts in the background without opening a window. Clear Start at login in the tray menu to disable it. Linux AppImage builds don't support this setting.

Tray itemAction
Open RDSTShow the window
InboxOpen the Inbox
MonitoringTurn monitoring on or off for a database or all databases; see tray controls
Start at loginControl startup with your computer
NotificationsEnable or disable system notifications
Send test notificationCheck notification delivery
Open logs folderOpen backend logs
Quit RDSTStop the app and monitoring

The icon shows whether RDST is running, needs attention, or has monitoring off. Hover it for details. Monitoring can't collect while your computer is asleep or off. The chart keeps that gap when collection resumes.

Updates and upgrades

Published main releases download updates in the background. Use the app's restart control or quit RDST from the tray to apply a downloaded update. Preview and local builds need a manual reinstall.

On the first launch after an upgrade, RDST may migrate its data files. Leave Upgrading your data, this can take a minute to finish. Failed startup offers Try again and Open logs.

Update a separately installed CLI too. An older CLI may read saved queries but fail to write data upgraded by the desktop app. See Data and retention.

Running in a browser

Install the CLI and run rdst web. It serves the same database, Inbox, and report interface locally.

Keep rdst web running to collect readings. Closing a browser tab doesn't stop the server, but browser notifications need an open tab. The browser interface has no desktop tray or start-at-login controls.