Skip to content

[tracker] Windows installer UX improvements (#207) #213

Description

@zhou-1314

Tracks engineering improvements for the Windows installer surfaced by #207 — silent 295 MB extraction with no feedback can look indistinguishable from a hang.

Most of the work lands in the OmicsClaw-App/ repo (electron-builder config + NSIS scripts + main-process menu wiring); the README section lives in this repo.

Background

  • Installer: OmicsClaw.Setup.<ver>-x64.exe (~295 MB) — electron-builder NSIS one-click default
  • Reported symptom: installer hangs with no info window; user has no way to tell if it's progressing
  • User ask: "Add an Installation Detail Log area"
  • Root cause: oneClick: true + bundled Python+omics deps means a 5-15 min silent extract on slow disks / with AV scanning

Sub-tasks

P0 — electron-builder config + NSIS install script

Repo: OmicsClaw-App/. Effort: <30 min code, +1 release cut.

  • electron-builder.yml: set nsis.oneClick: false, perMachine: false, allowToChangeInstallationDirectory: true, differentialPackage: false, warningsAsErrors: false, installerLanguages: [en_US, zh_CN]
  • Add build/installer.nsh with customHeader (SetDetailsView show), customInit (LogSet on → writes $TEMP\OmicsClaw-install.log), customInstall (DetailPrint + LogText for each major step: Python runtime / skill packs / shortcuts / URL schemes)
  • Verify on Win 10 + Win 11 + ARM64 that the details panel auto-opens and the log file exists after install

Acceptance: User running the installer sees a scrolling step list and %TEMP%\OmicsClaw-install.log exists after both success and abort paths.

P1 — App-side "Show install log" menu

Repo: OmicsClaw-App/. Effort: ~1 hour.

  • main/menu.ts: add Help → "Show installation log" that opens %TEMP%\OmicsClaw-install.log
  • First-launch copy of install log to app.getPath('userData')/install.log (stable location surviving %TEMP% cleanup)
  • Fallback message when log is missing (older installer or already cleaned)

Acceptance: User can always retrieve install log from the running App without remembering temp paths.

P2 — README "Windows installation troubleshooting" section

Repo: TianGzlab/OmicsClaw (this repo). Effort: ~1 hour.

  • Add section in README.md (after installer download table) covering: SmartScreen "Run anyway" path, AV exclusion path, manual /LOG= capture command, where to find post-install logs
  • Mirror in README_zh-CN.md
  • Link from docs/_legacy/INSTALLATION.md (or successor)

Acceptance: A user hitting the same stall as #207 finds the workaround in README without filing an issue.

P3 — EV code signing certificate

Repo: infra/build pipeline. Effort: procurement (~$400/yr) + 1 day integration.

  • Evaluate ROI: EV cert removes SmartScreen warning → reduces install-abandonment for new users
  • Bundle with macOS notarization renewal (Apple Developer ID, $99/yr) — same procurement cycle
  • Wire into release CI (signtool.exe step or electron-builder's win.certificateFile)
  • Document key custody (1Password / GitHub repo secret)

Acceptance: Signed OmicsClaw.Setup.<ver>-x64.exe no longer triggers "Windows protected your PC".

Reproduction reference

Notes

  • App and CLI version independently; this work is App-version-scoped (current latest App release: v0.1.6).
  • P0+P1 should land together in the next App release after consensus-interpret v0.1.7 cut so users get the full improved install experience in one upgrade.
  • P3 is independent of P0-P2 — sign once procured; no code dependency.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions