Vite+

https://viteplus.dev/
Admin
Vite+ is a unified toolchain for web development that manages runtime, package manager, and frontend...
Tokens:81,436
Snippets:784
Trust Score:7.2
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### Quick Start Commands

Source: https://viteplus.dev/guide

Run these commands in order to create a new project, install dependencies, start the dev server, run checks, tests, and build for production. The `vp` CLI must be installed globally.

```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
```

--------------------------------

### vp env command examples

Source: https://viteplus.dev/guide/env

Shows the full set of vp env subcommands for setup, management, inspection, and execution. Use these commands to pin project versions, manage global defaults, override session versions, clean unused versions, inspect the current environment, and run commands with specific versions.

```bash
# Setup
vp env setup                  # Create Node.js and package-manager shims
vp env on                     # Manage Node.js and package managers
vp env off pm                 # Prefer system package managers only
vp env off pnpm               # Prefer system pnpm only
vp env print                  # Print PATH setup for both components

# Manage
vp env pin lts pnpm@10        # Pin both project components to exact versions
vp env install                # Install the complete resolved environment
vp env default node@24        # Set the global Node.js default
vp env default pnpm@10        # Set pnpm's global default version
vp env use 20 pnpm@10         # Override both components for this shell
vp env use --unset pnpm       # Remove only the pnpm session version
vp env use --unset pm         # Remove all package-manager session versions
vp env clean                  # Remove unused managed Node.js and package manager versions

# Inspect
vp env current                # Show current resolved environment
vp env current --json         # JSON output for automation
vp env which node             # Show which node binary will be used
vp env which npx              # Show pinned package-manager alias when packageManager matches
vp env list                   # Show every locally installed component
vp env list node              # Show only Node.js installations
vp env list-remote --lts      # List only Node.js LTS versions

# Execute
vp env exec --node lts --package-manager pnpm@10 pnpm install
vp env exec node -v           # Use shim mode with automatic version resolution
vp node script.js             # Shorthand: run a Node.js script with the resolved version
vp node -e "console.log(1+1)" # Shorthand: forward any node flag or argument
```

--------------------------------

### Check vp installation with help command

Source: https://viteplus.dev/guide/global-cli

Run `vp help` after installation to verify the CLI is available. This is a basic command to confirm the installation.

```bash
vp help
```

--------------------------------

### vp migrate command examples

Source: https://viteplus.dev/guide/migrate

Shows various ways to run the vp migrate command: migrate the current project, migrate a specific directory, run without prompts using --no-interactive, and write agent and editor setup with --agent and --editor flags.

```bash
# Migrate the current project
vp migrate

# Migrate a specific directory
vp migrate my-app

# Run without prompts
vp migrate --no-interactive

# Write agent and editor setup during migration
vp migrate --agent claude --editor zed
```

--------------------------------

### Install global CLI on Windows

Source: https://viteplus.dev/guide/global-cli

Installs the `vp` binary using PowerShell's `irm` and `iex`. Requires a new shell after installation.

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

--------------------------------

### Migrate CI workflow: Before

Source: https://viteplus.dev/guide/ci

Example of a standard GitHub Actions workflow setup using individual actions for pnpm and Node.js.

```yaml
- uses: pnpm/action-setup@v6
  with:
    version: 11

- uses: actions/setup-node@v6
  with:
    node-version: '24'
    cache: pnpm

- run: pnpm ci && pnpm dev:setup
- run: pnpm check
- run: pnpm test
```

--------------------------------

### Quick start: vp hooks commands

Source: https://viteplus.dev/guide/commit-hooks

Install or refresh the dispatcher with vp hooks enable, check active hooks with vp hooks status, disable hooks in the clone with vp hooks disable (survives npm install / prepare), and re-enable with vp hooks enable.

```bash
# Install or refresh the dispatcher
vp hooks enable

# Check what is active in this clone
vp hooks status

# Turn hooks off in this clone (survives npm install / prepare)
vp hooks disable

# Turn them back on
vp hooks enable
```

--------------------------------

### package.json scripts example

Source: https://viteplus.dev/guide/run

