# tmuxp CLI manual

Source: https://libtmux.org/en/py/stable/workspace/cli/

> Use tmuxp to load, inspect and save workspace configurations.

Use `tmuxp` to load, inspect and save workspace configurations. [Install
tmuxp](https://libtmux.org/en/py/stable/workspace/guides/installation/) separately from the core [`libtmux`](<https://libtmux.org/en/py/stable/reference/#libtmux>) package.

## Sessions

<dl class="cli-command-list">
  <dt><a href="./load/"><code>load</code></a></dt>
  <dd>Build a session from files or saved workspace names.</dd>
  <dt><a href="./freeze/"><code>freeze</code></a></dt>
  <dd>Export a running session to a workspace configuration.</dd>
</dl>

## Workspace files

<dl class="cli-command-list">
  <dt><a href="./ls/"><code>ls</code></a></dt>
  <dd>List saved configurations.</dd>
  <dt><a href="./search/"><code>search</code></a></dt>
  <dd>Find configurations by name or content.</dd>
  <dt><a href="./edit/"><code>edit</code></a></dt>
  <dd>Open a workspace in an editor.</dd>
  <dt><a href="./convert/"><code>convert</code></a></dt>
  <dd>Change a workspace between YAML and JSON representation.</dd>
  <dt><a href="./import/"><code>import</code></a></dt>
  <dd>Translate Teamocil or tmuxinator configuration.</dd>
</dl>

## Diagnostics and shell

<dl class="cli-command-list">
  <dt><a href="./debug-info/"><code>debug-info</code></a></dt>
  <dd>Report runtime and tmux information.</dd>
  <dt><a href="./shell/"><code>shell</code></a></dt>
  <dd>Evaluate Python with tmux context.</dd>
</dl>

## Command options

Root options precede the subcommand:

```console
$ tmuxp --color never ls
```

Short flags belong to their command: [`search -S`](https://libtmux.org/en/py/stable/workspace/cli/search/) selects smart-case matching,
while [`load`](https://libtmux.org/en/py/stable/workspace/cli/load/)` `[`-S`](https://libtmux.org/en/py/stable/workspace/cli/load/#arguments-and-flags-s) selects a socket path. Show the installed command options before
using a flag:

```console
$ tmuxp load --help
```

Machine output is command-specific. Read each command reference for its
supported formats and empty-result behavior.

[Command source](https://github.com/tmux-python/tmuxp/blob/618b398acc05506d3c682906c36cdeb29dcfa1ff/src/tmuxp/cli/__init__.py).