# LibTmux::Workspace#plan

**Workspace Manager concept example** A working example of the core library. It can change without notice.

- **Module:** LibTmux
- **Package:** libtmux-workspace
- **Language:** Ruby
- **Kind:** method
- **Source:** https://github.com/libtmux/libtmux-ruby/blob/d8ce4bbee0ca7748a81929f81f7d8d07f8c51267/gems/libtmux-workspace/lib/libtmux/workspace.rb#L70
- **Page:** https://libtmux.org/en/ruby/v0.1.0.alpha.3/workspace/reference/libtmux-workspace-plan-1c5c/

```
def plan: (
  ?snapshot: ::LibTmux::Snapshot?
) -> ::LibTmux::Workspace::Plan
```

Behavior: Workspace parsing.

Behavior contract: Workspace parsing.

## Examples

Load the example workspace file, plan it against a snapshot, and apply the plan to an empty server. Use Ruby 4.0.7, Bundler, Git and tmux 3.3a or newer on Unix, with /bin/cat and /bin/sh available. In an empty directory, fetch the documented library revision:

```console
$ git clone https://github.com/libtmux/libtmux-ruby.git libtmux-source && \
  git -C libtmux-source checkout d8ce4bbee0ca7748a81929f81f7d8d07f8c51267
```

Save this dependency file as Gemfile:

```ruby
source "https://rubygems.org"

gem "libtmux-workspace", path: "libtmux-source/gems/libtmux-workspace"
```

Save this complete program as workspace_apply.rb. Its Server.start block owns a private tmux server and stops it on exit, including after an error.

[Source example](https://github.com/libtmux/libtmux-ruby/blob/d8ce4bbee0ca7748a81929f81f7d8d07f8c51267/examples/api/workspace_apply.rb).

```ruby
# frozen_string_literal: true

begin
  # docs:begin main
  require "libtmux"
  require "libtmux/workspace"

  LibTmux::Server.start do |server|
    workspace = LibTmux::Workspace.load(File.expand_path("../workspace.yaml", __dir__))
    plan = workspace.plan(snapshot: server.snapshot)
    puts "planned steps: #{plan.steps.length}"
    result = plan.apply(server: server)
    puts "applied: #{result.success?}"
    puts "sessions: #{server.list_sessions.map { |session| session.snapshot.name }.join(', ')}"
  end
  # docs:end main
rescue StandardError => error
  warn "#{error.class}: #{error.message}"
  exit 1
end
```

Install the runtime dependencies and run the saved program. An operation or cleanup error makes it exit unsuccessfully:

```console
$ bundle config set --local path vendor/bundle && \
  bundle install --jobs 2 && \
  bundle exec ruby workspace_apply.rb
```

Expected output:

```text
planned steps: 11
applied: true
sessions: work
```

## Parameters

- `snapshot` (`::LibTmux::Snapshot?`)