Skip to content

docs(agents): WSL desktop builds target the Windows Electron app - #599

Merged
danshapiro merged 1 commit into
mainfrom
docs/agents-md-wsl-desktop-app
Aug 3, 2026
Merged

docs(agents): WSL desktop builds target the Windows Electron app#599
danshapiro merged 1 commit into
mainfrom
docs/agents-md-wsl-desktop-app

Conversation

@danshapiro

Copy link
Copy Markdown
Owner

What changed

Doc-only, one-line edit to AGENTS.md: strengthens the Windows Electron build guidance in the Building section.

Why

On WSL machines, "the desktop app" means the Windows app. The previous line only said Windows desktop builds must run on native Windows; the new guidance makes the intent unambiguous:

  • Build/install/launch the Windows Electron app (npm run electron:build:win + NSIS installer) — never a Linux AppImage/deb under WSLg.
  • WSL cannot compile node-pty for win32, so the build must run as a native Windows process.
  • Drive it from WSL by rsyncing to a Windows-local dir and running Windows npm via cmd.exe (see docs/development/windows-electron-build.md).

How to verify

Read the diff — single hunk in AGENTS.md, no code changes.

Breaking changes

None (documentation only).

On WSL machines "the desktop app" means the Windows app: build via
npm run electron:build:win + the NSIS installer, never a Linux
AppImage/deb under WSLg. WSL cannot compile node-pty for win32, so
drive the build from WSL by rsyncing to a Windows-local dir and
running Windows npm via cmd.exe.

Generated with Amplifier

Co-Authored-By: Amplifier <[email protected]>
@danshapiro
danshapiro merged commit cf5f670 into main Aug 3, 2026
3 checks passed
@danshapiro
danshapiro deleted the docs/agents-md-wsl-desktop-app branch August 3, 2026 05:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant