Skip to main content

Crate ruprizzle_cli

Crate ruprizzle_cli 

Source
Expand description

Documentation target for the ruprizzle command-line interface.

This crate ships a binary, not a library API — everything it does lives in src/main.rs behind the ruprizzle executable. The binary’s own rustdoc cannot be published, because its target is named ruprizzle and would collide with the ruprizzle runtime crate’s documentation in a shared target/doc. Without this file rustdoc is asked to document nothing at all, which docs.rs records as a failed build — see ProjectPlan/v1/V1StableRelease.md S1-02.

So this module exists to carry the CLI’s reference documentation, and nothing else. It exports no items and is not covered by semver; see docs/Stability.md.


§ruprizzle-cli

Crates.io docs.rs License

Command-line interface for ruprizzle-orm.

ruprizzle-cli is the entry point for working with ruprizzle-orm outside of Rust code. It parses the schema.ruprizzle file, generates typed clients, introspects existing databases, validates schemas, and runs migrations against Postgres, MySQL/MariaDB, or SQLite.

§Commands

  • ruprizzle init — scaffold a new project with a schema, .env, and migrations directory.
  • ruprizzle generate — parse the schema and emit the generated Rust client.
  • ruprizzle validate — parse and validate the schema without writing files; useful in CI.
  • ruprizzle format — rewrite the schema file in canonical form.
  • ruprizzle migrate — plan, apply, inspect, and squash schema migrations.
  • ruprizzle db pull — introspect an existing database into schema.ruprizzle.
  • ruprizzle db seed — transactionally apply idempotent rows from seeds/main.json.
  • ruprizzle db push — push schema changes directly without migration files.

§Installation

cargo install ruprizzle-cli
ruprizzle --help

§Quick start

ruprizzle init --provider sqlite
ruprizzle generate
ruprizzle migrate dev

§Studio

Ruprizzle Studio, a local browser UI for your data, is behind the studio feature:

cargo install ruprizzle-cli --features studio
ruprizzle studio                 # read-only; add --allow-writes to edit

Open the URL it prints (http://127.0.0.1:5555/studio?token=…). Since 1.6 every request needs that per-run token; use --token or RUPRIZZLE_STUDIO_TOKEN to fix it, and send it as x-studio-token or Authorization: Bearer from scripts.

See the project homepage for the full guide.

§Keywords

orm, sql, database, cli, migrations

Modules§

studio
Embedded Pure-Rust Ruprizzle Studio web application.