Começar
Gerar um projeto leva um comando. Esta página cobre o que a máquina precisa antes, o que o CLI pergunta e o que chega.
Confira a máquina
O Prumo precisa de Node 22.17 ou mais novo e de pnpm. Qualquer coisa com API precisa também de Docker, porque é lá que roda o banco de desenvolvimento. Este comando confere tudo e diz o que falta.
npx @stjoseph/prumo doctorGere o projeto
Ele pergunta o que construir, escreve o projeto em my-app/, roda git init e instala. Nada é commitado, então o primeiro commit é seu e o diff dele mostra tudo o que o Prumo escreveu.
npx @stjoseph/prumo new my-appResponda sem terminal
Toda pergunta tem uma flag. Mais de um tipo faz um workspace; um tipo só precisa de --alone ou --monorepo para dizer como fica disposto.
npx @stjoseph/prumo new my-app --types api,web --single-tenantCrie o banco
Dentro de um projeto com API, isto cria o banco de desenvolvimento no Docker e escreve a URL dele no .env. Uma vez que o banco existe, prumo clean remove a preparação de que o projeto precisou uma vez só.
prumo db
As flags
| Flag | O que ela responde |
|---|---|
| --types api,web,mobile,site | O que o projeto contém. Mais de um tipo faz um workspace |
| --alone --monorepo | Como um tipo sozinho fica disposto |
| --multi-tenant --single-tenant | Se a aplicação serve vários inquilinos |
| --skip-install | Para depois de escrever os arquivos |
O que chegou
| Arquivo | O que é |
|---|---|
| .prumo/ | As convenções, em nove áreas. Só as áreas que as respostas pedem são copiadas |
| .prumo/INDEX.md | Uma linha por documento. Gerado pela ferramenta, e seguro de regerar |
| AGENTS.md | O ponteiro para o .prumo/, lido por Codex, Cursor, Copilot, Gemini CLI e outros |
| CLAUDE.md | Um import de @AGENTS.md, para o Claude Code |