Skip to content
PrumoPrumo
    Searches every heading in the documentation.

    Commands

    The published package is @stjoseph/prumo and the command it installs is prumo. Either npx or pnpm dlx runs it without installing anything.

    prumo new [name]
    Generates a project
    prumo db
    Inside a project with an API: creates the development database in Docker and writes its URL into .env
    prumo clean
    Removes what the project needed only once, today the database setup, once the database exists
    prumo doctor
    Checks Node, pnpm, git and Docker on this machine
    prumo version
    Prints the CLI version. Also --version and -v
    prumo help [command]
    Lists the commands, or describes one. Also --help

    Every command takes --json

    Standard output then holds exactly one document. Anything written for a person goes to standard error, nothing is asked, and the exit code is 0 only when ok is true.

    { "ok": true, "command": "new", "data": { … } }
    { "ok": false, "command": "db", "error": { "code": "…", "message": "…" } }