create-electronup

Creates a project template powered by electronup.

Templates: vanilla, vue, react, react-swc and solid, each mapped to a branch of electronup-template.

Create a project

pnpm create electronup

Or with npm:

npm create electronup@latest

Project name and template can be passed directly:

pnpm create electronup my-app --template vue

-t is the short form of --template. Without a project name, the CLI asks:

? Project name: » electronup-project

Use . to scaffold into the current directory. If the directory is not empty, the CLI asks before clearing it (.git is kept); pass --overwrite to clear it without asking.

After fetching, the CLI rewrites name in package.json to the project directory name (normalized when it is not a valid package name, e.g. My App → my-app). electron-builder derives the default appId from it, so projects no longer share one appId.

CLI options

Option	Description
[project dir]	Project directory; asked for when omitted
-t, --template <template>	Use the given template and skip selection
--overwrite	Clear a non-empty target directory without asking (.git is kept)
--mirror <url>	Fetch the template through a GitHub mirror; the CREATE_ELECTRONUP_MIRROR environment variable does the same
-h, --help	Show help

The process exits with code 1 when cancelled or when fetching the template fails.

Templates

Template	Description
vanilla	Vanilla TypeScript + Vite
vue	Vue 3
react	React + TypeScript
react-swc	React + TypeScript + SWC
solid	Solid

Choosing react interactively triggers a follow-up question about the TypeScript or SWC variant; passing -t react or -t react-swc skips it.

Template source

Templates are not bundled; the matching branch is fetched on demand with giget:

https://github.com/QuiteerJs/electronup-template.git#<template>

GitHub access is required when creating a project (HTTPS_PROXY is honored). If GitHub is slow or unreachable, pass --mirror or set CREATE_ELECTRONUP_MIRROR. The mirror replaces the https://github.com part, and the CLI downloads <mirror>/QuiteerJs/electronup-template/archive/refs/heads/<template>.tar.gz, so both host-swapping mirrors and prefix proxies work:

pnpm create electronup my-app -t vue --mirror https://kkgithub.com
CREATE_ELECTRONUP_MIRROR=https://ghfast.top/https://github.com pnpm create electronup my-app -t vue

Mirrors are run by third parties; check that one works for you. If fetching fails, the CLI prints the matching git clone command so you can clone the branch manually.

After creation

The CLI only fetches the template; it does not install dependencies. Templates pin pnpm through the packageManager field and pnpm-lock.yaml, so the CLI always suggests pnpm, whichever package manager ran it (run corepack enable if pnpm is not installed):

cd my-app
pnpm install
pnpm dev