Skip to content

Commit

Permalink
Updated documentation for pip install in zsh
Browse files Browse the repository at this point in the history
Fixes jupyterlab#1209

Updated documentation to handle installation using `zsh` on Macs, which is now the default shell.
  • Loading branch information
srdas committed Jan 21, 2025
1 parent 7c1c8c0 commit b0f55b4
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/source/users/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,11 @@ If you are not using JupyterLab and you only want to install the Jupyter AI
`jupyter-ai` depends on `jupyter-ai-magics`, so installing `jupyter-ai`
automatically installs `jupyter-ai-magics`.

*Note*: This installation step fails in a `zsh` environment because `zsh` uses square brackets for pattern matching. `zsh` is the default shell for Mac users since Catalina https://support.apple.com/en-ca/102360. The square brackets need to be escaped or the entire package name quoted. Please use the following install command instead:

$ pip install 'jupyter-ai[all]'


### Minimal installation via `pip`

Most model providers in Jupyter AI require a specific dependency to be installed
Expand Down

0 comments on commit b0f55b4

Please sign in to comment.