Get started

Generating a project takes one command. This page covers what the machine needs first, what the CLI asks, and what arrives.

1. 01

   Check the machine

   Prumo needs Node 22.17 or later and pnpm. Anything with an API also needs Docker, because the development database runs there. This command checks all of it and names whatever is missing.

   npx @stjoseph/prumo doctorCopy
2. 02

   Generate the project

   It asks what to build, writes the project into my-app/, runs git init and installs. Nothing is committed, so the first commit is yours and its diff shows everything Prumo wrote.

   npx @stjoseph/prumo new my-appCopy
3. 03

   Answer without a terminal

   Every question has a flag. More than one type makes a workspace; a single type needs --alone or --monorepo to say how it is laid out.

   npx @stjoseph/prumo new my-app --types api,web --single-tenantCopy
4. 04

   Create the database

   Inside a project with an API, this creates the development database in Docker and writes its URL into .env. Once the database exists, prumo clean removes the setup the project needed only once.

   prumo dbCopy