Site ↗
Documentation sections
CLI interface · 0.8.1

Generated application commands

Startup, builds, migrations, the first administrator and media storage maintenance.

On this page

After Generate, you work with two command sets. admingen-cli changes the model and generates files. The generated application's commands start processes, apply SQL and maintain data. For example, admingen-cli generate does not replace make migrate.

Where to run commands

Configure the model in Generator UI → Content, review Generate → Preview changes, and run Generate. Then switch to the generated application's directory. Make combines common startup steps; individual Go commands run specific operations.

After startup, records, relationships and images are edited through the admin system's forms and tables.

Make commands

Command What it does
make dev Main local startup: environment, database, migrations, first administrator and application processes.
make local-environment Prepare local configuration while preserving existing configuration.
make dev-inner Internal local-startup stage; usually called through dev.
make setup Prepare frontend dependencies through admin-install.
make build Build the backend and admin.
make test Check the backend and admin.
make up Start local infrastructure; not the full deployment procedure.
make down Stop local infrastructure while preserving persistent data.
make wait-db Wait for PostgreSQL readiness.
make bootstrap-superadmin Create the first administrator through the terminal.
make migrate Apply migrations.
make backend-build Build the Go backend.
make backend-test Test the Go backend.
make admin-install Install frontend dependencies according to the project contract.
make admin-build Prepare dependencies and build the admin.
make admin-test Prepare dependencies and check the admin.
make constraints-list List constraints that need attention.
make constraint-validate NAME=... Validate one named constraint.
make constraints-validate Validate all pending constraints.

Use the complete dev/build/test commands for regular work. Internal stages are mainly for diagnosis: do not run them in an arbitrary order instead of the full workflow.

Backend commands

From backend/, run go run ./cmd/api, go run ./cmd/localsetup ensure-env, go run ./cmd/admin bootstrap-superadmin, go run ./cmd/migrate or go run ./cmd/constraints .... If the project uses images, media cleanup and snapshots are also available.

Commands read the application's environment. Before running them, check which database and profile they will connect to.

For the first administrator, bootstrap accepts --login, --password-file and --if-needed. String parameters default to empty; --if-needed is disabled. Enter the password through a TTY or a protected file rather than a regular CLI flag value. See first sign-in.

Migrate supports --check, --verify and ordinary application without these flags. Constraints supports list/validate/validate-all, --output text|json and --name. Their results and errors are explained in migrations.

Image snapshot

A media snapshot is needed for a consistent backup. Before passing --writers-frozen, stop the API and cleanup processes. No process may change records or files during the snapshot.

Parameter Default Meaning
--mode empty export, restore or verify-empty.
--stage empty Absolute clean path to an existing directory; for export, the directory is empty.
--env empty Required environment name.
--writers-frozen false Explicitly confirm that writing processes have stopped.
--confirm-restore empty For restore, must match the environment name.
--expected-identity empty For restore, the media identity from the recovery point:64 hexadecimal characters.
--timeout 30m Positive timeout, at most24h.

Verify-empty accepts neither stage nor restore parameters; export does not accept restore confirmation. Cleanup runs separately with --limit from1 to100, default100. Do not combine it with creating a consistent snapshot.

The deployment controller normally coordinates the database and files. Combining low-level commands manually requires maintaining this order yourself.

Related instructions

Application structure is configured in Generator UI, and content in the admin system. This article's terminal commands manage processes and maintenance rather than routine record editing.