# tmuxp.cli.load.load_workspace

- **Module:** tmuxp.cli.load
- **Package:** tmuxp
- **Language:** Python
- **Kind:** function
- **Source:** https://github.com/tmux-python/tmuxp/blob/153acdf6ff1268b14d3d03ed488f545a7123c8f1/src/tmuxp/cli/load.py#L459
- **Page:** https://libtmux.org/en/py/latest/workspace/reference/tmuxp-cli-load-load_workspace/

```
tmuxp.cli.load.load_workspace(workspace_file: StrPath, socket_name: str | None = None, socket_path: str | None = None, tmux_config_file: str | None = None, new_session_name: str | None = None, colors: int | None = None, detached: bool = False, answer_yes: bool = False, append: bool = False, cli_colors: Colors | None = None, progress_format: str | None = None, panel_lines: int | None = None, no_progress: bool = False) -> Session | None
```

Entrypoint for ``tmuxp load``, load a tmuxp "workspace" session via config file.

## Parameters

- `workspace_file` (StrPath): paths or session names to workspace files
- `socket_name` (str | None): ``tmux -L <socket-name>``
- `socket_path` (str | None): ``tmux -S <socket-path>``
- `tmux_config_file` (str | None)
- `new_session_name` (str | None): ``tmux new -s <new_session_name>``
- `colors` (int | None): Force tmux to support 256 or 88 colors.
- `detached` (bool): Force detached state. default False.
- `answer_yes` (bool): Assume yes when given prompt to attach in new session.
Default False.
- `append` (bool): Assume current when given prompt to append windows in same session.
Default False.
- `cli_colors` (Colors | None): Colors instance for CLI output formatting. If None, uses
:attr:`~tmuxp._internal.colors.ColorMode.AUTO`.
- `progress_format` (str | None): Spinner format preset name or custom format string with tokens.
- `panel_lines` (int | None): Number of script-output lines shown in the spinner panel.
Defaults to the :class:`~tmuxp.cli._progress.Spinner` default (3).
Override via ``TMUXP_PROGRESS_LINES`` environment variable.
- `no_progress` (bool): Disable the progress spinner entirely. Default False.
Also disabled when ``TMUXP_PROGRESS=0``.