Vite+

https://viteplus.dev/guide
Admin
Vite+ is a unified toolchain for web development that manages your runtime, package manager, and...
Tokens:74,172
Snippets:657
Trust Score:7.2
Update:10 hours ago
Show doc for...
Tokens:
Raw
### Vite+ CLI default commands (vp create, install, dev, check, test, build)

Source: https://viteplus.dev/guide

Run these commands with the global CLI to create a project, install dependencies, start the dev server, run checks, run tests, and build for production. In a local-only setup, use the same commands through your package manager, e.g., `pnpm exec vp check`.

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

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

### Verify vp installation

Source: https://viteplus.dev/guide

Run this command in a new shell after installation to verify that the `vp` CLI is available and working.

```bash
vp help
```

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

### Before: Existing workflow with separate setup steps

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

Shows the original GitHub Actions workflow steps that combine pnpm, Node, and cache setup with separate run commands. This is the 'Before' example for migration to `setup-vp`.

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

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

### Install vp CLI on Windows (PowerShell)

Source: https://viteplus.dev/guide

Installs the global `vp` CLI on Windows using PowerShell. The installer reads environment variables such as `VP_VERSION` and `VP_HOME`. Alternatively, download and run `vp-setup.exe`, which is not yet code-signed and may trigger SmartScreen warnings.

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

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

### Install vp CLI on macOS/Linux

Source: https://viteplus.dev/guide

Installs the global `vp` CLI on macOS or Linux using the official install script. The script reads environment variables such as `VP_VERSION` and `VP_HOME`. After installation, open a new shell before using `vp`.

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

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

### Global CLI usage examples

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

Shows basic commands for the global CLI: pinning Node.js, installing dependencies, running scripts, and downloading a package binary. These commands work without a local vite-plus dependency.

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

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

### Quick start: enable, status, disable hooks

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

Install or refresh the dispatcher with `vp hooks enable`, check active hooks with `vp hooks status`, and turn hooks off/on in this clone. `disable` persists the decision in local git config so it survives npm install / prepare.

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

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

### vp migrate command usage examples

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

Shows common ways to run the migration command: migrate the current project, target a specific directory, run without prompts, and write agent and editor setup during migration.

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

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

### Run local vp binary via package manager

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

Run the project-local `vp` CLI binary directly from `node_modules/.bin`. The example shows `vp migrate --help` and `vp check`. Without the global CLI, prefix interactive commands with your package manager's local-binary executor, such as `pnpm exec`.

```bash
./node_modules/.bin/vp migrate --help
./node_modules/.bin/vp check
```

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

### vp hooks command examples

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

Manage the Vite+ Git hook dispatcher for the current repository. `enable` installs or refreshes the dispatcher under `<hooks-dir>/_` and sets `core.hooksPath`; `disable` tears it down and persists the decision; `status` shows preference, `core.hooksPath`, dispatcher presence, and project-owned hook scripts.

```bash
vp hooks enable
vp hooks enable --hooks-dir .custom-hooks
vp hooks disable
vp hooks status
```

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

### vp exec usage examples

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

Examples of running project-local tools with vp exec: linting with eslint and type-checking with tsc.

```bash
vp exec eslint .
```

```bash
vp exec tsc --noEmit
```

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

### Run vp migrate, install, check, and test

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

Run these commands from the workspace root before updating dependencies by hand. Keep the original lockfile and installed packages available so the migration can identify the source Vitest version. The migration stops before dependency updates for conflicting test.api and test.browser.api settings or removed runtime APIs without a supported replacement.

```bash
vp migrate
vp install
vp check
vp test
```

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

### Prefer existing Node.js and package managers during first Homebrew run

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

Run this command as the first `vp` command for a Homebrew installation to prefer your existing Node.js and package managers instead of Vite+ defaults. After setup, use `vp env off` to change this preference. Commands that need missing runtimes or project dependencies can still download them.

```bash
VP_NODE_MANAGER=no VP_PM_MANAGER=no vp help
```

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

### vp dlx usage examples

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

Examples of one-off package execution with vp dlx: scaffolding a Vite app and checking a specific version of oxlint.

```bash
vp dlx create-vite
```

```bash
vp dlx oxlint@1.85.0 --version
```

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

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

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

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

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

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

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

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

Install a preview build of the global CLI on Windows by setting the VP_PR_VERSION environment variable and running the installer. The installer resolves the ref to a 0.0.0-commit.<sha> build via the registry bridge. After testing, run `vp upgrade --force` to restore the published release.

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

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

### Install vite-plus as dev dependency (Bun)

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

Manually install `vite-plus` as a development dependency using Bun. Required when manually migrating a project to Vite+.

