Skip to content

Commit 26c4959

Browse files
authored
chore: update README to recommend pipx / uv tool (#41)
fixes #39
1 parent ba692b0 commit 26c4959

1 file changed

Lines changed: 16 additions & 4 deletions

File tree

README.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,15 @@ A super light-weight, effective embedded MCP **(AST-based)** that understand and
4444

4545
## Get Started - zero config, let's go!!
4646

47-
Requires Python 3 (`pip3` comes pre-installed with Python).
47+
Using [pipx](https://pipx.pypa.io/stable/installation/):
48+
```bash
49+
pipx install cocoindex-code # first install
50+
pipx upgrade cocoindex-code # upgrade
51+
```
4852

53+
Using [uv](https://docs.astral.sh/uv/getting-started/installation/):
4954
```bash
50-
pip3 install -U cocoindex-code
55+
uv tool install --upgrade cocoindex-code --prerelease explicit --with "cocoindex>=1.0.0a24"
5156
```
5257

5358
### Claude
@@ -342,10 +347,17 @@ Some Python installations (e.g. the one pre-installed on macOS) ship with a SQLi
342347
brew install python3
343348
```
344349

345-
Then re-install cocoindex-code with the Homebrew Python:
350+
Then re-install cocoindex-code (see [Get Started](#get-started---zero-config-lets-go) for install options):
351+
352+
Using pipx:
353+
```bash
354+
pipx install cocoindex-code # first install
355+
pipx upgrade cocoindex-code # upgrade
356+
```
346357

358+
Using uv (install or upgrade):
347359
```bash
348-
pip3 install -U cocoindex-code
360+
uv tool install --upgrade cocoindex-code --prerelease explicit --with "cocoindex>=1.0.0a24"
349361
```
350362

351363
## Large codebase / Enterprise

0 commit comments

Comments
 (0)