Generates a new Blitz project in the current directory. You can choose between a full Blitz project and a minimal project. The former includes a database setup, authentication, and all of the other configuration that makes Blitz's magic work. The minimal template is a bare Blitz project with a minimum set of dependecies. It has no database or auth included. Both templates will include basic scaffolding for a landing page.
blitz new [name]| Argument | Required | Description |
|---|---|---|
name | Yes | The project name. Will be used in initial project scaffolding |
Note: blitz new . will set the project name to the current directory's
name.
| Argument | Short | Description | Default |
|---|---|---|---|
--template | Lets you choose a project's template. If omittied, it shows a prompt to choose the template. Options: full, minimal. | None | |
--language | A new project's language. If omittied, it shows a prompt to choose the language. Options: typescript, javascript. | None | |
--dry-run | -d | Displays what files would be generated but does not write the files to disk. | false |
--no-git | Skips git repository creation. | false | |
--skip-upgrade | Skip blitz upgrade if outdated. | false | |
--form | A form library for the full project. If omitted, it shows a prompt to choose the library. Options: react-final-form, react-hook-form, formik. | None | |
--yarn | Use yarn as the package manager. | false | |
--npm | Use npm as the package manager. | false | |
--pnpm | Use pnpm as the package manager. | false | |
--env | -e | Set app environment name. Read more. | None |
blitz new task-managerblitz new task-manager --npmblitz new landing-page --template=minimal