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.
npx simplicity-admin init [name]Arguments
Section titled “Arguments”| Argument | Description |
|---|---|
name | Project directory name. Created in the current working directory. |
Options
Section titled “Options”| Flag | Default | Description |
|---|---|---|
--template | blank | Starter template: blank, crm, cms, todo |
Examples
Section titled “Examples”npx simplicity-admin init my-adminnpx simplicity-admin init my-crm --template crmOutput
Section titled “Output”Creates a directory with:
simplicity-admin.config.tspackage.json.env(template with placeholder values)schema/directory (populated if using a template other thanblank)
Start the development server with hot reloading.
npx simplicity-admin devThe dev server watches for changes to:
simplicity-admin.config.tsviews/*.view.yamlschema/**/*.yaml
Schema file changes trigger automatic re-introspection. The server runs on the port specified in config (default: 3000).
Create a production-optimized build.
npx simplicity-admin buildOutputs 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.
generate
Section titled “generate”Introspect the database and generate simplicity-schema YAML files.
npx simplicity-admin generateConnects 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.
Output
Section titled “Output”schema/tables/users.yamlschema/tables/products.yamlschema/tables/categories.yaml...Each file contains the table definition with columns, types, constraints, foreign keys, and enum references.