Installation Guide

Get started with AutoVue in just a few simple steps

Prerequisites

Before installing AutoVue, make sure you have the following installed:

• Node.js: Version 20.19.0 or higher, or 22.12.0 or higher
• npm: Latest version (comes with Node.js)
• Git: For version control (optional but recommended)

Installation

Install AutoVue globally using npm:

Or using yarn:

Or using pnpm:

Usage

Once installed, you can create a new Vue project using:

The tool will guide you through an interactive setup process where you can choose:

• Project name and description
• Vue.js features (Router, Pinia, etc.)
• Testing frameworks (Vitest, Cypress, Playwright, etc.)
• Linting and formatting tools
• Additional configurations

What You Get

AutoVue creates a complete project structure with:

• Three Git Branches:
  • main - Production-ready code
  • dev - Development environment with full tooling
  • gh-pages - GitHub Pages ready for documentation
• Modern Configuration: ESLint, Prettier, TypeScript, and build tools
• Development Tools: Hot reload, testing setup, and more
• Best Practices: Standardized structure following Vue.js conventions

Verification

After installation, verify that AutoVue is working correctly:

You should see the current version number. If you encounter any issues, check the Support page for troubleshooting information.