Example package.json with build and test scripts that can be run with `vp run`.

```json
{
  "scripts": {
    "build": "node compile-legacy-app.js",
    "test": "jest"
  }
}
```

--------------------------------

### vp exec usage examples

Source: https://viteplus.dev/guide/vpx

Examples of using vp exec to run project-local binaries.

```bash
vp exec eslint .
vp exec tsc --noEmit
```

--------------------------------

### Install global vp preview with VP_PR_VERSION (PowerShell)

Source: https://viteplus.dev/guide/upgrade

Windows equivalent of the bash installer. Sets `VP_PR_VERSION` environment variable, runs the installer, then removes the variable. The installer uses the registry bridge to resolve the ref to a `0.0.0-commit.<sha>` build.

```powershell
$env:VP_PR_VERSION = "<pr-or-sha>"
irm https://vite.plus/ps1 | iex
Remove-Item Env:\VP_PR_VERSION
```

--------------------------------

### Install global vp preview with VP_PR_VERSION (bash)

Source: https://viteplus.dev/guide/upgrade

Installs a preview build of the global CLI by passing a pull request number or commit SHA via `VP_PR_VERSION`. The installer resolves the ref to a `0.0.0-commit.<sha>` build. After testing, run `vp upgrade --force` to restore the published release.

```bash
curl -fsSL https://vite.plus | VP_PR_VERSION=<pr-or-sha> bash
```

--------------------------------

### vp dlx usage examples

Source: https://viteplus.dev/guide/vpx

Examples of using vp dlx for one-off package execution.

```bash
vp dlx create-vite
vp dlx typescript tsc --version
```

--------------------------------

### Migrate CI workflow: After

Source: https://viteplus.dev/guide/ci

Simplified workflow using the setup-vp action to replace multiple setup steps and run commands.

```yaml
- uses: voidzero-dev/setup-vp@<setup-vp-version>
  with:
    node-version: '24'
    cache: true

- run: vp install && vp run dev:setup
- run: vp check
- run: vp test
```

--------------------------------

### Basic install command

Source: https://viteplus.dev/guide/install

Runs the install command for the detected package manager.

```bash
vp install
```

--------------------------------

### Install global CLI on macOS/Linux

Source: https://viteplus.dev/guide/global-cli

Installs the `vp` binary using curl. Requires a new shell after installation. The command is `curl -fsSL https://vite.plus | bash`.

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

--------------------------------

### vpx usage examples

Source: https://viteplus.dev/guide/vpx

Examples of using vpx to run local binaries, download packages on demand, target a specific version, and use shell mode with additional packages.

```bash
vpx eslint .
vpx create-vue my-app
vpx typescript@5.5.4 tsc --version
vpx -p cowsay -c 'echo "hi" | cowsay'
```

--------------------------------

### Common install flows

Source: https://viteplus.dev/guide/install

Shows common variations of the install command, including frozen lockfile, lockfile-only, filtering to a specific workspace, and workspace-wide install.

```bash
vp install
vp install --frozen-lockfile
vp install --lockfile-only
vp install --filter web
vp install -w
```

--------------------------------

### Example execution summary output

Source: https://viteplus.dev/guide/run

Example output from the `-v` flag showing the execution summary format, including statistics, performance, and task details with cache hit information.

```text
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
    Vite+ Task Runner • Execution Summary
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Statistics:   3 tasks • 3 cache hits • 0 cache misses
Performance:  100% cache hit rate, 468ms saved in total

Task Details:
────────────────────────────────────────────────
  [1] @my/core#build: ~/packages/core$ vp build ✓
      → Cache hit - output replayed - 200ms saved
  ·······················································
  [2] @my/utils#build: ~/packages/utils$ vp build ✓
      → Cache hit - output replayed - 150ms saved
  ·······················································
  [3] @my/app#build: ~/packages/app$ vp build ✓
      → Cache hit - output replayed - 118ms saved
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
```

--------------------------------

### Install and validate migrated project with pnpm or npm

Source: https://viteplus.dev/guide/migrate

