Skip to content

A personal assistant that lives on your desktop, remembers what matters, and can use your Mac for you.

TypeScript

docs(install): install, first open, data and uninstall on Windows

Marcelitode59c3c5fa3e
diff --git a/README.md b/README.md
index cce4082..520ccad 100644
--- a/README.md
+++ b/README.md
@@ -118,7 +118,8 @@ pnpm package:mac
pnpm package:linux --arch arm64
pnpm package:linux --arch amd64
-# Windows (x64): an NSIS installer, after building the native addon
+# Windows (x64): an NSIS installer. First build the native addon and set
+# GENTLE_DOT_BUILD_GO: see docs/install.md#build-the-installer-from-source
pnpm package:runtime --target windows-x64
pnpm package:windows
```
diff --git a/docs/install.md b/docs/install.md
index 17a4ebe..9f20712 100644
--- a/docs/install.md
+++ b/docs/install.md
@@ -82,6 +82,42 @@ The command stages the runtime (`build/runtime/darwin-arm64`), signs the runtime
## Windows
+Requirements: Windows 10 or 11, 64-bit (x64).
+
+### Install
+
+1. Run `Gentle Dot_<version>_x64-setup.exe`.
+2. The installer is not signed yet, so Windows SmartScreen may say **Windows protected your PC**. Click **More info**, then **Run anyway**. Only do this for an installer you built yourself or got from someone you trust.
+3. Follow the installer. It installs for your user only, in `%LOCALAPPDATA%\Gentle Dot` (an update keeps the folder of the earlier install), with no administrator prompt. Where WebView2 is missing, it first runs Microsoft's WebView2 installer, which needs the internet. WebView2 ships with Windows 11 and most Windows 10 installs.
+
+If Gentle Dot is running, the installer says **Gentle Dot is running! Click OK to kill it**. **OK** closes it at once, without the usual orderly quit, so quit it from the tray first.
+
+### First open
+
+Open **Gentle Dot** from the Start menu. The first open needs the network once: the engine installs its companion packages. Computer control and voice input are not available on Windows yet.
+
+### Where data lives
+
+| What | Where |
+|---|---|
+| The app and its bundled runtime | the install folder, with the runtime in `runtime\` |
+| Settings, conversations, logs (`daemon.log`), the engine's own files | `%USERPROFILE%\.gentle-dot\` |
+| Connector secrets, encrypted for your Windows user (DPAPI) | `%LOCALAPPDATA%\dev.gentleman.gentle-dot.connectors\` |
+| The window's own data (WebView2) | `%LOCALAPPDATA%\dev.gentleman.gentle-dot\` and `%APPDATA%\dev.gentleman.gentle-dot\` |
+| Memory (Engram, project `gentle-dot`) | `%USERPROFILE%\.engram\`, shared with any other Engram user on this PC |
+| Launch at login (when turned on) | a `Gentle Dot` value under `HKCU\Software\Microsoft\Windows\CurrentVersion\Run` |
+
+The app's install folder never changes after install; everything it writes goes to the folders above.
+
+### Uninstall
+
+1. Quit Gentle Dot from its tray icon (**Quit**), so the assistant and its processes stop in order.
+2. Open **Settings → Apps → Installed apps**, find **Gentle Dot**, and choose **Uninstall**, or run `uninstall.exe` in the install folder. It removes the app, its Start menu and desktop shortcuts, its launch at login, and its registry entries. Like the installer, it asks to close Gentle Dot if it is still running.
+3. Optional: tick **Delete the application data** in the uninstaller to remove the window's data (`%APPDATA%\dev.gentleman.gentle-dot\` and `%LOCALAPPDATA%\dev.gentleman.gentle-dot\`).
+4. Optional: remove `%USERPROFILE%\.gentle-dot\` to delete settings and conversations, and `%LOCALAPPDATA%\dev.gentleman.gentle-dot.connectors\` to delete connector secrets. The uninstaller never touches these.
+
+`%USERPROFILE%\.gentle-dot\daemon.owner` stays behind after a normal quit. It records the last launch without any authority over it, and the next launch replaces it.
+
### Build the installer from source
On Windows 10 or 11 (x64) with Node 24, pnpm, Rust, Visual Studio's C++ build tools (for the native addon), and Go 1.25.10 or newer:
diff --git a/scripts/package/test/package-windows.test.ts b/scripts/package/test/package-windows.test.ts
index 748e88e..a731775 100644
--- a/scripts/package/test/package-windows.test.ts
+++ b/scripts/package/test/package-windows.test.ts
@@ -134,9 +134,10 @@ describe("Windows package admission and plan (no commands executed)", () => {
});
it("wires package-only marker to fallible admission before launch without changing launch_spec", () => {
- const build = readFileSync("apps/desktop/src-tauri/build.rs", "utf8");
- const daemon = readFileSync("apps/desktop/src-tauri/src/daemon.rs", "utf8");
- const launch = readFileSync("apps/desktop/src-tauri/src/daemon/launch.rs", "utf8");
+ const tauri = new URL("../../../apps/desktop/src-tauri/", import.meta.url);
+ const build = readFileSync(new URL("build.rs", tauri), "utf8");
+ const daemon = readFileSync(new URL("src/daemon.rs", tauri), "utf8");
+ const launch = readFileSync(new URL("src/daemon/launch.rs", tauri), "utf8");
expect(build).toContain("cargo:rerun-if-env-changed=GENTLE_DOT_WINDOWS_PACKAGED_REQUIRED");
expect(build).toContain("cargo:rustc-env=GENTLE_DOT_WINDOWS_PACKAGED_REQUIRED=");
expect(build).toContain('env::var("CARGO_CFG_TARGET_OS").as_deref() == Ok("windows")');