rent
ReferenceCommand line

rent describe

Use rent describe during review, debugging, or automation when you need to see how Rent interpreted the RSL schema without generating code or connecting to a database.

Inspect the project schema

rent describe
Comment
  Table: comments
  Fields:
    id: int
    body: string
  Relations:
    post: Post (one, required)

User
  Table: users
  Fields:
    id: int
    name: string (1 validator(s))
  Relations:
    posts: Post (many, optional, inverse)

Each entity shows its Rust type, SQL table, fields, and relationships. Rent only prints properties that apply, so the output stays compact while still showing constraints, cardinality, required relationships, and inverses.

Inspect a schema outside the default path

rent describe --schema crates/domain/entities

This is useful in a workspace where multiple crates own independent database models.

Review a schema change

rent describe > /tmp/schema-after.txt
diff /tmp/schema-before.txt /tmp/schema-after.txt

Because the output order is stable, ordinary text review makes accidental schema changes obvious.

On this page