Getting Started

The moderatorim command-line tool ships with the SDK (pip install moderatorim-sdk). It scaffolds a new unit and generates the domain artifacts inside it, following an intent-based verb model: create makes a new unit, and generate adds an artifact to the unit you are working in.

For the exhaustive, always-accurate list of every command and flag, see the Reference section in the sidebar — it is generated from the tool itself and cannot drift from moderatorim --help. This page is the orientation.

create — scaffold a new unit

moderatorim create app my_product

Scaffolds an app in the current directory. Options set the human-facing title, a one-line description (used in the generated README), and the initial version:

moderatorim create app my_product \
  --display-name "My Product" \
  --description "What this app does" \
  --version 0.1.0

The scaffold is intentionally minimal — a module with its manifest, a README, and a tests directory:

my_product/
├─ __init__.py
├─ manifest.py        # the app's Manifest (name, version, models, routes, …)
├─ README.md
└─ tests/
   └─ test_manifest.py

generate — add a domain artifact

Run inside a unit to generate an artifact for a domain (generate is also available as g):

moderatorim generate model users
moderatorim generate service users
moderatorim generate route users
moderatorim generate view users
moderatorim generate test users

generate model accepts repeatable --field NAME:TYPE flags to seed the model’s columns (str, int, bool, float, text, datetime):

moderatorim generate model users --field name:str --field active:bool

Where to go next

• Reference (sidebar) — every command and flag, generated from the parser.
• SDK → Getting Started — build your first app against the SDK.