VCPChat Project Entry Points

August 22, 2026 · View on GitHub

This document is the source of truth for how the repository is started, repaired, tested, and packaged. Older scripts remain available for compatibility, but they are not all release entry points.

AudienceEntry pointPurposeRelease status
End user, source checkoutlaunchers/VCPChat-Launcher.vbs (Windows), launchers/VCPChat-Launcher.command (macOS), launchers/VCPChat-Launcher.sh (Linux)Open the graphical setup/recovery flow for the current checkoutSupported source launcher
End user, portable bootstrapnpm run installer:portable → root VCPChat-Setup.exeDouble-click from the project root; it checks/prepares the VCPChat source and starts the appSupported Windows delivery; no system installation
Developernpm run vcpchatDiagnose, optionally repair with explicit consent, then launchSupported CLI
Developer, direct debuggingnpm startRun Electron directly and keep the existing debugging behaviorCompatibility/debug only
CI/package validationnpm run check:release-surfaceValidate required entrypoints, manifests, locks, and artifact namingRequired gate

Artifact Ownership

  • apps/bootstrap-installer/ owns the standalone Tauri Setup application. Windows delivery is the root-level portable VCPChat-Setup.exe; no NSIS/MSI installer is part of the release surface.
  • main.js, renderer.js, and the root Electron package own the desktop app.
  • scripts/vcpchat.mjs owns the consent-aware managed CLI state machine.
  • scripts/vcpchat-dev-launcher.mjs owns the lower-level managed Electron handoff.
  • bootstrap/ owns the legacy Recovery UI. It is retained for development and recovery compatibility, not presented as the production installer.
  • start.bat, 启动Vchat.vbs, 启动全部.vbs, start-desktop.vbs, and start-rag-observer.vbs remain compatibility/debug entries. They must not be used as release evidence.

Build Outputs

OutputCommandLocationVerification
Tauri portable bootstrapnpm run installer:portableVCPChat-Setup.exe at repository rootnpm run check:release-surface
Electron unpacked packagenpm run packdist/npm run test:packed-install
Offline Web Awesome closurenpm run pack:checkvendor/webawesome-runtime/npm run pack:check

Build directories, node_modules, user data, logs, runtime databases, and local state are not release inputs and must not be committed as product evidence.

Windows Test Order

  1. Run launchers/VCPChat-Launcher.vbs from a clean source checkout.
  2. Click the setup flow's prepare action and wait for Doctor, dependency repair, native rebuild, and final Doctor.
  3. Verify the setup window exits only after operation-scoped renderer-ready.
  4. Verify the root-level VCPChat-Setup.exe launches without an installation step.
  5. Record remaining warnings separately from blocking failures.

Compatibility Policy

The legacy direct launchers are intentionally not deleted in this milestone. They are kept so existing developer workflows and desktop shortcuts do not break. New documentation and release evidence must point to the managed launcher or the standalone Setup artifact instead.