# tmux-workspace CLI manual

Source: https://libtmux.org/en/csharp/latest/workspace/cli/

> Use `tmux-workspace` to load, inspect and save workspace files.

Use `tmux-workspace` to load, inspect and save workspace files. Complete
[installation](https://libtmux.org/en/csharp/latest/workspace/guides/installation/) and put the executable on `PATH` before
using these commands.

## Sessions

<dl class="cli-command-list">
  <dt><a href="./load/"><code>load</code></a></dt>
  <dd>Create a session from a workspace file.</dd>
  <dt><a href="./freeze/"><code>freeze</code></a></dt>
  <dd>Capture a running session into a workspace document.</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 saved configurations.</dd>
  <dt><a href="./edit/"><code>edit</code></a></dt>
  <dd>Open a configuration in your editor.</dd>
  <dt><a href="./convert/"><code>convert</code></a></dt>
  <dd>Change a document between YAML and JSON.</dd>
  <dt><a href="./import/"><code>import</code></a></dt>
  <dd>Translate Teamocil or tmuxinator configuration.</dd>
</dl>

## Diagnostics and completion

<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="./completion/"><code>completion</code></a></dt>
  <dd>Generate completion for your shell.</dd>
</dl>

## Command options

Show the options accepted by the installed command:

```console
$ tmux-workspace load --help
```

## Machine output

`--json` requests one JSON result. `--ndjson` requests a stream of records and
takes precedence when both are present. Select detached loading with `-d` when
automating session creation. Check the exit status as well as the result; a
failed load can leave completed tmux operations in place.

The [output reference](https://libtmux.org/en/csharp/latest/workspace/reference/output/) describes the result records, and
[automation](https://libtmux.org/en/csharp/latest/workspace/guides/automation/) covers scripts.

[CLI source](https://github.com/libtmux/libtmux-dotnet/blob/f77fe776ba67a04abb20ddbbc26cf4a000d63b74/src/LibTmux.Workspace.Cli/README.md).