Finish dependency installation and validate the migrated project with the updated local CLI. Use vp pack instead of vp build for a library that uses the pack command. Run configured browser, coverage, and benchmark suites as well.

```bash
pnpm install
pnpm exec vp check
pnpm exec vp test
pnpm exec vp build
```

```bash
npm install
npm exec -- vp check
npm exec -- vp test
npm exec -- vp build
```

--------------------------------

### vp run build output

Source: https://viteplus.dev/guide/run

Output of running `vp run build` with the example package.json.

```text
$ node compile-legacy-app.js

building legacy app for production...

✓ built in 69s
```

--------------------------------

### Cache sharing example in package.json

Source: https://viteplus.dev/guide/cache

Shows how compound commands can share cache entries when the same command runs with the same inputs.

```json
{
  "scripts": {
    "check": "vp lint && vp build",
    "release": "vp lint && deploy-script"
  }
}
```

--------------------------------

### Set VP_VERSION for Unix installer

Source: https://viteplus.dev/guide/global-cli

Sets the `VP_VERSION` environment variable to install a specific version. The default is `latest`. This example installs version 1.2.3.

```bash
# Unix
curl -fsSL https://vite.plus | VP_VERSION=1.2.3 bash
```

--------------------------------

### Build and preview production build

Source: https://viteplus.dev/guide/build

Run `vp build` to create the production build, then `vp preview` to serve it locally.

```bash
vp build
vp preview
```

--------------------------------

### Set VP_VERSION for PowerShell installer

Source: https://viteplus.dev/guide/global-cli

Sets the `VP_VERSION` environment variable in PowerShell to install a specific version. The default is `latest`. This example installs version 1.2.3.

```powershell
# PowerShell
$env:VP_VERSION = "1.2.3"; irm https://vite.plus/ps1 | iex
```

--------------------------------

### Skip Node.js manager setup with VP_NODE_MANAGER

Source: https://viteplus.dev/guide/global-cli

Sets `VP_NODE_MANAGER=no` to skip Node.js version manager setup during installation. Useful for CI environments. The default is auto-detected.

```bash
# Skip Node.js manager setup in CI
curl -fsSL https://vite.plus | VP_NODE_MANAGER=no bash
```

--------------------------------

### vp create usage examples

Source: https://viteplus.dev/guide/create

Shows the various ways to use the `vp create` command: interactive mode, Vite+ templates, community shorthand, full package names, and remote templates. The Vite+ shorthand resolves to the equivalent community package.

```bash
# Interactive mode
vp create

# Create a Vite+ monorepo, application, library, or generator
vp create vite:monorepo
vp create vite:application
vp create vite:library
vp create vite:generator

# Use shorthand community templates
vp create vite
vp create @tanstack/start
vp create svelte

# Use full package names
vp create create-vite
vp create create-next-app

# Use remote templates
vp create github:user/repo
vp create https://github.com/user/template-repo
```

--------------------------------

### Set NPM_CONFIG_REGISTRY for Unix installer

Source: https://viteplus.dev/guide/global-cli

Sets a custom npm registry URL. The default is `https://registry.npmjs.org`. This example uses the npmmirror registry.

```bash
curl -fsSL https://vite.plus | NPM_CONFIG_REGISTRY=https://registry.npmmirror.com bash
```

--------------------------------

### Run vp check without global installation (npm)

Source: https://viteplus.dev/

Runs `vp check` using the project's package manager via npm exec. Replace with the appropriate command for your setup.

```bash
npm exec -- vp check
```

--------------------------------

### Run vp dev with defaultPackage set

Source: https://viteplus.dev/guide/monorepo

With `defaultPackage` set, `vp dev` uses the configured directory and prints a note.

```bash
$ vp dev
note: vp dev: using ./apps/web (defaultPackage in vite.config.ts)

  VITE+ v0.2.2

  ➜  Local:   http://localhost:5173/
```

--------------------------------

### vp create usage

Source: https://viteplus.dev/guide/create

Shows the basic usage of the `vp create` command, including optional template and template-options arguments.

```bash
vp create
vp create <template>
vp create <template> -- <template-options>
```

--------------------------------

### Run vp check without global installation (pnpm)

