Skip to content

Commit 3976aa0

Browse files
committed
docs: Add installation page
why: Separating installation mechanics from client configuration and quickstart follows the pattern used by Playwright and GitHub MCP servers. what: - Create docs/installation.md with requirements, uvx, pip, dev install - Include upgrade and run instructions - Link to clients page for MCP client wiring
1 parent 3199d36 commit 3976aa0

1 file changed

Lines changed: 67 additions & 0 deletions

File tree

docs/installation.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
(installation)=
2+
3+
# Installation
4+
5+
## Requirements
6+
7+
- Python 3.10+
8+
- tmux >= 3.2a
9+
- [uv](https://docs.astral.sh/uv/) (recommended) or pip
10+
11+
## Recommended: uvx
12+
13+
`uvx` handles install, deps, and execution in one step — no persistent install needed:
14+
15+
```console
16+
$ uvx libtmux-mcp
17+
```
18+
19+
To wire it into your MCP client, see {ref}`clients`.
20+
21+
## pip / uv pip
22+
23+
```console
24+
$ uv pip install libtmux-mcp
25+
```
26+
27+
```console
28+
$ pip install libtmux-mcp
29+
```
30+
31+
## Development install
32+
33+
Clone and install in editable mode:
34+
35+
```console
36+
$ git clone https://github.com/tmux-python/libtmux-mcp.git
37+
```
38+
39+
```console
40+
$ cd libtmux-mcp
41+
```
42+
43+
```console
44+
$ uv pip install -e "."
45+
```
46+
47+
Code changes take effect immediately — no reinstall needed.
48+
49+
## Running the server
50+
51+
```console
52+
$ libtmux-mcp
53+
```
54+
55+
Or via Python module:
56+
57+
```console
58+
$ python -m libtmux_mcp
59+
```
60+
61+
## Upgrading
62+
63+
```console
64+
$ uv pip install --upgrade libtmux-mcp
65+
```
66+
67+
With `uvx`, you always get the latest version automatically.

0 commit comments

Comments
 (0)