CLI Reference
All available flags and options.
Usage
npx pest-js-app [options]Flags
| Flag | Description |
|---|---|
--name <name> | Project name in kebab-case |
--database <orm> | prisma, drizzle, typeorm, or none |
--db-provider <db> | postgresql, mysql, or sqlite |
--docker | Include Docker files |
--no-docker | Skip Docker files |
--package-manager <pm> | npm, pnpm, or yarn |
-y, --yes | Skip all prompts, use defaults |
-v, --version | Print version |
-h, --help | Print help |
Non-interactive mode
Pass --yes to skip prompts and use sensible defaults. You can override any default with additional flags:
npx pest-js-app --yes --name my-apiDefaults with --yes
| Option | Default |
|---|---|
| name | my-app |
| description | A PEST.js application |
| author | From git config user.name |
| database | none |
| db-provider | postgresql |
| docker | true if a database is selected |
| package-manager | npm |
| git | true |
| install | true |
Examples
No database, default settings:
npx pest-js-app --yes --name my-apiPrisma with PostgreSQL and Docker:
npx pest-js-app --yes --name my-api --database prisma --db-provider postgresql --dockerDrizzle with SQLite, no Docker:
npx pest-js-app --yes --name my-api --database drizzle --db-provider sqlite --no-dockerTypeORM with MySQL using pnpm:
npx pest-js-app --yes --name my-api --database typeorm --db-provider mysql --package-manager pnpm