Skip to content

@mabulu-inc/simplicity-admin-cli

The cli package provides the simplicity-admin command-line tool for project scaffolding, development, production builds, and database-to-YAML schema generation.

Dependencies: All other @simplicity-admin packages.

Scaffold a new SIMPLICITY-ADMIN project.

Terminal window
npx simplicity-admin init my-admin

This creates a project directory with:

  • simplicity-admin.config.ts — Configuration file
  • package.json — Dependencies and scripts
  • .env — Environment variable template
  • schema/ — Directory for simplicity-schema YAML files

Choose a template with the --template flag:

Terminal window
npx simplicity-admin init my-admin --template crm
TemplateDescription
blankEmpty project, no tables (default)
crmContacts, companies, deals, activities
cmsPages, posts, categories, media
todoTasks, lists, labels

Start a development server with hot reloading.

Terminal window
npx simplicity-admin dev

The dev server watches for changes to the config file, view YAML files, and simplicity-schema files. Schema changes trigger re-introspection automatically.

Create a production build.

Terminal window
npx simplicity-admin build

Outputs optimized assets ready for deployment. The build includes the SvelteKit UI, API server, and all configured providers.

Introspect the database and generate simplicity-schema YAML files.

Terminal window
npx simplicity-admin generate

This connects to the configured database, reads the current schema, and outputs YAML files to schema/tables/. Useful for adopting SIMPLICITY-ADMIN on an existing database — run generate once to create the initial YAML definitions, then manage schema changes through YAML going forward.

All commands work via npx without global installation:

Terminal window
npx simplicity-admin init my-project
npx simplicity-admin dev
npx simplicity-admin build
npx simplicity-admin generate

Or install globally:

Terminal window
npm install -g @mabulu-inc/simplicity-admin-cli
simplicity-admin dev

See the CLI Commands reference for full option details.