Skip to content

Commit 35b4f7d

Browse files
committed
docs(installation): Add inline tabs for uvx/pipx/uv/pip alternatives
why: uvx isn't the only way to run the package. Users may prefer pipx, uv pip, or plain pip. Inline tabs let them pick without scrolling. what: - Add sphinx-inline-tabs for run (uvx/pipx), install (uv/pip), upgrade - Remove uv from README requirements line — it's one option, not required - Fix [uv] links: GitHub repo for the project, install page for setup - Verified uvx and pipx run both start the server successfully
1 parent c2f2fb8 commit 35b4f7d

3 files changed

Lines changed: 28 additions & 9 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Give your AI agent hands inside the terminal — create sessions, run commands,
2424

2525
## Quickstart
2626

27-
**Requirements:** Python 3.10+, tmux on `$PATH`, [uv](https://docs.astral.sh/uv/) ([install](https://docs.astral.sh/uv/getting-started/installation/)).
27+
**Requirements:** Python 3.10+, tmux on `$PATH`.
2828

2929
Install and run:
3030

docs/installation.md

Lines changed: 25 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,42 @@
66

77
- Python 3.10+
88
- tmux >= 3.2a
9-
- [uv](https://docs.astral.sh/uv/) ([install](https://docs.astral.sh/uv/getting-started/installation/)) — recommended, or pip
109

11-
## Recommended: uvx
10+
## Run without installing
1211

13-
`uvx` handles install, deps, and execution in one step — no persistent install needed:
12+
No persistent install needed — run directly with a package executor:
1413

14+
`````{tab} uvx
1515
```console
1616
$ uvx libtmux-mcp
1717
```
18+
`````
19+
20+
`````{tab} pipx
21+
```console
22+
$ pipx run libtmux-mcp
23+
```
24+
`````
1825

1926
To wire it into your MCP client, see {ref}`clients`.
2027

21-
## pip / uv pip
28+
## Install the package
2229

30+
`````{tab} uv
2331
```console
2432
$ uv pip install libtmux-mcp
2533
```
34+
`````
2635

36+
`````{tab} pip
2737
```console
2838
$ pip install libtmux-mcp
2939
```
40+
`````
3041

3142
## Development install
3243

33-
Clone and install in editable mode:
44+
Install [uv](https://github.com/astral-sh/uv) ([install](https://docs.astral.sh/uv/getting-started/installation/)), then clone and install in editable mode:
3445

3546
```console
3647
$ git clone https://github.com/tmux-python/libtmux-mcp.git
@@ -60,8 +71,16 @@ $ python -m libtmux_mcp
6071

6172
## Upgrading
6273

74+
`````{tab} uv
6375
```console
6476
$ uv pip install --upgrade libtmux-mcp
6577
```
78+
`````
79+
80+
`````{tab} pip
81+
```console
82+
$ pip install --upgrade libtmux-mcp
83+
```
84+
`````
6685

67-
With `uvx`, you always get the latest version automatically.
86+
With `uvx` or `pipx run`, you always get the latest version automatically.

docs/project/contributing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
# Development
22

3-
Install [git] and [uv]
3+
Install [git] and [uv] ([install](https://docs.astral.sh/uv/getting-started/installation/))
44

55
[git]: https://git-scm.com/
6-
[uv]: https://docs.astral.sh/uv/getting-started/installation/
6+
[uv]: https://github.com/astral-sh/uv
77

88
Clone:
99

0 commit comments

Comments
 (0)