Every command runs from the repository’s root, after eval "$(fnm env --shell zsh)" (Node 24) and
pnpm install.
| Command | What it does |
|---|
pnpm start | The one command: the installer (its questions on a first run, a check and a resume after), then the local stack, then where each part answers |
pnpm ready | Start the local stack and check the installation, changing nothing |
| Command | What it does |
|---|
pnpm installer | First run: four questions, the secrets, the database, the sample projects. A rerun checks what it knows, asks to confirm and resume, and never makes a secret twice. Add --no-sample to skip the sample projects, --yes to answer yes to confirmations |
pnpm installer:check | Check what it knows; change nothing (exit 1 if something is off) |
pnpm installer:teardown | Drop the database and its logins; remove the settings and the installer’s record |
pnpm installer:admin | Make the firm’s first admin, or let an admin back in, on the machine that holds the API’s settings |
| Command | What it does |
|---|
pnpm local:up | Make the stack’s certificates where missing, fetch and check the map extract, build the field app and the back office, start every service, wait until each answers over HTTPS; then build and start the API and the worker once the installer has made their settings |
pnpm local:down | Stop and remove the containers; the data is kept |
pnpm local:wipe | Down, plus the data volumes, the generated settings and the certificates (the downloaded map extract is kept) |
pnpm local:status | Each service and its health |
pnpm local:accounts | Write the dev stack’s own accounts (Dana Reyes, Luis Ortega, Bayline County’s debris manager) and show how to sign in; --show only shows, --codes shows each authenticator’s code now. Local only, never shipped |
| Command | What it does |
|---|
pnpm sample | Load the two sample projects into the installation |
pnpm scenarios | Run the scenario harness: whole projects told as stories, the golden mission among them, each asserting exact statuses, review queues and ledgers |
pnpm field:control-tickets | Make the printable control-ticket test set (400001–400050, a PDF to print and scan with each phone) |
pnpm field:try | Try the field app’s current build by hand, in a world of its own with P1 and P2 set up, in a phone-sized browser; nothing goes into the installation’s database. Needs the stack up |
| Command | What it does |
|---|
pnpm typecheck | Generate the Prisma client and type-check every workspace |
pnpm test | Type-check, then every Vitest project (the database tests need the stack up) |
pnpm e2e | The browser tests |
pnpm lint | ESLint and Prettier, with no warnings allowed |
pnpm format | Format with Prettier |
pnpm licences | Check every installed package’s licence is compatible with Apache-2.0 for what ships |
pnpm security | The dependency audit, the secrets scan and the database’s grant tests |
pnpm openapi | Generate apps/api/openapi.json from the shared contracts |
pnpm chain | The whole verification chain, in order: the stack, the installer’s check, install, typecheck, test, scenarios, e2e, security, lint, licences. pnpm chain <step> runs the steps named |
pnpm clean | Remove TypeScript’s build output |
| Command | What it does |
|---|
pnpm --filter @open-adms/docs dev | Serve this site locally with live reload |
pnpm --filter @open-adms/docs build | Build it to static files in apps/docs/dist/ and check every link, Markdown twin and llms.txt entry |
pnpm --filter @open-adms/docs preview | Serve the built site |
