docs: show how to fix PATH for custom npm prefixes in installation troubleshooting#1488
Closed
omercangumus wants to merge 1 commit into
Closed
Conversation
…oubleshooting Fixes bradygaster#1458 Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
🟢 Impact Analysis — PR #1488Risk tier: 🟢 LOW 📊 Summary
🎯 Risk Factors
📦 Modules Affecteddocs (1 file)
This report is generated automatically for every PR. See #733 for details. |
Contributor
🛫 PR Readiness Check
PR Scope: 🔧 Infrastructure
|
| Status | Check | Details |
|---|---|---|
| ✅ | Single commit | 1 commit — clean history |
| ✅ | Not in draft | Ready for review |
| ✅ | Branch up to date | Up to date with dev |
| ❌ | Copilot review | No Copilot review yet — it may still be processing |
| ✅ | Changeset present | No source files changed — changeset not required |
| ✅ | Scope clean | No .squad/ or docs/proposals/ files |
| ✅ | No merge conflicts | No merge conflicts |
| ✅ | Copilot threads resolved | No Copilot review threads |
| ❌ | CI passing | 5 check(s) still running |
Files Changed (1 file, +21 −4)
| File | +/− |
|---|---|
docs/src/content/docs/get-started/installation.md |
+21 −4 |
Total: +21 −4
This check runs automatically on every push. Fix any ❌ items and push again.
See CONTRIBUTING.md and PR Requirements for details.
tamirdresher
approved these changes
Jul 16, 2026
Collaborator
|
Closing in favor of #1459, which now covers the same PATH troubleshooting problem and includes the more complete User PATH handling, duplicate prevention, whitespace trimming, and separate bash/zsh guidance. Thank you for the contribution and review work here. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Replaces the diagnostics-only
squad: command not foundentry indocs/src/content/docs/get-started/installation.mdwith the actual fix:npm prefix -gto locate the global bin, then per-platform PATH instructions (shell profile export for macOS/Linux,[Environment]::SetEnvironmentVariablefor Windows). Docs-only — no code change.Why
Fixes #1458
The section said "Fix:" but only showed diagnostic commands, so a user with a custom npm prefix could confirm the problem and still not know what to do about it. The old Windows line was also cmd syntax (
echo %PATH% | findstr npm) that errors in PowerShell, the default shell the docs otherwise assume.Testing
npm install -g --prefix <sandbox> @bradygaster/squad-cliagainst the published package — thesquad.cmdshim lands directly in the prefix root, nobin\subdirectory, which is why the doc now spells out the macOS/Linux vs Windows split[Environment]::calls syntax-checked with an ephemeral process-scope variable; the real'User'-scope write was not run against this machine's PATH, by design$(npm prefix -g)/binresolves and prepends as writtennpm run lint:docs(markdownlint + cspell) — 0 errorsgit diffvsgit diff -widentical; file stays LFPR Readiness Checklist
Branch & Commit
devdevBuild & Test
npm run lint:docspasses🤖 Generated with Claude Code