Skip to main content

Quickstart

import { Module as FakerModule } from '@quik/faker';

await FakerModule.setup({ /* bootstrap options */ });

Generate a starter spec after your app has booted, so all QModel entities are registered:

quik faker:spec:generate
# writes ./faker.spec.json

Edit the generated spec, then generate fake rows:

quik faker:generate

Notes​

  • Spec generation, generation, and anonymization all operate on registered QModel entities — boot the app (or at least register entities) before running any faker:* command.
  • Fields marked skip: true (PKs, FKs, auto-timestamps) are preserved by both generate and anonymize modes.