# LibTmuxWorkspace API reference

Source: https://libtmux.org/en/julia/latest/workspace/reference/

> Public LibTmuxWorkspace declarations, parameters and source documentation.

Use [`LibTmuxWorkspace`](<https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace/>) to read, validate, plan and load workspace files.
Validation and planning do not contact tmux. Applying a plan can create
resources and execute shell input.

Read the [package guide](https://libtmux.org/en/julia/latest/workspace/source-guide/) for installation and complete examples.

## API declarations

- [LibTmuxWorkspace.apply](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-apply/)
- [Base.close](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-base-close/)
- [Base.showerror](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-base-showerror/)
- [LibTmuxWorkspace.BeforeScriptError](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-beforescripterror/)
- [LibTmuxWorkspace.CommandConfig](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-commandconfig/)
- [LibTmuxWorkspace.ConfigLimits](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-configlimits/)
- [LibTmuxWorkspace.expand](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-expand/)
- [LibTmuxWorkspace.ExpandedPane](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-expandedpane/)
- [LibTmuxWorkspace.ExpandedWindow](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-expandedwindow/)
- [LibTmuxWorkspace.ExpandedWorkspace](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-expandedworkspace/)
- [LibTmuxWorkspace.freeze](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-freeze/)
- [LibTmuxWorkspace.install_cli](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-install_cli/)
- [LibTmuxWorkspace](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace/)
- [LibTmuxWorkspace.main](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-main/)
- [LibTmuxWorkspace.PaneConfig](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-paneconfig/)
- [LibTmuxWorkspace.parse_config](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-parse_config/)
- [LibTmuxWorkspace.plan](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-plan/)
- [LibTmuxWorkspace.PlanStep](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-planstep/)
- [LibTmuxWorkspace.read_config](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-read_config/)
- [LibTmuxWorkspace.run_before_script](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-run_before_script/)
- [LibTmuxWorkspace.ScriptResult](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-scriptresult/)
- [LibTmuxWorkspace.validate](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-validate/)
- [LibTmuxWorkspace.WindowConfig](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-windowconfig/)
- [LibTmuxWorkspace.WorkspaceApplyError](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-workspaceapplyerror/)
- [LibTmuxWorkspace.WorkspaceApplyResult](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-workspaceapplyresult/)
- [LibTmuxWorkspace.WorkspaceConfig](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-workspaceconfig/)
- [LibTmuxWorkspace.WorkspaceConfigError](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-workspaceconfigerror/)
- [LibTmuxWorkspace.WorkspaceDocument](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-workspacedocument/)
- [LibTmuxWorkspace.WorkspacePlan](https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-workspaceplan/)