CLI Commands

npx snowcms {command}

If no accounts exist in the database, an account with the ADMIN role will be created. The login details for this account will be logged to the console.

Tip

Anti-virus software can prevent the build command from working. If this happens, either temporarily disable the anti-virus software or add an exclusion.

dev

Creates a development build and starts a server. Whenever changes are made, the frontend and/or server will be reloaded. A WebSocket server will be started on config.port + 1 which is used to notify the front-end of changes.

build

Creates a production build at dist. It will also copy all dependencies required for production.

To run the CMS, set your working directory to dist/server and run node server.js. In a production setup, you should use a process manager such as PM2.

Tip

Make sure the system running the build runs the same (or a similar) operating system to the one that runs the CMS as some dependencies make use of native modules.