# LibTmuxWorkspace.plan

- **Module:** LibTmuxWorkspace
- **Package:** LibTmuxWorkspace
- **Language:** Julia
- **Kind:** function
- **Source:** https://github.com/libtmux/libtmux-julia/blob/f3da513be1225d36d5854cd8db5972c01857578e/packages/LibTmuxWorkspace/src/plan.jl#L248
- **Page:** https://libtmux.org/en/julia/latest/workspace/reference/libtmuxworkspace-plan/

```
plan(workspace::LibTmuxWorkspace.ExpandedWorkspace)
```

## Methods

Describe ordered effects without starting processes, connecting to tmux, probing paths or executing hooks. Window creation includes its first pane. Explicit window indices are distinct from the 1-based positions used in plan targets. The plan records script text and its base directory; it does not shell-evaluate `before_script` or promise rollback of future shell effects.

```julia
plan(workspace::ExpandedWorkspace) -> WorkspacePlan
```

## Parameters

- `workspace` (`LibTmuxWorkspace.ExpandedWorkspace`)