Skip to content

docs: show how to fix PATH for custom npm prefixes in installation troubleshooting #1488

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
omercangumus wants to merge 1 commit into from
Closed

docs: show how to fix PATH for custom npm prefixes in installation troubleshooting #1488

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 21 additions & 4 deletions docs/src/content/docs/get-started/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,17 +160,34 @@ export default defineConfig({

### `squad: command not found`

Your npm global bin isn't in your PATH. Fix:
Your npm global bin isn't in your PATH. This usually happens with a custom npm prefix (e.g. `npm config set prefix ~/.npm-global`). Diagnose:

```bash
# Check if installed
npm list -g @bradygaster/squad-cli

# If installed but not found, check PATH:
echo $PATH | grep npm # macOS/Linux
echo %PATH% | findstr npm # Windows
# Find where npm puts global commands
npm prefix -g
```

On macOS/Linux, `squad` is installed to `$(npm prefix -g)/bin`. On Windows, it's installed to the prefix directory itself (no `bin` subdirectory). If that directory isn't in your PATH, add it:

**macOS/Linux** — add the bin directory to your shell profile:

```bash
echo 'export PATH="$(npm prefix -g)/bin:$PATH"' >> ~/.zshrc # or ~/.bashrc
source ~/.zshrc
```

**Windows (PowerShell)** — append the prefix to your user PATH:

```powershell
$npmPrefix = npm prefix -g
[Environment]::SetEnvironmentVariable('Path', "$([Environment]::GetEnvironmentVariable('Path', 'User'));$npmPrefix", 'User')
```

Then open a new terminal and verify with `squad --version`.

### `Cannot find .squad/ directory`

Run `squad init` in your project root, or `squad init --global` for a personal squad.
Expand Down