Skip to main content

RDST - Readyset Data and SQL Toolkit

A command-line tool for database diagnostics, query analysis, performance tuning, and caching optimization with Readyset.

What is RDST?

RDST helps you:

  • Analyze SQL queries for caching opportunities
  • Identify slow queries in real-time
  • Get optimization suggestions
  • Evaluate query compatibility with Readyset cache
  • Manage database connection profiles

Installation

Install RDST on macOS or Linux without sudo, pip, or a preinstalled Python:

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

Open a new shell, then verify the installation:

rdst version

The installer supports Apple silicon, Intel macOS, and glibc-based x86_64 or arm64 Linux distributions. To install an exact package release:

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

Immutable release scripts and checksums are published under packages/rdst-cli/versions/VERSION/ on the download origin.

Installer-managed RDST never updates silently. Check for and install updates explicitly:

rdst update --check
rdst update

rdst update installs the exact resolved release and makes no changes when the installed version is already current.

To uninstall the managed runtime while preserving ~/.rdst configuration:

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

Existing uv and pipx users can continue to use uv tool install rdst or pipx install rdst; those installations remain managed by their package manager. Update them with uv tool upgrade rdst or pipx upgrade rdst.

After installing, run rdst init to configure your first database connection.

Native Windows development

Use PowerShell with Python 3.12+ and uv:

cd rdst
uv sync --group dev
uv run rdst version
$env:PROD_DB_PASSWORD = "your-password"

RDST stores user data under %USERPROFILE%\.rdst. Interactive editor commands use EDITOR or VISUAL and fall back to Notepad.

When the Docker CLI talks to a daemon on another machine, configure the daemon network explicitly:

$env:RDST_DOCKER_REMOTE = "1"
$env:RDST_DOCKER_PUBLISHED_HOST = "192.168.122.1"
$env:RDST_DOCKER_UPSTREAM_HOST = "192.168.122.222"

RDST_DOCKER_PUBLISHED_HOST is where Windows reaches published container ports. RDST_DOCKER_UPSTREAM_HOST is where containers reach a database running on the Windows client. The database must listen on that routable address.

Quick Start

  1. Initialize RDST:

    rdst init
    # Or with uvx (no installation needed):
    uvx rdst init
    
  2. Configure database connection:

    rdst configure add-target mydb \
      --host localhost \
      --port 5432 \
      --database myapp \
      --user postgres
    
  3. Analyze queries:

    # Analyze a specific query
    rdst analyze "SELECT * FROM users WHERE active = true"
    
    # With uvx:
    uvx rdst analyze "SELECT * FROM users WHERE active = true"
    
    # Analyze with Readyset cache evaluation
    rdst analyze --readyset-cache "SELECT * FROM products ORDER BY created_at"
    
  4. Monitor slow queries:

    rdst top
    # Or: uvx rdst top
    
  5. Audit your fleet:

    # Snapshot all ReadySet clusters and audit their health
    rdst fleet audit --target prod
    
    # Import clusters from your infrastructure
    rdst fleet import --target prod
    

    Fleet audit checks cache utilization, query support, and configuration across your ReadySet deployments. See the fleet audit docs for more.

Commands

All commands can be run with rdst (if installed) or uvx rdst (no installation):

  • rdst analyze - Analyze SQL queries and evaluate caching opportunities
  • rdst top - Live view of slow queries
  • rdst ask - Natural language to SQL queries
  • rdst scan - Scan codebases for ORM queries and analyze performance
  • rdst fleet audit - Audit ReadySet cluster health and cache utilization
  • rdst fleet import - Import ReadySet clusters from your infrastructure
  • rdst schema - Manage the semantic layer for better query generation
  • rdst query - Manage query registry
  • rdst configure - Manage database targets and connection profiles
  • rdst init - First-time setup wizard
  • rdst version - Show version information

Example with uvx:

uvx rdst analyze "SELECT * FROM orders WHERE status = 'pending'"

Requirements

  • Packaged CLI: macOS or a glibc-based Linux distribution on x86_64 or arm64
  • Native Windows development: Python 3.12+, uv, and PowerShell
  • curl or wget for the macOS/Linux installer
  • PostgreSQL or MySQL database access

About Readyset

Readyset is a SQL caching engine that sits between your application and database, automatically caching query results to improve performance. Learn more at readyset.io.

Documentation

License

MIT License - see LICENSE file for details

Metadata

Release files for rdst 0.1.1735

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for rdst 0.1.1735
File Size Uploaded
rdst-0.1.1735.tar.gz 2.7 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for rdst 0.1.1735
File Interpreter ABI Platform
rdst-0.1.1735-py3-none-any.whl Python 3 none any Details

Total release size: 5.1 MB

Release files / rdst-0.1.1735.tar.gz

Download URL rdst-0.1.1735.tar.gz
Size 2.7 MB
Tags Source
SHA-256 checksum
How to use checksums
717a1fe2863648a51a39c086eafbcc0c65d3e99de4bb13c1f058efd9129028e8
BLAKE2b-256 checksum
How to use checksums
5e6671b19236ee69c69232ef86011318f5581111058736356d1f4397b555e7b1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release files / rdst-0.1.1735-py3-none-any.whl

Download URL rdst-0.1.1735-py3-none-any.whl
Size 2.3 MB
Tags Python 3
SHA-256 checksum
How to use checksums
8310bcefdea7473ba53f45084767d01c4c4075a196d01c72dd58f26ca2541f34
BLAKE2b-256 checksum
How to use checksums
295ca30202587282b04a50143a90709679791e83be47419b7abe4ebfa3bfad57
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.9.25

Release history Release notifications | RSS feed

This release

0.1.1735 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page