{"id":22879,"library":"vite-plugin-tauri","title":"vite-plugin-tauri","description":"Integrates Tauri into a Vite project, enabling cross-platform desktop app development with seamless dev and build workflows. Current stable version is 4.0.0, which adds support for Tauri v2 and removes the debug, verbose, and target config options in favor of CLI arguments. The plugin is actively maintained and distributed as an ESM-only package. It ships TypeScript types and requires @tauri-apps/cli >=1 and vite >=2 as peer dependencies. Key differentiators include automatic detection of Tauri project initialization, support for separate Vite configs for Tauri, and CLI argument passthrough via -- -t or --tauri syntax. Version 3.1.0 introduced a default export alongside the named export, and version 3.0.2 removed internal modification of vite clearScreen and server.open settings.","status":"active","version":"4.0.0","language":"javascript","source_language":"en","source_url":"https://github.com/amrbashir/vite-plugin-tauri","tags":["javascript","vite","vite-plugin","tauri","tauri-plugin","typescript"],"install":[{"cmd":"npm install vite-plugin-tauri","lang":"bash","label":"npm"},{"cmd":"yarn add vite-plugin-tauri","lang":"bash","label":"yarn"},{"cmd":"pnpm add vite-plugin-tauri","lang":"bash","label":"pnpm"}],"dependencies":[{"reason":"Required at runtime for Tauri CLI commands executed by the plugin","package":"@tauri-apps/cli","optional":false}],"imports":[{"note":"ESM-only; require() will fail. Default export available since v3.1.0.","wrong":"const tauri = require('vite-plugin-tauri')","symbol":"tauri (default)","correct":"import tauri from 'vite-plugin-tauri'"},{"note":"Function name is lowercase 'tauri'. The named export has been available since v1.","wrong":"import { Tauri } from 'vite-plugin-tauri'","symbol":"tauri (named)","correct":"import { tauri } from 'vite-plugin-tauri'"},{"note":"Options type is exported for TypeScript users. Use type import to avoid runtime inclusion.","wrong":"import { VitePluginTauriOptions } from 'vite-plugin-tauri'","symbol":"type definitions","correct":"import type { VitePluginTauriOptions } from 'vite-plugin-tauri'"}],"quickstart":{"code":"// vite.config.js\nimport { defineConfig } from 'vite';\nimport tauri from 'vite-plugin-tauri';\n\nexport default defineConfig({\n  plugins: [tauri()],\n  clearScreen: false,\n  server: {\n    open: false,\n  },\n});\n\n// Then in terminal:\n// pnpm add -D vite-plugin-tauri @tauri-apps/cli\n// npx tauri init\n// pnpm dev -- -t --release","lang":"javascript","description":"Shows how to install, import, and configure the plugin in a Vite config with optional but recommended settings."},"warnings":[{"fix":"Pass these options as Tauri CLI arguments, e.g., pnpm dev -- -t --verbose --release","message":"Removed debug, verbose, and target config options in v4.0.0","severity":"breaking","affected_versions":">=4.0.0"},{"fix":"Use import tauri from 'vite-plugin-tauri' instead of import { tauri } from 'vite-plugin-tauri'","message":"Named export { tauri } is still supported, but default export is preferred since v3.1.0","severity":"deprecated","affected_versions":">=3.1.0"},{"fix":"Use ES module import syntax in your project (set type:module in package.json or use .mjs files)","message":"CommonJS require() will fail because package is ESM-only","severity":"gotcha","affected_versions":">=3.0.0"},{"fix":"Manually set clearScreen: false and server.open: false in your Vite config if desired","message":"Internal modification of clearScreen and server.open was removed in v3.0.2","severity":"breaking","affected_versions":">=3.0.2"}],"env_vars":null,"last_verified":"2026-04-27T00:00:00.000Z","next_check":"2026-07-26T00:00:00.000Z","problems":[{"fix":"Run 'npm install -D vite-plugin-tauri @tauri-apps/cli'","cause":"Package not installed or in node_modules","error":"Error: Cannot find module 'vite-plugin-tauri'"},{"fix":"Switch to import statement: import tauri from 'vite-plugin-tauri' or set type:module in package.json","cause":"Using CommonJS require() on an ESM-only package","error":"Error [ERR_REQUIRE_ESM]: require() of ES Module /path/to/vite-plugin-tauri not supported."},{"fix":"Ensure you import correctly: import tauri from 'vite-plugin-tauri' (default) or import { tauri } from 'vite-plugin-tauri' (named)","cause":"Using default import incorrectly or wrong import path","error":"TypeError: tauri is not a function"},{"fix":"Use -- -t or -- --tauri before Tauri arguments: npm run dev -- -- -t --verbose","cause":"Passing Tauri CLI arguments directly to vite without -- separator","error":"error: unknown option `--verbose'"}],"ecosystem":"npm","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}