From a41f75b4a7aaec6a0168f5d255c60816bde32907 Mon Sep 17 00:00:00 2001 From: Jeremy Date: Tue, 27 Oct 2026 12:09:02 +0000 Subject: [PATCH] docs(installer): describe the per-user default install location and scope --- README.md | 6 ++++-- docs/agents.md | 6 +++--- docs/releasing.md | 2 +- packaging/windows/test-msi.ps1 | 2 +- 4 files changed, 9 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5fa28f0bb..4a3947a42 100644 --- a/README.md +++ b/README.md @@ -275,8 +275,10 @@ send us right now. | arm64 (Snapdragon and other ARM PCs) | `effectcraft--windows-arm64.msi` | `effectcraft--windows-arm64-portable.zip` | | x86 (32-bit) | `effectcraft--windows-x86.msi` | `effectcraft--windows-x86-portable.zip` | -Installers and executables are code-signed. The installer asks where to install EffectCraft -(Program Files by default), and later versions install into the same folder. To install silently +Installers and executables are code-signed. The installer asks who to install EffectCraft for and where. By default it installs for your +account only, into `%LOCALAPPDATA%\Programs\ArtCraft\EffectCraft`, without an administrator prompt; +"Everyone on this computer" installs into `C:\Program Files\ArtCraft\EffectCraft`. Later versions +install into the same folder. To install silently into a folder of your choice: `msiexec /i effectcraft--windows-x64.msi /qn INSTALLFOLDER="D:\Apps\EffectCraft"`. ### macOS diff --git a/docs/agents.md b/docs/agents.md index aae8be12c..3788caebe 100644 --- a/docs/agents.md +++ b/docs/agents.md @@ -54,13 +54,13 @@ The release packages ship `effectcraft-cli` alongside the desktop app, so no bui | Install | CLI | |---|---| -| Windows (MSI) | `C:\Program Files\EffectCraft\effectcraft-cli.exe` by default (wherever you installed it otherwise), not on `PATH` | +| Windows (MSI) | `%LOCALAPPDATA%\Programs\ArtCraft\EffectCraft\effectcraft-cli.exe` by default (`C:\Program Files\ArtCraft\EffectCraft\effectcraft-cli.exe` for an all-users install, or wherever you installed it otherwise), not on `PATH` | | Linux (deb, rpm) | `/usr/bin/effectcraft-cli` | | macOS | the separate `effectcraft-cli--macos-.zip` release asset (the `.app` holds only the desktop app) | ```sh -# Windows, default install folder -claude mcp add effectcraft -- "C:\Program Files\EffectCraft\effectcraft-cli.exe" mcp +# Windows (PowerShell), default install folder +claude mcp add effectcraft -- "$env:LOCALAPPDATA\Programs\ArtCraft\EffectCraft\effectcraft-cli.exe" mcp # Linux, or macOS with the CLI unzipped onto PATH claude mcp add effectcraft -- effectcraft-cli mcp ``` diff --git a/docs/releasing.md b/docs/releasing.md index bd28d8ec3..07d988b5c 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -71,7 +71,7 @@ The MSI's setup wizard ([`installer-ui.wxs`](../packaging/windows/installer-ui.w choose the install folder; upgrades and repairs reuse it, and `INSTALLFOLDER="..."` picks it for a silent (`/qn`) install. [`packaging-lint.yml`](../.github/workflows/packaging-lint.yml) install-tests that with stub binaries ([`test-msi.ps1`](../packaging/windows/test-msi.ps1)): a custom folder, -an upgrade that keeps it, a repair, uninstall, and the Program Files default. The wizard pages +an upgrade that keeps it, a repair, uninstall, and the all-users default folder (`Program Files\ArtCraft\EffectCraft`). The wizard pages themselves are checked by hand. The portable zip ships [`portable.txt`](../packaging/windows/portable.txt) beside `effectcraft.exe`. diff --git a/packaging/windows/test-msi.ps1 b/packaging/windows/test-msi.ps1 index 8f8396395..fbc463e4b 100644 --- a/packaging/windows/test-msi.ps1 +++ b/packaging/windows/test-msi.ps1 @@ -11,7 +11,7 @@ 3. upgrades to 0.0.3 the same way (found from the Path value 0.0.2 wrote), 4. repairs a damaged (unversioned) CLI there with the wizard's Repair mode, 5. uninstalls: files, the App Paths registration and the desktop shortcut go, - 6. installs 0.0.3 with no folder and DESKTOPSHORTCUT=0: it must land in Program Files with no + 6. installs 0.0.3 with no folder and DESKTOPSHORTCUT=0: it must land in Program Files\ArtCraft\EffectCraft (ALLUSERS=1) with no desktop shortcut, then uninstalls. The installs before step 6 take the default desktop shortcut, which upgrades keep. The wizard itself needs a person (or the snapshot steps in the PR); this covers what msiexec /qn