Skip to content

Commit 489d9fd

Browse files
committed
docs: Command documentation
1 parent c14498b commit 489d9fd

File tree

6 files changed

+59
-14
lines changed

6 files changed

+59
-14
lines changed

docs/cli/convert.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
(convert-config)=
22

3-
(tmuxp-config)=
4-
53
# tmuxp convert
64

75
Convert between YAML and JSON
@@ -24,3 +22,12 @@ $ tmuxp convert /path/to/file.json
2422

2523
tmuxp automatically will prompt to convert `.yaml` to `.json` and
2624
`.json` to `.yaml`.
25+
26+
## Reference
27+
28+
```{eval-rst}
29+
.. click:: tmuxp.cli:cli
30+
:prog: tmuxp convert
31+
:commands: convert
32+
:nested: full
33+
```

docs/cli/debug-info.md

+9
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,12 @@ environment:
1717
...
1818

1919
```
20+
21+
## Reference
22+
23+
```{eval-rst}
24+
.. click:: tmuxp.cli:cli
25+
:prog: tmuxp debug-info
26+
:commands: debug-info
27+
:nested: full
28+
```

docs/cli/freeze.md

+9
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,12 @@ Tmuxp will offer to save your session state to `.json` or `.yaml`.
2323
If no session is specified, it will default to the attached session.
2424

2525
If the `--force` argument is passed, it will overwrite any existing config file with the same name.
26+
27+
(cli-freeze-reference)=
28+
29+
```{eval-rst}
30+
.. click:: tmuxp.cli:cli
31+
:prog: tmuxp freeze
32+
:commands: freeze
33+
:nested: full
34+
```

docs/cli/import.md

+12
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@
66

77
## From teamocil
88

9+
```{eval-rst}
10+
.. click:: tmuxp.cli:command_import_teamocil
11+
:prog: tmuxp import teamocil
12+
:nested: full
13+
```
14+
915
````{tab} YAML
1016
1117
```console
@@ -26,6 +32,12 @@ $ tmuxp import teamocil /path/to/file.json
2632

2733
## From tmuxinator
2834

35+
```{eval-rst}
36+
.. click:: tmuxp.cli:command_import_tmuxinator
37+
:prog: tmuxp import tmuxinator
38+
:nested: short
39+
```
40+
2941
````{tab} YAML
3042
3143
```console

docs/cli/load.md

+9
Original file line numberDiff line numberDiff line change
@@ -118,3 +118,12 @@ $ tmuxp load [filename] --log-file [log_filename]
118118
```console
119119
$ tmuxp --log-level [LEVEL] load [filename] --log-file [log_filename]
120120
```
121+
122+
(tmuxp-load-reference)=
123+
124+
```{eval-rst}
125+
.. click:: tmuxp.cli:cli
126+
:prog: tmuxp load
127+
:commands: load
128+
:nested: full
129+
```

docs/cli/shell.md

+11-12
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,30 @@
11
(cli-shell)=
22

3-
(tmuxp-shell)=
4-
53
# tmuxp shell
64

7-
```console
8-
$ tmuxp shell
5+
```{eval-rst}
6+
.. click:: tmuxp.cli:command_shell
7+
:prog: tmuxp shell
8+
:commands: shell
9+
:nested: none
910
```
1011

11-
```console
12-
$ tmuxp shell [session_name]
13-
```
14-
15-
```console
16-
$ tmuxp shell [session_name] [window_name]
17-
```
12+
## Directly enter commands
1813

1914
```console
2015
$ tmuxp shell -c 'python code'
2116
```
2217

23-
Launch into a python console with [libtmux] objects. Compare to django's shell.
18+
## Example
2419

2520
```{image} ../_static/tmuxp-shell.gif
2621
:width: 100%
2722
```
2823

24+
## Guide
25+
26+
Launch into a python console with [libtmux] objects. Compare to django's shell.
27+
2928
Automatically preloads current tmux {class}`server <libtmux.Server>`,
3029
{class}`session <libtmux.Session>`, {class}`window <libtmux.Window>`
3130
{class}`pane <libtmux.Pane>`. Pass additional arguments to select a

0 commit comments

Comments
 (0)