Skip to content

Commit 1c8986b

Browse files
committed
docs(installation): Add uv alternatives to pip install commands
why: Provide modern uv-based installation options alongside existing pip/pipx commands what: - Add uv tool install and uvx examples to all documentation files - Include uv sync alternative in CLAUDE.md for development setup - Add uv tool upgrade, --prerelease=allow, and --from git+ examples - Verify all commands work correctly through testing refs: Tested all commands successfully with uv 0.9.2
1 parent ffc9b70 commit 1c8986b

File tree

4 files changed

+64
-0
lines changed

4 files changed

+64
-0
lines changed

CLAUDE.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ vcspull is a Python tool for managing and synchronizing multiple git, svn, and m
2222
```bash
2323
# Install development dependencies with uv
2424
uv pip install -e .
25+
26+
# Alternative: Use uv sync to install from pyproject.toml
27+
uv sync
2528
```
2629

2730
### Common Commands

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,18 @@ See the [documentation](https://vcspull.git-pull.com/), [configuration](https://
2929
$ pip install --user vcspull
3030
```
3131

32+
Or using uv:
33+
34+
```console
35+
$ uv tool install vcspull
36+
```
37+
38+
For one-time use without installation:
39+
40+
```console
41+
$ uvx vcspull
42+
```
43+
3244
### Developmental releases
3345

3446
You can test the unpublished version of vcspull before its released.
@@ -47,6 +59,12 @@ You can test the unpublished version of vcspull before its released.
4759

4860
Then use `vcspull@next sync [config]...`.
4961

62+
- [uv](https://docs.astral.sh/uv/):
63+
64+
```console
65+
$ uv tool install --prerelease=allow vcspull
66+
```
67+
5068
## Configuration
5169

5270
Add your repos to `~/.vcspull.yaml`.

docs/cli/completion.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,18 @@ Provisional support for completions in vcspull 1.15+ are powered by [shtab](http
1818
$ pip install shtab --user
1919
```
2020

21+
Or using uv:
22+
23+
```console
24+
$ uv tool install shtab
25+
```
26+
27+
For one-time use without installation:
28+
29+
```console
30+
$ uvx shtab
31+
```
32+
2133
:::{tab} bash
2234

2335
```bash

docs/quickstart.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,30 @@ For latest official version:
1010
$ pip install --user vcspull
1111
```
1212

13+
Or using uv:
14+
15+
```console
16+
$ uv tool install vcspull
17+
```
18+
19+
For one-time use without installation:
20+
21+
```console
22+
$ uvx vcspull
23+
```
24+
1325
Upgrading:
1426

1527
```console
1628
$ pip install --user --upgrade vcspull
1729
```
1830

31+
Or with uv:
32+
33+
```console
34+
$ uv tool upgrade vcspull
35+
```
36+
1937
(developmental-releases)=
2038

2139
### Developmental releases
@@ -38,6 +56,12 @@ In their versions you will see notification like `a1`, `b1`, and `rc1`, respecti
3856

3957
Then use `vcspull@next sync [config]...`.
4058

59+
- [uv]\:
60+
61+
```console
62+
$ uv tool install --prerelease=allow vcspull
63+
```
64+
4165
via trunk (can break easily):
4266

4367
- [pip]\:
@@ -52,8 +76,15 @@ via trunk (can break easily):
5276
$ pipx install --suffix=@master 'vcspull @ git+https://github.com/vcs-python/vcspull.git@master' --force
5377
```
5478

79+
- [uv]\:
80+
81+
```console
82+
$ uv tool install vcspull --from git+https://github.com/vcs-python/vcspull.git
83+
```
84+
5585
[pip]: https://pip.pypa.io/en/stable/
5686
[pipx]: https://pypa.github.io/pipx/docs/
87+
[uv]: https://docs.astral.sh/uv/
5788

5889
## Configuration
5990

0 commit comments

Comments
 (0)