Skip to content

Windows installer, portable exe and README (Phase 6) - #5

Merged
RileyBeenders merged 9 commits into
mainfrom
phase-6-packaging
Oct 18, 2026
Merged

RileyBeenders merged 9 commits into
mainfrom
phase-6-packaging

Conversation

@RileyBeenders

Copy link
Copy Markdown
Owner

Stacked PR 5 of 5. Based on phase-4-focus (#4). Merge #1–#4 first. This completes v1.

What

Phase 6 of the project plan: packaging for Windows.

  • electron-builder produces a per-user NSIS installer (BulkSSH-Setup-<version>.exe: no admin, Start-menu and desktop shortcuts, keeps %APPDATA%\bulkssh on uninstall) and a portable exe (BulkSSH-<version>-portable.exe).
  • No native rebuilds (npmRebuild: false): ssh2's optional native addons are unused, so packaging needs no C++ build tools. React moved to devDependencies since Vite bundles it, leaving ssh2 as the only runtime dependency in the package.
  • App icon drawn by scripts/generate-icon.mjs (npm run icon, no dependencies).
  • README rewritten as a user guide: install, devices, grid, focus view, mirroring, broadcast, safety checks, copy/paste, shortcuts, settings, security, building, and the dev SSH server.
  • .github/workflows/release.yml builds both exes on manual dispatch or a v* tag and uploads them as a workflow artifact. It doesn't publish a release.

For reviewers

  • Builds are not code-signed, so SmartScreen warns on first run; the README explains how to get past it.
  • The release workflow hasn't run yet. It follows the same npm ci --ignore-scripts setup as CI, and npm run dist worked locally from a clean dist/.

Testing

  • npm run dist locally: both exes are about 107 MB, with correct product name, version and copyright, and the app package contains only the ssh2 dependency tree.
  • The packaged BulkSSH.exe loaded from file:, showed v0.1.0, connected two dev devices with ssh2 from inside the package, answered in the shell, and ran a broadcast (exit 0 on both). The portable exe launched and rendered.
  • Installing, using and uninstalling with the installer were tested by hand.

🤖 Generated with Claude Code

- Electron + React + TypeScript app built with electron-vite
- Secure window: context isolation, sandbox, no Node in renderer, CSP
- Preload bridge exposed as window.bulkssh (app version over IPC)
- Placeholder layout: device list, grid area, broadcast bar
- Shared paging helpers (default 6 devices per page) with Vitest tests
- electron-builder config for Windows NSIS installer and portable exe
- .gitignore keeps device lists, settings and SSH keys out of git
- Project plan in .projectPlan/PLAN.md, CLAUDE.md, project skills
- .claude/launch.json: single "dev" config running npm run dev on port 5173
- Pin the electron-vite renderer dev server to 5173 with strictPort
- Make window.bulkssh optional so the renderer loads in a plain browser
- Document the preview setup in CLAUDE.md
- Transport interface with an ssh2-based SshTransport (password,
  keyboard-interactive and private key auth, encrypted key passphrases)
- Session manager: one session per device, readable connection errors,
  re-prompts on wrong password or passphrase
- Host key trust-on-first-use: native dialog for unknown and changed keys,
  trusted keys stored in known_hosts.json
- Device store (devices.json in userData) with shared validation; secrets
  are never written to disk
- IPC handlers validate every argument and reject unknown senders
- Renderer: device list, add/edit form, password prompt, xterm.js terminal
  with fit-to-size and resize forwarding
- npm run dev:ssh: local SSH server with a fake shell for manual testing
- Tests: device validation, stores, and session manager against an
  in-process ssh2 server (34 tests)
- Update CLAUDE.md and the project plan
Runs npm ci --ignore-scripts, typecheck and Vitest on windows-latest (Node 24) for pull requests and pushes to main.
- Paged grid of live terminal tiles for open devices, ordered by device
  number; tiles stay after a disconnect until closed
- Grid shape from min(page size, open devices) so every page has the same
  tile size and page switches never resize terminals
- Pager with numbered pages, Ctrl+PageUp/PageDown (kept from reaching the
  device), and clicking a device row jumps to its tile
- Connect all / Disconnect all; password prompts are queued, with an
  option to reuse one password for the other waiting devices
- Settings dialog and settings.json for devices per page (1-36, default 6)
- Host-key dialogs queued in the main process so bulk connects never
  stack them
- Tests for grid shape, page clamping and settings (48 total)
- Update CLAUDE.md and the project plan
- "Send to" checkbox per device with All / None / Invert
- Mirror mode (button or Ctrl+Shift+M): input typed into a tile also goes
  to every other checked, connected device via one writeMany IPC call;
  source and mirrored tiles are badged and outlined
- Terminal replies (cursor/attribute reports, focus and mouse events,
  OSC/DCS replies) are never mirrored
- Broadcast runs a command on checked devices over SSH exec channels in
  parallel, with per-device output, exit code and duration; output capped
  at 64 KB; per-device timeout setting (default 30 s)
- One failing, slow or disconnected device never affects the others
- Dev SSH server: exec support plus sleep, fail and fail-on commands
- Tests for mirror targets, the report filter, writeMany and exec
  (84 total)
- Update CLAUDE.md and the project plan
- Focus view: one device full size using the same xterm instance, so the
  device gets the new size and scrollback is kept; toggle with the tile
  button, a double-click on the tile header, or Ctrl+Shift+F
- In focus view, Ctrl+PageUp/PageDown step to the previous/next device
- Entering focus turns mirroring off; leaving restores the earlier setting
  unless mirroring was turned on again in focus
- Copy/paste: Ctrl+Shift+C/V, Ctrl+Insert / Shift+Insert, Ctrl+C copies
  only when text is selected (otherwise ^C), right-click copies or pastes;
  pastes are bracketed-paste aware and mirrored like typing
- Shortcut and clipboard keys defined and tested in src/shared/keys.ts
- Permission handler: the renderer may use the clipboard and nothing else
- Dev SSH server: `tui`, a full-screen test program (alternate screen,
  resize redraw, colours, arrow keys, cursor-position query)
- Update CLAUDE.md and the project plan
- Confirmation before risky commands reach several devices: broadcasts
  matching src/shared/danger.ts (rm -r, reboot/shutdown, mkfs, dd,
  recursive chmod, firewall flush, interface down, user changes, package
  removal, network-gear reload/erase), and Enter typed while mirroring,
  using a per-device LineTracker; the dialog lists every target device
- Opt-in "Remember" for passwords and key passphrases, stored only as
  Electron safeStorage ciphertext (DPAPI on Windows); the renderer never
  receives saved secrets; a rejected saved secret is deleted; "Forget it"
  in the device form
- Auto-reconnect when a connection drops (setting, default on): 5 tries
  with growing delays, password kept in memory only, stops on auth or
  host-key problems, cancelled by Disconnect
- Broadcast command history (Up/Down, memory only) and export of a tile's
  scrollback or a broadcast's results to a text file
- Renderer crash recovery: the window reloads and re-adopts live sessions
- Dev SSH server: --password option and `drop` command
- Tests for danger rules, line tracking, credential store, saved-secret
  logins, reconnect and export formatting (174 total)
- Update CLAUDE.md and the project plan
- electron-builder: per-user NSIS installer (no admin, Start-menu and
  desktop shortcuts, keeps %APPDATA%\bulkssh on uninstall) and a portable
  exe, with clear artifact names and version metadata
- No native rebuilds (ssh2's optional addons are unused), so packaging
  needs no C++ build tools; React moved to devDependencies since Vite
  bundles it, leaving ssh2 as the only runtime dependency
- App icon drawn by scripts/generate-icon.mjs (npm run icon)
- README rewritten as a user guide: install, devices, grid, focus view,
  mirroring, broadcast, safety checks, copy/paste, shortcuts, settings,
  security, building and the dev SSH server
- GitHub Actions workflow to build both exes on demand or on v* tags
- Builds are not code-signed yet
- Update CLAUDE.md and the project plan
@RileyBeenders
RileyBeenders changed the base branch from phase-4-focus to main October 18, 2026 01:55
@RileyBeenders
RileyBeenders merged commit c74c9b9 into main Oct 18, 2026
1 check passed
@RileyBeenders
RileyBeenders deleted the phase-6-packaging branch October 18, 2026 02:06
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