```bash
bun add -D vite-plus
```

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

### vp install basic usage

Source: https://viteplus.dev/guide/package-management

Run `vp install` to install dependencies for the detected package manager, including the correct lockfile flags for pnpm, npm, Yarn, and Bun.

```bash
vp install
```

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

### VP_NODE_MANAGER=no install example

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

Skips Node.js manager setup during installation, useful for CI environments.

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

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

### After: Simplified workflow with setup-vp

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

Shows the simplified GitHub Actions workflow using a single `setup-vp` step that replaces the Node, package-manager, and cache setup. The run commands use `vp` instead of `pnpm`.

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

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

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

### Azure Pipelines: Use setup-vp step template in azure-pipelines.yml

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

Reference the reusable setup-vp step template from the setup-vp repository. Create a GitHub service connection named 'github' and pin ref and setupRef to the same tag or commit SHA for strict reproducibility. The template supports Microsoft-hosted Linux, macOS, and Windows agents and uses Azure's native UseNode@1 and Cache@2 tasks to set up Node.js and cache package-manager data.

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

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

### vp create usage examples

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

Shows interactive mode, creating Vite+ monorepos/applications/libraries/generators, shorthand community templates, full package names, and remote templates.

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

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

### Install libstdc++ on Alpine Linux

Source: https://viteplus.dev/guide

Required on Alpine Linux (musl) before using Vite+ because the managed unofficial-builds Node.js runtime depends on the GNU C++ standard library.

```sh
apk add libstdc++
```

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

### vp create usage syntax

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

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

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

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

### NPM_CONFIG_REGISTRY install example

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

Installs Vite+ using a custom npm registry via the NPM_CONFIG_REGISTRY environment variable.

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

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

### GitLab CI/CD: Use setup-vp remote template in .gitlab-ci.yml

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

Include the reusable setup-vp remote template and extend the .setup-vp job. Set the remote URL and setup-ref to the same release tag or commit SHA. The template does not install Node.js, so use a Node.js image (e.g., node:24) or provide Node.js in the job. Configure dependency caching with the job's GitLab cache keyword and use a Unix-like runner with Bash and curl or wget.

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

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

### Renovate comment for commit SHA

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

When using a commit SHA in a `uses:` entry, add the exact release tag in a comment so Renovate can find updates. The comment must be in the format `# <setup-vp-version>`.

```yaml
- uses: voidzero-dev/setup-vp@<commit-sha> # <setup-vp-version>
```

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

### Build and preview workflow

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

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

### vp config command examples

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

Configure Vite+ for the current project: installs the generated Git hook dispatcher (unless hooks were disabled) and can handle agent integration. Use `--no-hooks` to leave the dispatcher unchanged, `--no-agent` to skip agent instruction updates, or both flags to skip both steps.

```bash
vp config
vp config --hooks-dir .vite-hooks
vp config --no-hooks
vp config --no-agent
```

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

### VP_NODE_MANAGER, VP_PM_MANAGER, VP_PNPM_MANAGER install example

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

Keeps system Node.js and package managers while letting Vite+ manage pnpm. Individual family variables override VP_PM_MANAGER.

```bash
# Keep system Node.js and package managers, but let Vite+ manage pnpm.
curl -fsSL https://vite.plus | VP_NODE_MANAGER=no VP_PM_MANAGER=no VP_PNPM_MANAGER=yes bash
```

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

### vp fmt CLI usage examples

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

Run `vp fmt` to format the project, `vp fmt --check` to check formatting without writing, and `vp fmt . --write` to format the current directory and write changes.

```bash
vp fmt
vp fmt --check
vp fmt . --write
```

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

### vp build usage examples

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

Shows basic usage of the `vp build` command, including watch mode and sourcemap generation.

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

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

### Override Node.js version with VP_NODE_VERSION

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

Sets the Node.js version for a command. The example runs `node -v` with version 22.

```bash
# Run a command with a specific Node.js version
VP_NODE_VERSION=22 vp env exec node -v
```

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

### Set custom CA bundle with SSL_CERT_FILE

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

Points to a PEM bundle of extra CA certificates. The example exports the variable for the current session.

```bash
export SSL_CERT_FILE=/path/to/custom-ca.pem
```

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

### createConfig.templates manifest example

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

JSON manifest at createConfig.templates in @org/create's package.json. Each entry requires name, description, and template; monorepo is optional. An invalid manifest is a hard error.

