Skip to content

Commit fcf7117

Browse files
Backport PR #1211: Docs: Update installation steps to work in bash & zsh (#1212)
Co-authored-by: Sanjiv Das <[email protected]>
1 parent 9a24a32 commit fcf7117

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

docs/source/users/index.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -106,19 +106,25 @@ section to pick the installation method that works best for you.
106106

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

109-
$ pip install jupyter-ai[all]
109+
$ pip install 'jupyter-ai[all]'
110110

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

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

117-
$ pip install jupyter-ai-magics[all]
117+
$ pip install 'jupyter-ai-magics[all]'
118118

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

122+
:::{warning}
123+
:name: quoting-cli-arguments
124+
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.
125+
:::
126+
127+
122128
### Minimal installation via `pip`
123129

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

0 commit comments

Comments
 (0)