Skip to content

Commit 0584e90

Browse files
committed
docs(README): update installation methods
1 parent a7ae682 commit 0584e90

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

docs/README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -61,21 +61,26 @@ Before installing Commitizen, ensure you have:
6161

6262
#### Global Installation (Recommended)
6363

64-
The recommended way to install Commitizen is using `pipx`, which ensures a clean, isolated installation:
65-
64+
The recommended way to install Commitizen is using [`pipx`](https://pipx.pypa.io/) or [`uv`](https://docs.astral.sh/uv/), which ensures a clean, isolated installation:
65+
**Using pipx:**
6666
```bash
67-
# Install pipx if you haven't already
68-
pipx ensurepath
69-
7067
# Install Commitizen
7168
pipx install commitizen
7269

7370
# Keep it updated
7471
pipx upgrade commitizen
7572
```
7673

77-
If you're on macOS, you can also install Commitizen using Homebrew:
74+
**Using uv:**
75+
```bash
76+
# Install commitizen
77+
uv tool install commitizen
7878

79+
# Keep it updated
80+
uv tool upgrade commitizen
81+
```
82+
83+
**(For macOS users) Using Homebrew:**
7984
```bash
8085
brew install commitizen
8186
```
@@ -85,19 +90,16 @@ brew install commitizen
8590
You can add Commitizen to your Python project using any of these package managers:
8691

8792
**Using pip:**
88-
8993
```bash
9094
pip install -U commitizen
9195
```
9296

9397
**Using conda:**
94-
9598
```bash
9699
conda install -c conda-forge commitizen
97100
```
98101

99102
**Using Poetry:**
100-
101103
```bash
102104
# For Poetry >= 1.2.0
103105
poetry add commitizen --group dev

0 commit comments

Comments
 (0)