Skip to content

Commit 840d6fa

Browse files
committed
docs(quickstart): Add pipx, uv tool, and uvx installation instructions
- Add pipx with --suffix=@next for pre-release versions - Add uv tool install with --prerelease=allow - Add uv add for adding to project dependencies - Add uvx for one-time execution from pre-releases - Add trunk installation options for pipx and uv - Add reference links for all tools - Follow pattern from vcspull project - No specific version numbers mentioned per project convention
1 parent 5f24887 commit 840d6fa

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

docs/quickstart.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,31 @@ the 4th beta release of `1.10.0` before general availability.
4141
$ pip install --user --upgrade --pre libtmux
4242
```
4343

44+
- [pipx]\:
45+
46+
```console
47+
$ pipx install --suffix=@next 'libtmux' --pip-args '\--pre' --force
48+
// Usage: libtmux@next [command]
49+
```
50+
51+
- [uv tool install][uv-tools]\:
52+
53+
```console
54+
$ uv tool install --prerelease=allow libtmux
55+
```
56+
57+
- [uv]\:
58+
59+
```console
60+
$ uv add libtmux --prerelease allow
61+
```
62+
63+
- [uvx]\:
64+
65+
```console
66+
$ uvx --from 'libtmux' --prerelease allow python
67+
```
68+
4469
via trunk (can break easily):
4570

4671
- [pip]\:
@@ -49,7 +74,23 @@ via trunk (can break easily):
4974
$ pip install --user -e git+https://github.com/tmux-python/libtmux.git#egg=libtmux
5075
```
5176

77+
- [pipx]\:
78+
79+
```console
80+
$ pipx install --suffix=@master 'libtmux @ git+https://github.com/tmux-python/libtmux.git@master' --force
81+
```
82+
83+
- [uv]\:
84+
85+
```console
86+
$ uv tool install libtmux --from git+https://github.com/tmux-python/libtmux.git
87+
```
88+
5289
[pip]: https://pip.pypa.io/en/stable/
90+
[pipx]: https://pypa.github.io/pipx/docs/
91+
[uv]: https://docs.astral.sh/uv/
92+
[uv-tools]: https://docs.astral.sh/uv/concepts/tools/
93+
[uvx]: https://docs.astral.sh/uv/guides/tools/
5394
[ptpython]: https://github.com/prompt-toolkit/ptpython
5495

5596
## Start a tmux session

0 commit comments

Comments
 (0)