Skip to content

Commit abf7a32

Browse files
committed
refactor(docs): Split commands up
1 parent f4fcc77 commit abf7a32

File tree

8 files changed

+396
-344
lines changed

8 files changed

+396
-344
lines changed

docs/cli/completion.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
(completion)=
2+
3+
# Completion
4+
5+
```{note}
6+
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 vcspull.
7+
```
8+
9+
:::{tab} Bash
10+
11+
_~/.bashrc_:
12+
13+
```bash
14+
15+
eval "$(_TMUXP_COMPLETE=bash_source tmuxp)"
16+
17+
```
18+
19+
:::
20+
21+
:::{tab} Zsh
22+
23+
_~/.zshrc_:
24+
25+
```zsh
26+
27+
eval "$(_TMUXP_COMPLETE=zsh_source tmuxp)"
28+
29+
```
30+
31+
:::

docs/cli/convert.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
(convert-config)=
2+
3+
(tmuxp-config)=
4+
5+
# tmuxp convert
6+
7+
Convert between YAML and JSON
8+
9+
````{tab} YAML -> JSON
10+
11+
```console
12+
$ tmuxp convert /path/to/file.yaml
13+
```
14+
15+
````
16+
17+
````{tab} JSON -> YAML
18+
19+
```console
20+
$ tmuxp convert /path/to/file.json
21+
```
22+
23+
````
24+
25+
tmuxp automatically will prompt to convert `.yaml` to `.json` and
26+
`.json` to `.yaml`.

docs/cli/debug-info.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
(cli-debug-info)=
2+
3+
(tmuxp-debug-info)=
4+
5+
# tmuxp debug-info
6+
7+
Use to collect all relevant information for submitting an issue to
8+
the project.
9+
10+
```console
11+
12+
$ tmuxp debug-info
13+
--------------------------
14+
environment:
15+
system: Linux
16+
arch: x86_64
17+
...
18+
19+
```

docs/cli/freeze.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
(cli-freeze)=
2+
3+
# tmuxp freeze
4+
5+
Freeze sessions
6+
7+
```console
8+
$ tmuxp freeze
9+
```
10+
11+
```console
12+
$ tmuxp freeze [session_name]
13+
```
14+
15+
```console
16+
$ tmuxp freeze --force [session_name]
17+
```
18+
19+
You can save the state of your tmux session by freezing it.
20+
21+
Tmuxp will offer to save your session state to `.json` or `.yaml`.
22+
23+
If no session is specified, it will default to the attached session.
24+
25+
If the `--force` argument is passed, it will overwrite any existing config file with the same name.

docs/cli/import.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
(cli-import)=
2+
3+
# tmuxp import
4+
5+
(import-teamocil)=
6+
7+
## From teamocil
8+
9+
````{tab} YAML
10+
11+
```console
12+
$ tmuxp import teamocil /path/to/file.yaml
13+
```
14+
15+
````
16+
17+
````{tab} JSON
18+
19+
```console
20+
$ tmuxp import teamocil /path/to/file.json
21+
```
22+
23+
````
24+
25+
(import-tmuxinator)=
26+
27+
## From tmuxinator
28+
29+
````{tab} YAML
30+
31+
```console
32+
$ tmuxp import tmuxinator /path/to/file.yaml
33+
```
34+
35+
````
36+
37+
````{tab} JSON
38+
39+
```console
40+
$ tmuxp import tmuxinator /path/to/file.json
41+
```
42+
43+
````

0 commit comments

Comments
 (0)