nuxi init
The init command initializes a fresh Nuxt project.
Terminal
npx nuxi init [DIR] [--cwd=<directory>] [-t, --template] [-f, --force] [--offline] [--preferOffline] [--no-install] [--gitInit] [--shell] [--packageManager]
The init
command initializes a fresh Nuxt project using unjs/giget.
Arguments
Argument | Description |
---|---|
DIR="" | Project directory |
Options
Option | Default | Description |
---|---|---|
--cwd=<directory> | . | Specify the working directory |
-t, --template | Template name | |
-f, --force | Override existing directory | |
--offline | Force offline mode | |
--preferOffline | Prefer offline mode | |
--no-install | Skip installing dependencies | |
--gitInit | Initialize git repository | |
--shell | Start shell after installation in project directory | |
--packageManager | Package manager choice (npm, pnpm, yarn, bun) |
Environment variables
NUXI_INIT_REGISTRY
: Set to a custom template registry. (learn more).- Default registry is loaded from nuxt/starter/templates