# Python workspace manager

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

> Describe a tmux session in a file, then load, inspect and capture it.

[tmuxp](https://tmuxp.git-pull.com/) loads tmux sessions from YAML or JSON using
libtmux. A file describes windows, panes and commands. [`tmuxp load`](https://libtmux.org/en/py/stable/workspace/cli/load/) builds the
session and can attach to it or leave it detached.

## Start here

1. [Install tmuxp and load a workspace](https://libtmux.org/en/py/stable/workspace/guides/installation/).
2. [Configure windows and panes](https://libtmux.org/en/py/stable/workspace/configuration/).
3. [Capture and reload a session](https://libtmux.org/en/py/stable/workspace/guides/export-session/).

The [CLI manual](https://libtmux.org/en/py/stable/workspace/cli/) covers discovery, search, editing, conversion
and import. Use [examples](https://libtmux.org/en/py/stable/workspace/examples/gallery/) for complete files and their
prerequisites.

Install tmuxp separately from the core libtmux package. Its dependency resolver
selects a compatible libtmux release. [Workspace internals](https://libtmux.org/en/py/stable/workspace/internals/)
describe the builder and Python extension APIs.

[Quickstart source](https://github.com/tmux-python/tmuxp/blob/618b398acc05506d3c682906c36cdeb29dcfa1ff/docs/quickstart.md).



- [CLI Manual](https://libtmux.org/en/py/stable/workspace/cli/): Commands, options and machine output.
- [Configuration](https://libtmux.org/en/py/stable/workspace/configuration/): Workspace fields, normalization and execution.
- [Install and load](https://libtmux.org/en/py/stable/workspace/guides/installation/): Load a workspace on a private socket, then capture it.
- [Example gallery](https://libtmux.org/en/py/stable/workspace/examples/gallery/): Workspace files to start from, with their prerequisites.
- [Runtime support](https://libtmux.org/en/py/stable/workspace/reference/compatibility/): Runtime requirements and supported behavior.
- [Internals](https://libtmux.org/en/py/stable/workspace/internals/): The workspace library, for building sessions from code.