You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cli/completion.md
+48-1Lines changed: 48 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,58 @@
1
1
(completion)=
2
2
3
-
# Completion
3
+
(completions)=
4
+
5
+
(cli-completions)=
6
+
7
+
# Completions
8
+
9
+
## tmuxp 1.17+ (experimental)
10
+
11
+
```{note}
12
+
See the [shtab library's documentation on shell completion](https://docs.iterative.ai/shtab/use/#cli-usage) for the most up to date way of connecting completion for tmuxp.
13
+
```
14
+
15
+
Provisional support for completions in tmuxp 1.17+ are powered by [shtab](https://docs.iterative.ai/shtab/). This must be **installed separately**, as it's **not currently bundled with tmuxp**.
16
+
17
+
```console
18
+
$ pip install shtab --user
19
+
```
20
+
21
+
:::{tab} bash
22
+
23
+
```bash
24
+
shtab --shell=bash -u tmuxp.cli.create_parser \
25
+
| sudo tee "$BASH_COMPLETION_COMPAT_DIR"/TMUXP
26
+
```
27
+
28
+
:::
29
+
30
+
:::{tab} zsh
31
+
32
+
```zsh
33
+
shtab --shell=zsh -u tmuxp.cli.create_parser \
34
+
| sudo tee /usr/local/share/zsh/site-functions/_TMUXP
35
+
```
36
+
37
+
:::
38
+
39
+
:::{tab} tcsh
40
+
41
+
```zsh
42
+
shtab --shell=tcsh -u tmuxp.cli.create_parser \
43
+
| sudo tee /etc/profile.d/TMUXP.completion.csh
44
+
```
45
+
46
+
:::
47
+
48
+
## tmuxp 1.1 to 1.16
4
49
5
50
```{note}
6
51
See the [click library's documentation on shell completion](https://click.palletsprojects.com/en/8.0.x/shell-completion/) for the most up to date way of connecting completion for tmuxp.
7
52
```
8
53
54
+
tmuxp 1.1 to 1.16 use [click](https://click.palletsprojects.com)'s completion:
0 commit comments