docs(installer): describe the per-user default install location and scope

This commit is contained in:
Jeremy
2026-10-27 12:09:04 +00:00
parent 85250cd220
commit 094b228aea
2 changed files with 9 additions and 6 deletions
+4 -4
View File
@@ -58,13 +58,13 @@ The release packages ship `vectorcraft-cli` alongside the desktop app, so no bui
| Install | CLI |
|---|---|
| Windows (MSI) | `C:\Program Files\VectorCraft\vectorcraft-cli.exe` by default (wherever you installed it otherwise), not on `PATH` |
| Windows (MSI) | `%LOCALAPPDATA%\Programs\ArtCraft\VectorCraft\vectorcraft-cli.exe` by default (`C:\Program Files\ArtCraft\VectorCraft\vectorcraft-cli.exe` for an all-users install, or wherever you installed it otherwise), not on `PATH` |
| Linux (deb, rpm) | `/usr/bin/vectorcraft-cli` |
| macOS | the separate `vectorcraft-cli-<version>-macos-<arch>.zip` release asset (the `.app` holds only the desktop app) |
```sh
# Windows, default install folder
claude mcp add vectorcraft -- "C:\Program Files\VectorCraft\vectorcraft-cli.exe" mcp
# Windows (PowerShell), default install folder
claude mcp add vectorcraft -- "$env:LOCALAPPDATA\Programs\ArtCraft\VectorCraft\vectorcraft-cli.exe" mcp
# Linux, or macOS with the CLI unzipped onto PATH
claude mcp add vectorcraft -- vectorcraft-cli mcp
```
@@ -75,7 +75,7 @@ For a live session, start the installed app with the control port before the MCP
# macOS: quit VectorCraft first, since `open -a` passes no arguments to an app that is already running
open -a VectorCraft --args --control 7979
# Windows (PowerShell), default install folder
& "C:\Program Files\VectorCraft\vectorcraft.exe" --control 7979
& "$env:LOCALAPPDATA\Programs\ArtCraft\VectorCraft\vectorcraft.exe" --control 7979
# Linux (deb, rpm)
vectorcraft --control 7979
```
+5 -2
View File
@@ -128,11 +128,14 @@ to the target triple, so host build scripts aren't affected.
inside the signed bundle), for an AppImage next to the `.AppImage` file (`$APPIMAGE`; the mounted
executable's own folder is read-only). Flatpak isn't supported: `/app` is read-only and the
sandbox has no folder "beside the app", so a Flatpak install always uses its own config folder.
- `vectorcraft.wxs` (WiX) is a per-machine install into Program Files with a Start Menu shortcut
- `vectorcraft.wxs` (WiX) is a dual-scope package (per-user by default into
`%LOCALAPPDATA%\Programs\ArtCraft\VectorCraft`, per-machine into `Program Files\ArtCraft\VectorCraft`;
(see `packaging/windows/INSTALLATION.md`)) with a Start Menu shortcut
and an App Paths entry (Win+R `vectorcraft`). Same-version upgrades are allowed, so release
candidates replace each other.
- Double-clicking the MSI opens a setup wizard (WixUI_InstallDir without the licence page):
Welcome, install folder (remembered for upgrades in `HKLM\Software\VectorCraft\InstallDir`),
a scope page ("Only for me" or "Everyone on this computer"), Welcome, install folder (remembered for
upgrades in `HKLM` or `HKCU\Software\VectorCraft\InstallDir` according to scope),
Shortcuts (a ticked "Create a desktop shortcut" box), Ready, a progress page, and a Finish page
that says where to find the app, with a ticked "Launch VectorCraft" box. The pages name the full
version (`vectorcraft.en-us.wxl`). `package.ps1` draws the wizard's banner and side bitmaps from