Skip to content

Commit a36b2ee

Browse files
DeusDatatamerbak
andcommitted
docs(troubleshooting): refresh Windows entries for v0.12.x
- Non-ASCII paths: drop the NTFS junction example; the workaround is ASCII-only paths for the two variables, or an upgrade. - Update entry: name the real command (update, not upgrade) and mark #1168 as closed, fixed in v0.10.0. - Index worker: from v0.12.0 a worker that exits without returning a result is no longer counted as a success, and its log is kept; ask for logs when indexing still fails on v0.11.0 or newer. - Antigravity: state the affected range (all releases through v0.12.1 when neither detection signal is present) and which signal each version checks; scope the duplicate binary to v0.9.x and earlier. - OpenCode: list the detection signals per version (PATH, config, and from v0.12.0 the data folder), the 4 KB PATH and npm/mise/scoop shim gaps fixed after v0.12.1 (#2381), and a workaround per version. The page structure and the original entries were first drafted by Tamer in #2262. Refs #1170 Co-authored-by: Tamer <[email protected]> Signed-off-by: Martin Vogel <[email protected]>
1 parent d1ab242 commit a36b2ee

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

‎docs/WINDOWS_TROUBLESHOOTING.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,35 +8,35 @@ This page collects known Windows-specific symptoms, with the version range each
88

99
**Affected versions:** Affects v0.9.x and earlier. Fixed in v0.10.0 (environment variables are read as wide strings via `GetEnvironmentVariableW`).
1010

11-
**Workaround:** On an older build, use ASCII-only paths for these two variables (e.g. via an NTFS junction) or upgrade with `install.ps1`.
11+
**Workaround:** On an older build, use ASCII-only paths for these two variables or upgrade with `install.ps1`.
1212

1313
**Tracking:** #1165.
1414

1515
## Upgrade completes but binary version does not change
1616

17-
**Symptom:** `codebase-memory-mcp upgrade` reports success and downloads files, but `codebase-memory-mcp --version` still reports the previous version (with `.exe.old` remaining alongside).
17+
**Symptom:** `codebase-memory-mcp update` reports success and downloads files, but `codebase-memory-mcp --version` still reports the previous version (with `.exe.old` remaining alongside).
1818

1919
**Affected versions:** Affects v0.9.x and earlier (in-process self-update on Windows). From v0.10.0, `update` prints the `install.ps1` command instead of replacing itself.
2020

2121
**Workaround:** On an older build, run `install.ps1` once; it replaces the binary out-of-process and verifies the installed version.
2222

23-
**Tracking:** #1168.
23+
**Tracking:** #1168 (closed; fixed in v0.10.0).
2424

2525
## Index worker hangs, crashes, or leaves an empty worker log
2626

2727
**Symptom:** `index_repository` reports worker hangs or crashes. (An *empty* worker log is a separate, fixed bug: v0.10.4 and earlier.)
2828

29-
**Affected versions:** Empty worker logs affect v0.10.4 and earlier (fixed in v0.10.5). Misleading "crashed on a file" reports for returned errors fixed in v0.10.0. From v0.11.0, the Windows worker is memory-capped. The underlying hang (#1130) and startup exit (#1145) remain open for investigation.
29+
**Affected versions:** Empty worker logs affect v0.10.4 and earlier (fixed in v0.10.5). Misleading "crashed on a file" reports for returned errors fixed in v0.10.0. From v0.11.0, the Windows worker is memory-capped. From v0.12.0, a worker that exits without returning a result is no longer counted as a success, and its log is kept. The underlying hang (#1130) and startup exit (#1145) remain open for investigation.
3030

31-
**Workaround:** For repositories containing large binary, media, or model directories, exclude those paths with `.cbmignore` before indexing (see [`.cbmignore` documentation](cbmignore.md)). From v0.10.5, the worker log names the in-flight file; if indexing fails on v0.11.0, attach that log to #1130 or #1145.
31+
**Workaround:** For repositories containing large binary, media, or model directories, exclude those paths with `.cbmignore` before indexing (see [`.cbmignore` documentation](cbmignore.md)). From v0.10.5, the worker log names the in-flight file; if indexing still fails on v0.11.0 or newer, attach that log to #1130 or #1145.
3232

3333
**Tracking:** #1130, #1132, #1145.
3434

3535
## Antigravity 2.0 configuration not picked up
3636

3737
**Symptom:** Installation completes but Antigravity 2.0 does not see the MCP server or hooks, or the environment is detected as Gemini-CLI; duplicate large binaries may also be left on disk.
3838

39-
**Affected versions:** Affects detection when neither `~/.gemini/antigravity-cli` exists nor `antigravity` is found on PATH. Duplicate binary accumulation during `install.ps1` fixed since v0.10.0.
39+
**Affected versions:** All releases through v0.12.1 when neither detection signal below is present (v0.9.x checks only for `~/.gemini/antigravity-cli`; from v0.10.0, `antigravity` on PATH also counts). The duplicate binary left behind by `install.ps1` affects v0.9.x and earlier (fixed in v0.10.0).
4040

4141
**Workaround:** Antigravity is configured only when `~/.gemini/antigravity-cli` exists or `antigravity` is on PATH; the target is `~/.gemini/config/mcp_config.json`, and no hooks are installed for it. If neither signal is present, the machine is treated as Gemini-CLI. From v0.10.0, `install.ps1` keeps a single binary; running `codebase-memory-mcp install` manually without `--dir` can still create a second copy in `~/.local/bin`.
4242

@@ -46,9 +46,9 @@ This page collects known Windows-specific symptoms, with the version range each
4646

4747
**Symptom:** `codebase-memory-mcp install` detects other clients but skips OpenCode on Windows.
4848

49-
**Affected versions:** Affects v0.9.x and earlier with PATH-only detection. From v0.10.0, OpenCode is also detected via its configuration directory. PATH-only detection can still fail on Windows (long PATH strings, non-ASCII user profiles, or npm shim directory paths).
49+
**Affected versions:** v0.9.x and earlier detect OpenCode only through `opencode` on PATH. v0.10.0 also detects its configuration (the config file, `%USERPROFILE%\.config\opencode\`, or `OPENCODE_CONFIG_DIR`), and v0.12.0 also detects its data folder `%USERPROFILE%\.local\share\opencode\`, which the OpenCode CLI and the Desktop app both create, so detection no longer depends on PATH. In v0.12.1 and earlier, a PATH longer than 4 KB hides every CLI from detection, and npm, mise and scoop shim folders are not searched; both are fixed after v0.12.1 (#2381).
5050

51-
**Workaround:** Ensure `%USERPROFILE%\.config\opencode\` exists (or set `OPENCODE_CONFIG` / `OPENCODE_CONFIG_DIR`), then re-run `codebase-memory-mcp install`.
51+
**Workaround:** On v0.12.0 or newer, start OpenCode once (CLI or Desktop app) so that its data folder exists, then re-run `codebase-memory-mcp install`. On v0.10.x or v0.11.0, make sure `%USERPROFILE%\.config\opencode\` exists (or point `OPENCODE_CONFIG` at an existing config file, or `OPENCODE_CONFIG_DIR` at an existing folder), then re-run `codebase-memory-mcp install`. On v0.9.x, `opencode` must be on PATH; upgrading with `install.ps1` is the simpler fix.
5252

5353
**Tracking:** #1167.
5454

0 commit comments

Comments
 (0)