Skip to content

CLI Commands Reference

All commands are available via npx simplicity-admin or globally if @mabulu-inc/simplicity-admin-cli is installed.

Scaffold a new SIMPLICITY-ADMIN project.

Terminal window
npx simplicity-admin init [name]
ArgumentDescription
nameProject directory name. Created in the current working directory.
FlagDefaultDescription
--templateblankStarter template: blank, crm, cms, todo
Terminal window
npx simplicity-admin init my-admin
npx simplicity-admin init my-crm --template crm

Creates a directory with:

  • simplicity-admin.config.ts
  • package.json
  • .env (template with placeholder values)
  • schema/ directory (populated if using a template other than blank)

Start the development server with hot reloading.

Terminal window
npx simplicity-admin dev

The dev server watches for changes to:

  • simplicity-admin.config.ts
  • views/*.view.yaml
  • schema/**/*.yaml

Schema file changes trigger automatic re-introspection. The server runs on the port specified in config (default: 3000).


Create a production-optimized build.

Terminal window
npx simplicity-admin build

Outputs compiled assets to the build/ directory. The build includes the SvelteKit UI, API server configuration, and all provider code. Ready for deployment to any Node.js hosting environment.


Introspect the database and generate simplicity-schema YAML files.

Terminal window
npx simplicity-admin generate

Connects to the database specified in your config or DATABASE_URL environment variable. Reads the current schema and writes YAML files to schema/tables/.

This is useful when adopting SIMPLICITY-ADMIN on an existing database. Run generate once to create initial table definitions, then manage all future schema changes through YAML.

schema/tables/users.yaml
schema/tables/products.yaml
schema/tables/categories.yaml
...

Each file contains the table definition with columns, types, constraints, foreign keys, and enum references.