Setup prompt

I want to use Vite+ in my project. Vite+ is the unified toolchain for the web behind the `vp` CLI — one tool combining Vite, Rolldown, Vitest, tsdown, Oxlint, Oxfmt, and Vite Task, plus runtime and package-manager management.

First, read https://pr-2684-viteplus-dev.voidzero-docs.workers.dev/llms-full.txt to learn Vite+'s commands and configuration.

Install the `vp` CLI if it's not already on the system:
- macOS / Linux: curl -fsSL https://pr-2684-viteplus-dev.voidzero-docs.workers.dev/install.sh | bash
- Windows (PowerShell): irm https://pr-2684-viteplus-dev.voidzero-docs.workers.dev/install.ps1 | iex

Then open a new terminal and run `vp help`. To scaffold a new project run `vp create`; to move an existing Vite project onto Vite+ run `vp migrate`.

Day-to-day commands: `vp install` (dependencies), `vp dev` (dev server), `vp check` (format + lint + type-check), `vp test` (tests), and `vp build` (production build).

Help me get set up and explain anything I should know.
Skip to content

Getting Started

Vite+ is the unified toolchain and entry point for web development.

It brings together Vite, Vitest, Oxlint, Oxfmt, Rolldown, tsdown, and Vite Task in a single vite-plus package for a blazing fast frontend toolchain.

Vite+ also ships a global vp CLI that manages Node.js and package managers and makes Vite+ easier to use across projects. You can use either CLI independently, but we recommend using them together.

If you already have a Vite project, run vp migrate to migrate it to Vite+, or give your coding agent our migration prompt.

Building with an AI assistant? View and copy a ready-made setup prompt:

Install vp Globally

The commands below install the global vp CLI, which manages Node.js and package managers and makes vp available across projects. If you only need the frontend toolchain in a single project, you can install the project-local CLI instead.

macOS / Linux

bash
curl -fsSL https://pr-2684-viteplus-dev.voidzero-docs.workers.dev/install.sh | bash

Windows

powershell
irm https://pr-2684-viteplus-dev.voidzero-docs.workers.dev/install.ps1 | iex

Alternatively, download and run vp-setup.exe.

SmartScreen warning

The vp-setup.exe is not yet code-signed. Your browser may show a warning when downloading. Click "...""Keep""Keep anyway" to proceed. If Windows Defender SmartScreen blocks the file when you run it, click "More info""Run anyway".

The installer scripts and vp-setup.exe read environment variables such as VP_VERSION and VP_HOME.

After installation, open a new shell and run:

bash
vp help

INFO

Vite+ will manage your global Node.js runtime and package manager. If you'd like to opt out of this behavior, run vp env off. If you realize Vite+ is not for you, type vp implode, but please share your feedback with us.

Using a minor platform (CPU architecture, OS) ?

Prebuilt binaries are distributed for the following platforms (grouped by Node.js v24 platform support tier):

  • Tier 1
    • Linux x64 glibc (x86_64-unknown-linux-gnu)
    • Linux arm64 glibc (aarch64-unknown-linux-gnu)
    • Windows x64 (x86_64-pc-windows-msvc)
    • macOS x64 (x86_64-apple-darwin)
    • macOS arm64 (aarch64-apple-darwin)
  • Tier 2
    • Windows arm64 (aarch64-pc-windows-msvc)
  • Experimental
    • Linux x64 musl (x86_64-unknown-linux-musl)
  • Other
    • Linux arm64 musl (aarch64-unknown-linux-musl)

If a prebuilt binary is not available for your platform, installation will fail with an error.

On Alpine Linux (musl), you need to install libstdc++ before using Vite+:

sh
apk add libstdc++

This is required because the managed unofficial-builds Node.js runtime depends on the GNU C++ standard library.

Quick Start

With the global CLI installed, create a project, install dependencies, and use the default commands:

bash
vp create # Create a new project
vp install # Install dependencies
vp dev # Start the dev server
vp check # Format, lint, type-check
vp test # Run JavaScript tests
vp build # Build for production

You can also run vp on its own to open the interactive command line. In a local-only setup, run the same commands through your package manager, such as pnpm exec vp check.

Core Commands

Vite+ covers the full frontend development cycle, from starting a project through development, checks, tests, and production builds. Most commands are available from both distributions; machine-level environment and self-management commands require the global CLI.

Set Up a Project

Project Toolchain

  • vp check runs format, lint, and type checks together.
  • vp lint and vp fmt run the individual checks directly.
  • vp test runs tests with Vitest.
  • vp dev starts the development server powered by Vite.
  • vp build builds apps, and vp preview previews the production build locally.
  • vp pack builds libraries or standalone artifacts.
  • vp toolchain shows the active project toolchain; use --global to inspect the global installation instead.
  • vp run runs tasks across workspaces with caching.
  • vp cache clean clears task cache entries.
  • vp exec runs local project binaries, while vp dlx and vpx download and run package binaries.
  • vp config installs the Git hook dispatcher and configures agent integration.
  • vp hooks manages the Git hook dispatcher, and vp staged runs checks on staged files.
  • Monorepo Guide covers multi-package project structure and commands.

Global CLI

  • vp env manages Node.js and package-manager environments, and vp node runs scripts with the resolved environment.
  • vp upgrade updates the global vp installation itself.
  • vp implode removes the global vp installation and related Vite+ data from your machine.

Workflow

Reference

  • Troubleshooting covers common command, configuration, and integration problems.

INFO

Vite+ ships with many predefined commands such as vp build, vp test, and vp dev. These commands are built-in and cannot be changed. If you want to run a command from your package.json scripts, use vp run <command> or vpr <command>.

Learn more about vp run.