Skip to main content

SolidX Control Plane CLI Reference

SolidX Control Plane CLI Reference

The solidctl CLI provides commands for scaffolding, maintaining, and operating SolidX projects. Run npx @solidxai/solidctl --help to see all available commands.

CommandDescription
create-appScaffold a new SolidX project with backend (NestJS) and frontend (React).
seedBootstrap SolidX metadata, settings, and the system user.
buildBuild the Solid API and frontend, and set up the Solid CLI.
upgradeUpgrade Solid API and UI dependencies belonging to the @solidxai organization in the solid-api and solid-ui projects to their latest published versions.
generateGenerate code from model definitions. If solid-api and solid-ui are running using solidx:dev, the application is hot reloaded with the latest generated code. (Not Implemented yet)
infoPrint information about the current SolidX project.
test-dataProxy to Solid test-data utilities.
tip

Run npx @solidxai/solidctl help <command> to see detailed options for any command.