Skip to content

Commit

Permalink
Update README.md with notes about shell completions when installing w… (
Browse files Browse the repository at this point in the history
  • Loading branch information
postsolar authored Oct 20, 2023
1 parent 23b22c9 commit 88e6350
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1041,6 +1041,11 @@ or alternatively if you don't want to edit your `~/.bashrc`:
spago --bash-completion-script $(which spago) >> ~/.bash_completion
```

> [!NOTE]\
> If you installed Spago not with NPM, but with PNPM or some other package manager, this package manager might have bundled your installation and your package name in the script may end up being incorrect.
> For example, when installed with PNPM, the resulting script will reference incorrect package `bundle.js` instead of `spago`.
> If you're using something other than NPM, verify the referenced package name in the completions script.
### Install autocompletions for `zsh`

Autocompletions for `zsh` need to be somewhere in the `fpath` - you can see the folders
Expand All @@ -1066,8 +1071,11 @@ Then, reload completions with:
compinit
```

*Note*: you might need to call this multiple times for it to work.
> [!NOTE]\
> You might need to call this multiple times for it to work.
> [!NOTE]\
> See the note in the Bash section above when installing Spago with a package manager other than NPM.
## Concepts and explanations

Expand Down

0 comments on commit 88e6350

Please sign in to comment.