Skip to content

Commit

Permalink
Docs: Update installation steps to work in bash & zsh (#1211)
Browse files Browse the repository at this point in the history
* Updated documentation for pip install in zsh

Fixes #1209

Updated documentation to handle installation using `zsh` on Macs, which is now the default shell.

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update index.md

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
  • Loading branch information
srdas and pre-commit-ci[bot] authored Jan 21, 2025
1 parent 7c1c8c0 commit a0ab1b6
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions docs/source/users/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,19 +106,25 @@ section to pick the installation method that works best for you.

If you want to install both the `%%ai` magic and the JupyterLab extension, you can run:

$ pip install jupyter-ai[all]
$ pip install 'jupyter-ai[all]'

Then, restart JupyterLab. This will install every optional dependency, which
provides access to all models currently supported by `jupyter-ai`.

If you are not using JupyterLab and you only want to install the Jupyter AI
`%%ai` magic, you can run:

$ pip install jupyter-ai-magics[all]
$ pip install 'jupyter-ai-magics[all]'

`jupyter-ai` depends on `jupyter-ai-magics`, so installing `jupyter-ai`
automatically installs `jupyter-ai-magics`.

:::{warning}
:name: quoting-cli-arguments
If running the above commands result in an error like `zsh: no matches found: jupyter-ai[all]`, this is because the `jupyter-ai[all]` argument must be surrounded by single or double quotes. Some shells reserve square brackets for pattern matching, so arguments containing square brackets must be quoted.
:::


### Minimal installation via `pip`

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

0 comments on commit a0ab1b6

Please sign in to comment.