Skip to content

index.md

Latest commit

 

History

History
128 lines (88 loc) · 5.18 KB

index.md

File metadata and controls

128 lines (88 loc) · 5.18 KB

Getting Started

Vite+ is the unified toolchain and entry point for web development. It manages your runtime, package manager, and frontend toolchain in one place by combining Vite, Vitest, Oxlint, Oxfmt, Rolldown, tsdown, and Vite Task.

Vite+ ships in two parts: vp, the global command-line tool, and vite-plus, the local package installed in each project. If you already have a Vite project, use vp migrate to migrate it to Vite+, or paste our migration prompt into your coding agent.

Install vp

macOS / Linux

curl -fsSL https://vite.plus | bash

Windows

irm https://vite.plus/ps1 | iex

Alternatively, download and run vp-setup.exe.

::: tip 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". :::

After installation, open a new shell and run:

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. :::

::: details 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+:

apk add libstdc++

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

:::

Quick Start

Create a project, install dependencies, and use the default commands:

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 just run vp on its own and use the interactive command line.

Core Commands

Vite+ can handle the entire local frontend development cycle from starting a project, developing it, checking & testing, and building it for production.

Start

  • vp create creates new apps, packages, and monorepos.
  • vp migrate moves existing projects onto Vite+.
  • vp config configures commit hooks and agent integration.
  • vp staged runs checks on staged files.
  • vp install installs dependencies with the right package manager.
  • vp env manages Node.js versions.

Develop

Execute

  • vp run runs tasks across workspaces with caching.
  • vp cache clean clears task cache entries.
  • vpx downloads and runs binaries globally.
  • vp exec runs local project binaries.
  • vp dlx downloads and runs package binaries without adding them as dependencies.

Build

Manage Dependencies

Maintain

  • vp upgrade updates the vp installation itself.
  • vp implode removes vp and related Vite+ data from your machine.

::: 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. :::