Skip to content
Sofie

Commands

  • sofie gen: rewrites the generated files (wiring, contracts’ gen/, .env.example, AGENTS.md); run it after changing routes, modules, aggregates or screens.
  • sofie check: every one of the rules; app/build.rs runs it, so a finding fails cargo build.
  • sofie fix: applies the fixes that have exactly one form, then reports the rest.
  • sofie explain NAME: a route, area, module, event, job, task, read model, aggregate, screen, screen component or flag.
  • sofie routes: the route table.
  • sofie components: every component a screen template may use, with its props, and the template syntax.
  • sofie tasks: each #[task] with the --name value arguments it reads; the binary runs one with <app> task MODULE.NAME [--name value]....
  • sofie dev: runs the app, rebuilding and reloading on changes.
  • sofie feature add|remove NAME: turns a sofie feature on or off in app/Cargo.toml, editing only that dependency’s features.
  • sofie new module NAME, sofie scaffold tests, sofie scaffold screen KEY: new code in its place, wired.
  • sofie new migration MODULE NAME, sofie new aggregate MODULE Name, sofie new event MODULE Name, sofie new listener MODULE Event handler, sofie new task MODULE handler, sofie new search MODULE Aggregate, sofie new plan MODULE name, sofie new mail MODULE name [--list LIST], sofie new area MODULE NAME ACCESS, sofie new account-screen AREA SCREEN, sofie new impersonation PERMITTED_AREA MEMBER_AREA, sofie new tenancy ORGANIZATION_AREA MEMBER_AREA, sofie new route MODULE AREA METHOD PATH handler [--screen NAME] [--fields FIELDS] [--read-model Name] [--title TITLE] [--back HANDLER], sofie new menu MODULE AREA handler LABEL: stubs in their place, then sofie gen and sofie check.
  • sofie build [--image]: the release binary, and with --image its container image.
  • sofie bench: load tests of the routes, held to a baseline.
  • sofie fuzz [--seed N] [--requests N]: sends every route generated valid and broken inputs, signed in and out, and reports each 500, dropped answer or crash with its input, span tree and log lines; a local database only.
  • sofie seed [--volume N]: fills the local database through the app’s own POST routes, first with each module’s seeds/<area>.<handler>.json (a JSON array of inputs), then N generated inputs per route, as the member sofie bench signs in with.
  • sofie mcp: these tools over the Model Context Protocol, each generator with dry_run, and the app’s own tools below.
  • cargo test --offline: the tests.

Adding code

Section titled “Adding code”
  • A module: sofie new module NAME, then set its tier in src/module.rs.
  • A route: sofie new route, or one line in src/areas/<area>/routes.rs naming a handler in actions/ or queries/, such as routes.post("/orders", actions::place_order); then sofie gen.
  • A screen: sofie new route MODULE AREA get PATH handler --screen NAME (a path naming an aggregate, such as /orders/{order}, gets a read model of its fields and a screen showing them; --fields a,b picks them), or src/areas/<area>/screens/<name>.html routed with routes.screen("/path", "<name>", queries::loader); then sofie gen.
  • An aggregate: sofie new aggregate, or src/<aggregate>/mod.rs with #[derive(Aggregate)], re-exported from lib.rs, and a migration creating its table; then sofie gen and sofie check.
  • An event and its listener: sofie new event, then sofie new listener in each module reacting to it.
  • Tests: sofie scaffold tests writes them for what the modules declare. Scaffolded tests live in app/tests/scaffolded/, one file per run; extend them there; hand-written tests go in app/tests/<topic>.rs. Write each as #[test_app] async fn name(app: TestApp), as the scaffolded ones are; #[tokio::test] only where #[test_app] cannot run it, with a line saying why.

Generated from sofie at 4aa7c05.