A lightweight desktop GUI for npm registry management. Built with Tauri 2 + Vue 3 + Rust.
Switch, manage, and test npm registries — without touching the terminal.
English UI shown below. For Simplified Chinese, see README.zh-CN.md.
| Light | Dark |
|---|---|
 |
 |
| nrm-desktop | nrm (CLI) | |
|---|---|---|
| Interface | Desktop GUI | Terminal only |
| Speed test | Per-source & bulk, visual results | nrm test only |
| Categories | Drag-and-drop category management | Not supported |
| Import/Export | One-click config backup | Manual .npmrc editing |
| Tray access | System tray quick switch | Not available |
| Runtime | Tauri (Rust + WebView), ~10 MB footprint | Node.js CLI |
Registry Management
- Add, edit, delete, and switch npm registries in one click
- Preset registries out of the box (npm, yarn, taobao, etc.)
- Custom category groups with drag-and-drop reordering
Speed Testing
- Test latency for a single source or all sources at once
- Visual speed indicators for quick comparison
Workflow Tools
- Import/export registry configuration
- Registry detail dialog with quick copy (URL, latency, category, etc.)
- System tray for fast switching without opening the main window
Personalization
- Light / dark / auto theme
- Simplified Chinese / English UI
- Node.js 20.19+
- pnpm
- Rust toolchain (
rustup,cargo) - OS-specific Tauri dependencies — see Tauri v2 Prerequisites
Windows packaging requirements (for developers building installers)
Runtime (end users):
- Microsoft Edge WebView2 Runtime — preinstalled on modern Windows, or install via:
Download page
choco install microsoft-edge-webview2-runtime -y
Build tools (developers):
# Install dependencies
pnpm install
# Start in development mode
pnpm dev
# Build production installers
pnpm build| Command | Description |
|---|---|
pnpm dev |
Start desktop app in dev mode (auto port selection) |
pnpm build |
Build desktop binaries/installers |
pnpm build:win |
Build Windows installer only |
pnpm ui:dev |
Start Vite frontend dev server only |
pnpm ui:build |
Type-check and build frontend only |
pnpm lint |
ESLint check |
pnpm test |
Vitest unit tests |
pnpm tauri |
Pass-through Tauri CLI |
pnpm update:logo |
Generate icon set from src-tauri/icons/logo.png |
pnpm version |
Sync app version metadata |
Cross-platform installers are built in CI — no need to switch between Windows and macOS machines.
- Develop on
dev, then merge intomain(PR or direct merge). - Open Actions → Release Installers → Run workflow on
main. - Enter version (e.g.
1.0.1), optionally enable draft_release, overwrite_release, cleanup_release_assets, and choose platforms/installer formats, then run. - CI will bump versions, archive changelogs, commit to
main, build installers, create a GitHub Release, and merge the release commit back intodev. - Locally:
git checkout dev && git pull origin devto continue development. If pull fails withwould clobber existing tag, runpnpm sync:tagsfirst (this repo setsgit.fetchTags: falsein.vscode/settings.json, so a normal pull usually works).
Retry / overwrite the same version:
| Scenario | What to do |
|---|---|
| First publish failed and no GitHub Release exists for that version | Re-run the workflow with the same version; CI uses retry mode and skips bumping version or archiving changelogs |
| Release already exists and you need to re-upload installers | Enable overwrite_release; version must match the current package.json version; CI overwrites release assets and retargets the tag to the latest build commit |
| Duplicate or legacy-named installers on the release need cleanup | Enable cleanup_release_assets (often together with overwrite_release); removes all nrm-desktop* assets for that version before upload |
| Release exists but overwrite is not enabled | The workflow fails at the pre-check step with a clear message |
Retry and overwrite runs do not sync a release commit to dev (no new bump commit is created).
Default release artifacts: Windows setup.exe, .msi, portable.zip, and macOS Apple Silicon .dmg; uncheck any formats you do not want to publish.
Before releasing, edit docs/release-install-guide.release.md (short English Downloads section on the Release page), and docs/release-install-guide.md / docs/release-install-guide.zh-CN.md (full install docs linked from the Release). The Release body has two sections — Release Notes and Downloads — all in English by default; each section ends with links to the full English doc and a Chinese doc (e.g. 完整更新日志, 安装说明).
Open Actions → Build Installers → Run workflow and choose platforms and Windows artifacts. Uploads Artifacts only (14-day retention) for testing packaging options.
- Settings → Actions → General → Workflow permissions: enable Read and write permissions.
- If branch protection is enabled on
mainordev, allowgithub-actions[bot]to push (or configure a PAT secret for release commits).
| Layer | Technology |
|---|---|
| Frontend | Vue 3, TypeScript, Pinia, Element Plus, UnoCSS, Vite |
| Desktop | Tauri 2 |
| Backend | Rust (reqwest, tokio) |
src/ # Vue frontend
components/ # UI modules (registry list, cards, dialogs)
composables/ # Reusable hooks (i18n, animation, behavior)
stores/ # Pinia state management
api/ # Tauri command wrappers
src-tauri/
src/ # Rust backend (npmrc ops, speed test, tray, proxy)
icons/ # App icon assets
scripts/ # Dev/build helpers (auto-port, icon gen, version sync)
docs/images/ # README screenshots
| Path | Content |
|---|---|
~/.nrm-desktop/ |
Custom registries and metadata |
~/.npmrc |
npm config managed by the app |
~/.nrm-desktop/.instance.lock |
Single-instance lock |
- Fork and create a feature branch
- Make focused changes with clear commit messages
- Run
pnpm devand verify locally - Open a PR with a concise description