Skip to content

Commit de07983

Browse files
committed
docs(quickstart): Match uv, uvx, pipx pattern for developmental releases
- Break out uv into separate sections (pipx, uv tool install, uv, uvx) - Add --prerelease=allow to uv tool install - Add --prerelease allow to uv add and uvx commands - Update usage comment format for pipx to match vcspull - Add markdown link references for uv-tools and uvx - Remove specific prerelease version mentions
1 parent 4e02045 commit de07983

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

docs/quickstart.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -58,28 +58,31 @@ In their versions you will see notification like `a1`, `b1`, and `rc1`, respecti
5858
$ pip install --user --upgrade --pre g
5959
```
6060

61-
- [uv]\:
61+
- [pipx]\:
6262

6363
```console
64-
$ uv tool install g
64+
$ pipx install --suffix=@next 'g' --pip-args '\--pre' --force
65+
// Usage: g@next --help
6566
```
6667

68+
- [uv tool install][uv-tools]\:
69+
6770
```console
68-
$ uv add g
71+
$ uv tool install --prerelease=allow g
6972
```
7073

74+
- [uv]\:
75+
7176
```console
72-
$ uvx g
77+
$ uv add g --prerelease allow
7378
```
7479

75-
- [pipx]\:
80+
- [uvx]\:
7681

7782
```console
78-
$ pipx install --suffix=@next 'g' --pip-args '\--pre' --force
83+
$ uvx --from 'g' --prerelease allow g
7984
```
8085

81-
Then use `g@next sync [config]...`.
82-
8386
via trunk (can break easily):
8487

8588
- [pip]\:
@@ -111,3 +114,5 @@ via trunk (can break easily):
111114
[pip]: https://pip.pypa.io/en/stable/
112115
[pipx]: https://pypa.github.io/pipx/docs/
113116
[uv]: https://docs.astral.sh/uv/
117+
[uv-tools]: https://docs.astral.sh/uv/concepts/tools/
118+
[uvx]: https://docs.astral.sh/uv/guides/tools/

0 commit comments

Comments
 (0)