Skip to content

Commit 0cff4b8

Browse files
committed
Docs: Recommend Pipx & uv to install VirtualFish
1 parent d9394a8 commit 0cff4b8

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

docs/install.rst

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,23 @@ Installing
77
1. Make sure you are running Fish 3.1+. If you are running an Ubuntu LTS
88
release that has an older Fish version, install Fish via the
99
`Fish 3.x release series PPA`_.
10-
2. The easiest way to install VirtualFish is by running: ``python -m pip install --user virtualfish``.
11-
If you're using `Pipx`_, it is better to use: ``pipx install virtualfish``.
10+
11+
2. The recommended way to install VirtualFish is to first install `Pipx`_ and
12+
then run::
13+
14+
pipx install virtualfish
15+
pipx ensurepath
16+
17+
Alternatively, you can first install `uv`_ and then run::
18+
19+
uv tool install virtualfish
20+
uv tool update-shell
21+
22+
Yet another option is to use Pip::
23+
24+
python -m pip install --user virtualfish
25+
fish_add_path (python3 -c "import site; print(site.USER_BASE)")/bin
26+
1227
3. Install the VirtualFish loader by running:
1328

1429
::
@@ -26,7 +41,7 @@ Installing
2641
``exec fish`` in order to make these changes active in your current
2742
shell session.
2843

29-
4. Customize your ``fish_prompt``
44+
4. Customize your ``fish_prompt`` as described below.
3045

3146
Customizing Your ``fish_prompt``
3247
--------------------------------
@@ -59,4 +74,5 @@ To un-install VirtualFish, run:
5974

6075

6176
.. _Fish 3.x release series PPA: https://launchpad.net/~fish-shell/+archive/ubuntu/release-3
62-
.. _Pipx: https://pipxproject.github.io/pipx/
77+
.. _Pipx: https://pipx.pypa.io/
78+
.. _uv: https://docs.astral.sh/uv/

0 commit comments

Comments
 (0)