Source: https://viteplus.dev/

Runs `vp check` using the project's package manager via pnpm exec. Replace with the appropriate command for your setup.

```bash
pnpm exec vp check
```

--------------------------------

### Create from an org template with vp create

Source: https://viteplus.dev/guide/create

Use these commands to create projects from an organization's template manifest. The `@org` form opens an interactive picker, `@org:name` runs a specific entry, and `@org@version` or `@org:name@tag` pins versions. Running `vp create` with no arguments sets the org as the default for the repo.

```bash
# Open an interactive picker over @your-org/create's manifest
vp create @your-org

# Run a specific manifest entry directly
vp create @your-org:web

# Pin to an exact version or a dist-tag
vp create @your-org@1.2.3
vp create @your-org:web@next

# Set the org as the default for a repo (see create.defaultTemplate config)
vp create
```

--------------------------------

### PowerShell: Dot-source Vite+ environment setup script

Source: https://viteplus.dev/guide/env

Required in the current PowerShell session before `vp env use` can affect only that shell session. Add to the end of `$PROFILE` to apply automatically in new shells; no elevated privileges needed. If an older install uses `%USERPROFILE%\.vite-plus`, source the `env.ps1` in that directory instead.

```powershell
. "$env:APPDATA\vite-plus\env.ps1"
```

--------------------------------

### Vitest v4 compatibility: clearMocks: false

Source: https://viteplus.dev/guide/vitest-v5

Compatibility setting added by the migration for v4 configs. It preserves mock call history by setting clearMocks to false, with comments explaining the reason and linking to the cleanup checklist and Vitest migration guide. Remove it after tests no longer rely on calls from setup or earlier tests.

```ts
test: {
  // Vitest v4 compatibility: preserve mock call history.
  // Remove after tests no longer rely on calls from setup or earlier tests.
  // https://viteplus.dev/guide/vitest-v5#remove-unneeded-compatibility-settings
  // https://vitest.dev/guide/migration/#clearmocks-is-enabled-by-default
  clearMocks: false,
}
```

--------------------------------

### Run vp build with options

Source: https://viteplus.dev/guide/build

Basic usage of `vp build` with optional flags: `--watch` for watch mode and `--sourcemap` to generate source maps.

```bash
vp build
vp build --watch
vp build --sourcemap
```

--------------------------------

### Run vp migrate help without global installation (npx)

Source: https://viteplus.dev/

Runs `vp help migrate` for the 1.0.0-rc.0 release using npx. Replace 1.0.0-rc.0 with the intended release version.

```bash
npx --package=vite-plus@1.0.0-rc.0 vp help migrate
```

--------------------------------

### Configure GitLab CI/CD with setup-vp

Source: https://viteplus.dev/guide/ci

Use the setup-vp remote template in .gitlab-ci.yml. Ensure the remote URL and setup-ref match the desired release tag or commit SHA, and provide a Node.js image as the template does not install it.

```yaml
include:
  - remote: 'https://raw.githubusercontent.com/voidzero-dev/setup-vp/<setup-vp-version>/gitlab/setup-vp.yml'
    inputs:
      setup-ref: '<setup-vp-version>'

test:
  extends: .setup-vp
  image: node:24
  script:
    - vp check
    - vp test
    - vp build
```

--------------------------------

### Configure Azure Pipelines with setup-vp

Source: https://viteplus.dev/guide/ci

Reference the setup-vp template in azure-pipelines.yml after creating a GitHub service connection named 'github'. Pin ref and setupRef to the same tag or commit SHA for reproducibility.

```yaml
resources:
  repositories:
    - repository: setupVp
      type: github
      endpoint: github
      name: voidzero-dev/setup-vp
      ref: refs/tags/<setup-vp-version>

pool:
  vmImage: ubuntu-latest

steps:
  - checkout: self
  - template: azure/setup-vp.yml@setupVp
    parameters:
      setupRef: '<setup-vp-version>'
      nodeVersion: 24.x
      cache: true
      runInstall: true
  - script: vp check
  - script: vp test
  - script: vp build
```

--------------------------------