```json
{
  "name": "@your-org/create",
  "version": "1.0.0",
  "createConfig": {
    "templates": [
      {
        "name": "monorepo",
        "description": "Monorepo",
        "template": "@your-org/template-monorepo",
        "monorepo": true
      },
      {
        "name": "web",
        "description": "Web app template (Vite + React)",
        "template": "@your-org/template-web"
      },
      {
        "name": "demo",
        "description": "Bundled demo template",
        "template": "./templates/demo"
      }
    ]
  }
}
```

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

### Set download timeout with VP_DOWNLOAD_TIMEOUT

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

Sets a per-request timeout in seconds for large downloads. The example allows up to 30 minutes per download.

```bash
# Allow up to 30 minutes per download on a slow connection
VP_DOWNLOAD_TIMEOUT=1800 vp env install 22
```

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

### Enable shim debug output with VP_DEBUG_SHIM

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

Enables debug output for shim dispatch. The example runs `node -v` with debug output enabled.

```bash
VP_DEBUG_SHIM=1 node -v
```

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

### Bypass Vite+ shim with VP_BYPASS

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

Bypasses the Vite+ shim and uses the system tool. The value is a PATH-style list of directories to exclude; the example excludes /usr/local/bin.

```bash
# Find a system Node.js on PATH, excluding /usr/local/bin.
VP_BYPASS=/usr/local/bin node -v
```

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

### GitHub Actions workflow using voidzero-dev/setup-vp

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

Configures Vite+, Node.js 24, and package manager caching in a GitHub Actions workflow. Runs `vp check`, `vp test`, and `vp build`. `setup-vp` runs `vp install` by default; set `run-install: false` to disable and add a `vp install` step manually. Replace `<setup-vp-version>` with an exact version or commit SHA from the releases page; do not use the `v1` tag.

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

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

### NPM_CONFIG_REGISTRY .npmrc example

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

Shows how to set a custom npm registry and registry-scoped auth token in .npmrc. Credentials are read from environment variables to keep secrets out of the file.

```ini
registry=https://npm.corp.example/repository/npm/
//npm.corp.example/repository/npm/:_authToken=${NPM_TOKEN}
```

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

### Non-interactive inspection output and examples

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

Running `vp create @org --no-interactive` prints the manifest as a table and exits 1 when no template name is provided. The output shows available templates in the org and provides example commands for scaffolding a specific template or using a built-in template.

```text
A template name is required when running `vp create @your-org` in non-interactive mode.

Available templates in @your-org/create:

  NAME     DESCRIPTION                          TEMPLATE
  web      Web app template (Vite + React)      @your-org/template-web
  library  TypeScript library template          @your-org/template-library
  demo     Bundled demo template                ./templates/demo

Examples:
  # Scaffold a specific template from the org
  vp create @your-org:web --no-interactive

  # Or use a Vite+ built-in template
  vp create vite:application --no-interactive
```

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

### vp migrate usage examples

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

Shows the basic usage of the vp migrate command, including optional path and non-interactive mode.

```bash
vp migrate
vp migrate <path>
vp migrate --no-interactive
```

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

### Set log filter with VP_LOG

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

Sets the log filter string for `tracing_subscriber`. The example shows two commands: debug logging for `vp dev` and trace logging for `vp build`.

```bash
VP_LOG=debug vp dev
VP_LOG=vt=trace vp build
```

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

### Register JS plugin and enable its rules in vite.config.ts

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

Add the plugin file path under `lint.jsPlugins` and enable its rules via `lint.rules`. The example registers `./lint/my-plugin.js` and sets the `my/no-foo` rule to 'error'.

```ts
import { defineConfig } from 'vite-plus';

export default defineConfig({
  lint: {
    jsPlugins: ['./lint/my-plugin.js'],
    rules: {
      'my/no-foo': 'error',
    },
  },
});
```

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

### Bundled layout directory structure

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

Recommended layout for most orgs: all templates live as subdirectories of @org/create, with manifest entries using relative ./path values. One repo, one publish, one versioning story.

```text
@your-org/create/
├── package.json              # "createConfig": { "templates": [{ "template": "./templates/web" }, ...] }
├── templates/
│   ├── web/
│   │   ├── package.json
│   │   └── src/...
│   └── library/...
└── README.md
```

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

### Pass template and options to vp create via pnpm

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

Arguments are forwarded to `vp create` unchanged, so the first argument is the template, not the target directory. This example uses the `vite:application` template and `--directory my-app`.

```bash
pnpm create vite-plus vite:application --directory my-app
```

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

### vp staged command examples

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

Run staged-file checks using the `staged` config from `vite.config.ts`. Requires Node.js 22.22.1+ (22.x) or 24.11.0+, and Git 2.32.0+. `--fail-on-changes` makes the command fail if changes are detected.

```bash
vp staged
vp staged --verbose
vp staged --fail-on-changes
```
Tokens:
Raw