Registry / devops / vite-electron-app

vite-electron-app

JSON →
library1.4.0jsnpmunverified

vite-electron-app is a CLI tool (v1.4.0) for scaffolding Electron + Vite + React + TypeScript desktop applications. It generates a minimalistic, secure-by-default project structure with hot reload, Electron Builder packaging, Vitest testing, and organized separation of concerns. The tool uses npx for instant scaffolding without global install and is idempotent, allowing multiple runs without duplication. Active development with regular releases on npm. Differentiators include native TypeScript, React with Vite, and built-in security against dangerous files.

devops
npm install vite-electron-app
github ↗package ↗
INSTALL
IMPORT
SIG · VITE-ELECTRON-APP
V
vite-electron-app
devopsjavascriptv1.4.0
Install
—
Import
—
Disk
—
Pass rate
0/ 6
Env Coverage0 / 6
glibc
18–22
musl
18–22
Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
node 18–223 runs
build_error
glibc
node 18–223 runs
build_error
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

vite-electron-app
✓ npx vite-electron-app <project-name>
✗ npm install -g vite-electron-app && vite-electron-app <project-name>
Recommended usage is via npx to avoid global install pollution. Global install is still supported but not recommended.

Scaffold, install dependencies, and start development server for a new Electron + Vite + React app.

npx vite-electron-app my-app cd my-app pnpm install pnpm dev
vite-electron-app --version
Debug
Known issues
gotchaRequires Node.js >= 18 and pnpm (not npm) for best results.
fix
Use Node.js 18+ and install pnpm via 'npm install -g pnpm'.
affects: >=1.0
deprecatedThe global install pattern is deprecated; usage via npx is now the primary method.
fix
Use npx instead of global install.
affects: >=1.0
breakingIn version 1.4.0, the project structure changed: templates now use Electron Builder for packaging instead of electron-forge.
fix
If upgrading from older versions, migrate packaging setup to Electron Builder.
affects: >=1.4.0
gotchaIf the target directory already exists, the tool will prompt to overwrite. But if you answer 'yes', the directory contents are replaced.
fix
Ensure you have backups or use a fresh directory name.
affects: >=1.0
Errors
Common errors & fixes
Error: Cannot find module '../src/index' from 'vite-electron-app'
Running the CLI from a wrong directory or missing dependencies.
fix
Run 'npx vite-electron-app' from a clean project directory after installing dependencies with pnpm.
zsh: command not found: npx
npx is not available in the shell (usually due to missing npm or Node.js).
fix
Install Node.js (version 18+) via https://nodejs.org or nvm.
Failed to install dependencies: The pnpm command was not found
pnpm is not installed.
fix
Install pnpm globally by running 'npm install -g pnpm'.
Upgrade
Version history
1.4.0latest on npm
Audit
Dependencies
commanderrequiredCLI command parsing
inquirerrequiredInteractive prompts for project configuration
Agent activity
4 hits · last 30 days
node
4
Resources
githubhttps://github.com/joaomjbraga/vite-electron-app ↗
packagehttps://www.npmjs.com/package/vite-electron-app ↗
vite-electron-app — npm install vite-electron-app · libregistry