# Go workspace internals

Source: https://libtmux.org/en/go/latest/workspace/internals/

> Architecture and development interfaces of the Go workspace builder.

These pages document the in-development workspace builder for contributors
and applications that call its APIs. For workspace loading from a terminal,
see [tmuxp](https://tmuxp.git-pull.com/).

## Builder pipeline

`Parse` validates the YAML before tmux construction begins. `Build` creates
the session and owns a temporary control connection for construction;
`BuildInto` uses an existing session connection. The caller supplies file
reading, deadlines, command-line handling, and attachment.

## Read the implementation

- [Guides](./guides/) show builder setup and application code.
- [Topics](./topics/) explain configuration, behavior, and failures.
- [Examples](./examples/) exercise the builder through the language API.
- [API](../reference/) links the configuration and construction interfaces.

## Implementation scope

The `workspace` module parses [tmuxp](https://tmuxp.git-pull.com)-style YAML
and builds a session through libtmux's Go API. It is a separate module, so
applications using only the core client do not acquire a YAML dependency.

Parsing validates the whole document before construction. Building returns
the created session, including a session handle alongside an error when later
operations fail and leave a partial workspace.

## Package and runtime

Import [`github.com/libtmux/libtmux-go/workspace`](https://pkg.go.dev/github.com/libtmux/libtmux-go/workspace) together with the core `tmux`
package. Building requires tmux on the host. Parsing and configuration
validation do not start a tmux server.

The module supports tmuxp field names for windows, panes, commands, options,
environment variables, and working directories. Python plugins and
`before_script` are rejected. Inspect the supported subset when moving an
existing Python workspace to Go.

[Workspace module documentation](https://github.com/libtmux/libtmux-go/blob/5f808882015a975a65acc7f9da5b3ff0d5cbdc91/workspace/README.md)