create-vite

Scaffolding Your First Vite Project

Compatibility Note: Vite requires Node.js version >=12.2.0. However, some templates require a higher Node.js version to work, please upgrade if your package manager warns about it.

With NPM:

$ npm init @inp/vite@latest

With Yarn:

$ yarn create  @inp/vite

With PNPM:

$ pnpm create  @inp/vite

Then follow the prompts!

You can also directly specify the project name and the template you want to use via additional command line options. For example, to scaffold a Vite + Vue project, run:

# npm 6.x
npm init @inp/vite@latest my-vue-app --template vue

# npm 7+, extra double-dash is needed:
npm init @inp/vite@latest my-vue-app -- --template vue

# yarn
yarn create @inp/vite my-vue-app --template vue

# pnpm
pnpm create @inp/vite my-vue-app -- --template vue

Currently supported template presets include:

• vanilla
• vanilla-ts
• vue
• vue2-ts
• vue-ts
• react
• react-ts
• preact
• preact-ts
• lit
• lit-ts
• svelte
• svelte-ts

Community Templates

create-vite is a tool to quickly start a project from a basic template for popular frameworks. Check out Awesome Vite for community maintained templates that include other tools or target different frameworks. You can use a tool like degit to scaffold your project with one of the templates.

npx degit user/project my-project
cd my-project

npm install
npm run dev

If the project uses main as the default branch, suffix the project repo with #main

npx degit user/project#main my-project