Skip to content
Get packs

Guide · Open source

How to use vue-cli: install, what it does and when to switch

Updated · written with AI from the project's own documentation and checked against our catalogue data

Vue CLI is a command-line tool for setting up and building Vue.js projects, built on webpack. This guide explains what it does, how the project is currently positioned, and how to work with an existing Vue CLI project or move to a newer setup. Readers should finish knowing whether Vue CLI fits their project and what to use instead for new work.

Vue CLIvuejs/vue-cli · ★ 29.5k · MIT

Quick start

  1. 1Confirm the project is a good fit. Decide whether you maintain an existing Vue CLI project or are starting new work. The README recommends create-vue for new projects.
  2. 2Read the status notice. The README says Vue CLI is in maintenance mode, so expect no active feature development.
  3. 3Get the source. Run git clone https://github.com/vuejs/vue-cli to copy the repository locally.
  4. 4Read the documentation. Open https://cli.vuejs.org/ for the project docs, which the README says are still being refined.
  5. 5Plan a migration if needed. Use the VueSchool.io migration guide or the awesome-vite auto migration tools to plan a move to Vite.
  6. 6Start new projects with create-vue. For a new Vue project, use create-vue, which scaffolds Vite-based projects and supports Vue 2 and Vue 3.

What is Vue CLI and what is it built on?

Vue CLI is open-source tooling for Vue.js development. The project's README describes it as webpack-based tooling, and the analysis of the project calls it a command-line tool for setting up and building Vue.js projects.

The project is MIT licensed and written in JavaScript.

Check the current status before you start

The README states that Vue CLI is now in maintenance mode. For new projects, it recommends create-vue, which scaffolds Vite-based projects. create-vue supports both Vue 2 and Vue 3.

The README also points to the Vue 3 Tooling Guide on vuejs.org for the latest recommendations.

  • Vue CLI: maintenance mode, webpack-based
  • create-vue: recommended for new projects, scaffolds Vite-based projects
  • Vite: the build tool that create-vue projects use

Get the vue-cli source from GitHub

The install method listed for this project is a package manager, and the README's install instruction is to clone the repository. Use the command below to get a local copy of the source code. The README does not list any prerequisites.

git clone https://github.com/vuejs/vue-cli

Work with an existing Vue CLI project

Vue CLI is a good fit when you maintain a Vue.js project that was already created with it, or when you need to keep an older webpack-based Vue build working. Keeping the existing setup working is the main reason to stay on Vue CLI.

Documentation lives at https://cli.vuejs.org/. The README says the docs are still being refined and welcomes contributions. The contributing guide is in the repository's .github folder.

  • Keep an existing webpack-based build running
  • Read the docs at cli.vuejs.org
  • Follow the contributing guide if you want to help

Migrate from Vue CLI to Vite

If you want to move an existing Vue CLI project to Vite, the README links to a migration guide from VueSchool.io and to a list of tools and plugins that help with automatic migration, both maintained outside this project.

Review those resources before you start, since this page does not describe the migration steps itself.

  • Vue CLI to Vite Migration Guide from VueSchool.io
  • Tools and plugins for auto migration listed in awesome-vite

Compare Vue CLI with other options

For new Vue work, the README points to create-vue. Vite is the build tool behind create-vue projects. Nuxt is another option people compare with Vue CLI, and it is listed as a comparable project here. This guide does not benchmark these tools against each other.

What people use it for

  • Maintaining a Vue.js project originally created with Vue CLI
  • Keeping an older webpack-based Vue build working
  • Planning a migration of an existing Vue CLI project to Vite

Frequently asked questions

Is vue-cli still maintained?

The README says Vue CLI is now in maintenance mode, which means the project is not receiving active feature development. It recommends create-vue for new projects.

What should I use instead of vue-cli for a new project?

The README recommends create-vue, which scaffolds Vite-based projects. It supports both Vue 2 and Vue 3. The Vue 3 Tooling Guide on vuejs.org is also linked for current recommendations.

Is vue-cli free to use?

Vue CLI is released under the MIT license, as stated in the repository's LICENSE file linked from the README. You can read that file for the full terms.

What are the prerequisites for vue-cli?

The source does not list any prerequisites. The README's install instruction is to clone the repository with git.

How do I migrate from vue-cli to Vite?

The README links to a migration guide from VueSchool.io and to a list of auto migration tools in awesome-vite. Those resources are maintained outside this project and cover the migration steps.

How does vue-cli compare with Nuxt or Vite?

Vue CLI is webpack-based tooling, while the README points new projects toward Vite through create-vue. Nuxt is a comparable project listed for this guide. This page does not benchmark them.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Vue CLI suits developers maintaining an existing Vue CLI project or keeping an older webpack-based Vue build working. If you are starting a new Vue project, or want active feature development, pick create-vue with Vite instead, as the README recommends.

Install options & downloads