Skip to content

Commit 89accdc

Browse files
committed
📝 add pipx as default install
1 parent 545b834 commit 89accdc

File tree

1 file changed

+31
-5
lines changed

1 file changed

+31
-5
lines changed

docs/index.md

Lines changed: 31 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,42 @@
2929

3030
## 🛠 Installation
3131

32-
```sh
33-
pip install pls-cli
34-
```
32+
!!! success "Recommended: Using pipx (isolated environment)"
3533

36-
!!! tip "Upgrade Version"
34+
[pipx](https://pipx.pypa.io/) installs the CLI in an isolated environment, avoiding conflicts with other packages:
3735

3836
```sh
39-
pip install pls-cli --upgrade
37+
# Install pipx if you haven't already
38+
python3 -m pip install --user pipx
39+
python3 -m pipx ensurepath
40+
41+
# Install pls-cli
42+
pipx install pls-cli
4043
```
4144

45+
!!! info "Alternative: Using pip"
46+
47+
```sh
48+
pip install pls-cli
49+
```
50+
51+
!!! warning
52+
Installing with pip may cause dependency conflicts with other packages. We recommend using pipx for CLI tools.
53+
54+
!!! tip "Upgrade Version"
55+
56+
=== "With pipx (recommended)"
57+
58+
```sh
59+
pipx upgrade pls-cli
60+
```
61+
62+
=== "With pip"
63+
64+
```sh
65+
pip install pls-cli --upgrade
66+
```
67+
4268
## ⚙️ Configuration
4369

4470
To run **`pls-cli`** everytime you open your shell's:

0 commit comments

Comments
 (0)