Documentation / Introduction

Your Rust backend, ready to evolve.🔗

Crabster turns a domain model into a complete application. This guide takes you from the first generation through to the changes your project will go through.

1. Install Crabster🔗

$ cargo install crabster-cli

Nothing is published on crates.io yet: from a clone of the repository, cargo run -p crabster-cli -- … does the same thing. Every command and option is in the command reference.

2. Describe your domain🔗

Start with the entities, their properties and their relations. The CDL language expresses that model in a file of its own.

EXAMPLE · INVOICING

Customer → Invoice → Payment

A customer has several invoices.
Each invoice keeps its payments.

The CDL language describes everything a model can carry: types, references, enumerations, roles and service settings.

3. Generate, then customise🔗

Explore the code it produced and write your own logic into it. The stamps are what let Crabster recognise the changed files later — and that is what lets it come back without overwriting your work.

What comes next: the developer guide walks through a whole session, and Crabster and the others places the tool against JHipster, Hasura and PostgREST.