### Upgrade Vite+ via Homebrew

Source: https://viteplus.dev/guide/upgrade

Updates Homebrew-managed Vite+ installations. vp upgrade detects Homebrew installations and directs you to this command without downloading or installing another version.

```bash
brew upgrade vite-plus
```

--------------------------------

### Set VP_DATA_DIR, VP_BIN_DIR, VP_CACHE_DIR for Unix installer

Source: https://viteplus.dev/guide/global-cli

Sets the internal directory overrides for a split install. All three variables must be set together; the installer rejects an incomplete group. These variables are not persisted in the generated environment file.

```bash
export VP_DATA_DIR=$HOME/vite-plus-data
export VP_BIN_DIR=$VP_DATA_DIR/bin
export VP_CACHE_DIR=$HOME/.cache/vite-plus
curl -fsSL https://vite.plus | bash
```

--------------------------------

### Create a new Vite+ project

Source: https://viteplus.dev/

Initializes a new Vite+ project, prompting for a template and project directory. Installs dependencies and prints next steps.

```bash
$ vp create
◇ Select a template vite:application
◇ Project directory vite-app
• Node 24.14.0 pnpm 10.28.0
✓ Dependencies installed in 1.1s
→ Next: cd vite-app && vp dev
```

--------------------------------

### .gitlab-ci.yml: browser test job with Playwright install

Source: https://viteplus.dev/guide/docker

GitLab CI job for browser-mode tests with Playwright. Uses vp exec to run the project's own Playwright and install Chromium with system dependencies; the vp user has passwordless sudo for apt-get installs. Prefer vp exec over vpx playwright install to match the lockfile's browser revision.

```yaml
test:
  image: ghcr.io/voidzero-dev/vite-plus:latest
  script:
    - vp install --frozen-lockfile
    - vp exec playwright install --with-deps chromium
    - vp test
```

--------------------------------

### Run vp create without global installation (npx)

Source: https://viteplus.dev/

Runs `vp create` for the 1.0.0-rc.0 release using npx. Replace 1.0.0-rc.0 with the intended release version.

```bash
npx --package=vite-plus@1.0.0-rc.0 vp create
```

--------------------------------

### Global CLI commands for common workflows

Source: https://viteplus.dev/guide/global-cli

Use these commands with the global installation for pinning Node.js, installing dependencies, running scripts, and downloading binaries. No local dependency is required.

```bash
vp env pin lts       # Pin and install Node.js for this project
vp install           # Use the package manager declared by the project
vp run build         # Run a package.json script or configured task
vp dlx create-vite   # Download and run a package binary
```

--------------------------------

### Create a project with vp create using different package managers

Source: https://viteplus.dev/guide/local-cli

Use these commands to scaffold a new project with Vite+ via your package manager's remote execution tool. Each command runs the `vp create` command from the `vite-plus` package without installing it globally.

```bash
pnpm dlx --package=vite-plus vp create
```

```bash
npx --package=vite-plus vp create
```

```bash
yarn dlx --package vite-plus vp create
```

```bash
bunx --package vite-plus vp create
```

--------------------------------

### Set VP_HOME for Unix installer

Source: https://viteplus.dev/guide/global-cli

Sets the `VP_HOME` environment variable to pin the single-root layout to an absolute path. The default is unset, and Vite+ reuses an existing install in `~/.vite-plus`.

```bash
# Unix
curl -fsSL https://vite.plus | VP_HOME=/opt/vite-plus bash
```

--------------------------------

### Install vite-plus as dev dependency

Source: https://viteplus.dev/guide/local-cli

Manually install the `vite-plus` package as a development dependency using the local `vp` CLI. This records the toolchain version in the project manifest and lockfile.

```bash
vp install -D vite-plus
```

--------------------------------

### Run vp migrate help without global installation (pnpm)

Source: https://viteplus.dev/

Runs `vp help migrate` for the 1.0.0-rc.0 release using pnpm dlx. Replace 1.0.0-rc.0 with the intended release version.

```bash
pnpm dlx --package=vite-plus@1.0.0-rc.0 vp help migrate
```
Tokens:
Raw