Skip to content

Commit 016a1b4

Browse files
committed
Update README.md with notes about shell completions when installing with tools other than NPM.
1 parent 23b22c9 commit 016a1b4

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1041,6 +1041,11 @@ or alternatively if you don't want to edit your `~/.bashrc`:
10411041
spago --bash-completion-script $(which spago) >> ~/.bash_completion
10421042
```
10431043

1044+
*Note*: if you installed Spago not with NPM, but with PNPM or some other package manager,
1045+
this package manager might have bundled your installation and your package name in the script may end up being incorrect.
1046+
For example, when installed with PNPM, the resulting script will reference incorrect package `bundle.js` instead of `spago`.
1047+
If you're using something other than NPM, verify the referenced package name in the completions script.
1048+
10441049
### Install autocompletions for `zsh`
10451050

10461051
Autocompletions for `zsh` need to be somewhere in the `fpath` - you can see the folders
@@ -1068,6 +1073,7 @@ compinit
10681073

10691074
*Note*: you might need to call this multiple times for it to work.
10701075

1076+
*Note*: see the note in the Bash section above when installing Spago with a package manager other than NPM.
10711077

10721078
## Concepts and explanations
10731079

0 commit comments

Comments
 (0)