Getting Started

faux-db projects follow a small set of conventions so the CLI can discover providers, catalogs, schemas, custom functions, and output files without extra configuration.

Typical workflow

1. Install the package and confirm the faux CLI is available.
2. Run faux init to scaffold a starter project.
3. Edit files in schemas/, providers/, and catalogs/.
4. Validate everything with faux config validate.
5. Generate one schema file or a full domain directory.

What faux init creates

The starter structure includes:

• schemas/ for table definitions
• providers/ for named provider configurations
• catalogs/ for YAML lookup data used by templates
• functions/ for custom Python callables
• seeds/ for CSV-backed providers
• outputs/ for generated files

Choose your path

• Read Installation to set up the environment.
• Follow Quickstart to generate the example dataset in minutes.
• Read Architecture to understand how the pieces connect.
• Use Configuration when you start authoring real projects.