Skip to content

index.md

Latest commit

 

History

History
109 lines (82 loc) · 1.43 KB

index.md

File metadata and controls

109 lines (82 loc) · 1.43 KB

(cli)=

(commands)=

CLI Reference

::::{grid} 1 1 2 2 :gutter: 2 2 3 3

:::{grid-item-card} tmuxp load :link: load :link-type: doc Load tmux sessions from workspace configs. :::

:::{grid-item-card} tmuxp shell :link: shell :link-type: doc Interactive Python shell with tmux context. :::

:::{grid-item-card} tmuxp freeze :link: freeze :link-type: doc Export running sessions to config files. :::

:::{grid-item-card} tmuxp convert :link: convert :link-type: doc Convert between YAML and JSON formats. :::

:::{grid-item-card} Exit Codes :link: exit-codes :link-type: doc Exit codes for scripting and automation. :::

:::{grid-item-card} Recipes :link: recipes :link-type: doc Copy-pasteable command invocations. :::

::::

:caption: General commands
:maxdepth: 1

load
shell
ls
search

:caption: Configuration
:maxdepth: 1

edit
import
convert
freeze

:caption: Diagnostic
:maxdepth: 1

debug-info

:caption: Completion
:maxdepth: 1

completion

:caption: Reference
:maxdepth: 1

exit-codes
recipes

(cli-main)=

(tmuxp-main)=

Main command

The tmuxp command is the entry point for all tmuxp operations. Use subcommands to load sessions, manage configurations, and interact with tmux.

Command

.. argparse::
    :module: tmuxp.cli
    :func: create_parser
    :prog: tmuxp
    :nosubcommands:

    subparser_name : @replace
        See :ref:`cli-ls`