You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: prefer managed/Scoop on Windows; avoid winget and Chocolatey
Recommend GitHub-tracking install and upgrade paths only. Status and
ready-check upgrade actions prefer Update/Install Patchloom managed
over Open Releases so users do not stick on lagging community packages.
Signed-off-by: Sebastien Tardif <sebtardif@ncf.ca>
Copy file name to clipboardExpand all lines: README.md
+11-6Lines changed: 11 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,17 +25,16 @@ Or search for **Patchloom** in the Extensions view (`Ctrl+Shift+X` / `Cmd+Shift+
25
25
26
26
## Get started in 30 seconds
27
27
28
-
1. Install the [Patchloom CLI](https://github.com/patchloom/patchloom) (or run **Patchloom: Install Patchloom** from the command palette)
28
+
1. Install the [Patchloom CLI](https://github.com/patchloom/patchloom) (or run **Patchloom: Install Patchloom** from the command palette; recommended: tracks GitHub Releases with checksum verification)
29
29
```sh
30
30
brew install patchloom/tap/patchloom # macOS / Linux (Homebrew)
31
31
npm install -g patchloom # npm (Node.js)
32
32
curl -LsSf https://github.com/patchloom/patchloom/releases/latest/download/patchloom-installer.sh | sh # shell script
scoop install patchloom # Windows (Scoop; preferred Windows channel)
36
-
winget install Patchloom.Patchloom # Windows (WinGet; run winget source update if the package is missing)
37
-
choco install patchloom # Windows (Chocolatey; often lags moderation)
35
+
scoop install patchloom # Windows (Scoop; preferred PATH channel)
38
36
```
37
+
On Windows, prefer the extension managed installer or Scoop. Avoid winget and Chocolatey for install or upgrade: both lag GitHub Releases and often leave you on an old CLI.
39
38
2. Open a project and run **Patchloom: Setup Workspace**
40
39
41
40
<palign="center">
@@ -175,8 +174,14 @@ The extension detects outdated CLI builds and warns with upgrade guidance. It re
175
174
**Patchloom not found**
176
175
Set `patchloom.path` in settings, or add the CLI to your `PATH`.
177
176
178
-
**CLI compatibility warning**
179
-
Run `Patchloom: Open Releases` to download the latest release. The extension requires 0.3.0 or newer; **0.28.0** is recommended.
177
+
**CLI compatibility warning / upgrade path**
178
+
The extension requires Patchloom **0.3.0** or newer; **0.28.0** is recommended. Prefer channels that track GitHub Releases the same day:
179
+
180
+
1.**Patchloom: Update Patchloom** (or **Install Patchloom**) for the extension managed install (checksum-verified download from GitHub Releases)
181
+
2.**Scoop** on Windows: `scoop update patchloom` after `scoop install patchloom`
182
+
3. Homebrew / npm / cargo / the official installer script on macOS and Linux
183
+
184
+
Do **not** rely on winget or Chocolatey to stay current. Those community packages lag moderation and Microsoft publish, so upgrades often stay stuck on older CLI versions.
180
185
181
186
**Path rejected by workspace guard**
182
187
Quick Actions and Batch Apply pass `--contain` so paths stay inside the open workspace folder. On CLI 0.18+, sandbox escapes report `error_kind: guard_rejected` (not a generic `invalid_input`). Keep targets under the workspace root, or open the folder that owns the files.
Copy file name to clipboardExpand all lines: package.json
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -162,7 +162,7 @@
162
162
{
163
163
"id": "installCli",
164
164
"title": "Install the Patchloom CLI",
165
-
"description": "Install the Patchloom CLI via the managed installer, Homebrew, or cargo.\n\n[Install Patchloom](command:patchloom.installBinary)",
165
+
"description": "Install the Patchloom CLI via the managed installer (recommended), Scoop on Windows, Homebrew, or cargo. Avoid winget and Chocolatey; they lag releases.\n\n[Install Patchloom](command:patchloom.installBinary)",
0 commit comments