Quick Start

Get up and running with Prax in under 5 minutes.

1 Add Prax to your project

Add Prax and Tokio to your Cargo.toml:

2 Create your schema

Create a prax/schema.prax file:

3 Configure your database

Create a prax.toml configuration file in your project root:

📖 Learn more: See the Configuration Reference for all available options including connection pooling, environment overrides, and debug settings.

4 Generate client code

Run the Prax CLI to generate type-safe client code:

This generates Rust code in src/generated/ with type-safe models and query builders.

5 Run migrations

Create and apply database migrations:

6 Use in your code

Import the generated client and start querying:

Next Steps