Skip to content

Commit f5518bd

Browse files
committed
docs(cli): More improvements
1 parent a18143d commit f5518bd

File tree

1 file changed

+55
-12
lines changed

1 file changed

+55
-12
lines changed

docs/cli.md

+55-12
Original file line numberDiff line numberDiff line change
@@ -231,17 +231,21 @@ Or (a)ppend windows in the current active session?
231231

232232
All of these options can be preselected to skip the prompt:
233233

234-
```console
235-
$ tmuxp load -y config # load attached
236-
```
234+
- Attach / open client after load:
237235

238-
```console
239-
$ tmuxp load -d config # load detached
240-
```
236+
```console
237+
$ tmuxp load -y config
238+
```
239+
- Detached / open in background:
241240

242-
```console
243-
$ tmuxp load -a config # append windows
244-
```
241+
```console
242+
$ tmuxp load -d config
243+
```
244+
- Append windows to existing session
245+
246+
```console
247+
$ tmuxp load -a config
248+
```
245249

246250
Multiple sessions can be loaded at once. The first ones will be created
247251
without being attached. The last one will be attached if there is no
@@ -264,6 +268,9 @@ debugging purposes. the log level can be controlled with the global
264268

265269
```console
266270
$ tmuxp load [filename] --log-file [log_filename]
271+
```
272+
273+
```console
267274
$ tmuxp --log-level [LEVEL] load [filename] --log-file [log_filename]
268275
```
269276

@@ -293,25 +300,61 @@ environment:
293300

294301
### From teamocil
295302

303+
````{tab} YAML
304+
305+
```console
306+
$ tmuxp import teamocil /path/to/file.yaml
307+
```
308+
309+
````
310+
311+
````{tab} JSON
312+
296313
```console
297-
$ tmuxp import teamocil /path/to/file.{json,yaml}
314+
$ tmuxp import teamocil /path/to/file.json
298315
```
299316
317+
````
318+
300319
(import-tmuxinator)=
301320

302321
### From tmuxinator
303322

323+
````{tab} YAML
324+
325+
```console
326+
$ tmuxp import tmuxinator /path/to/file.yaml
327+
```
328+
329+
````
330+
331+
````{tab} JSON
332+
304333
```console
305-
$ tmuxp import tmuxinator /path/to/file.{json,yaml}
334+
$ tmuxp import tmuxinator /path/to/file.json
306335
```
307336
337+
````
338+
308339
(convert-config)=
309340

310341
## Convert between YAML and JSON
311342

343+
````{tab} YAML -> JSON
344+
312345
```console
313-
$ tmuxp convert /path/to/file.{json,yaml}
346+
$ tmuxp convert /path/to/file.yaml
314347
```
315348
349+
````
350+
351+
````{tab} JSON -> YAML
352+
353+
```console
354+
$ tmuxp convert /path/to/file.json
355+
```
356+
357+
````
358+
316359
tmuxp automatically will prompt to convert `.yaml` to `.json` and
317360
`.json` to `.yaml`.

0 commit comments

Comments
 (0)