# LibTmux::Workspace::Plan#steps

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

- **Module:** LibTmux::Workspace
- **Package:** libtmux-workspace
- **Language:** Ruby
- **Kind:** method
- **Source:** https://github.com/libtmux/libtmux-ruby/blob/da7b6191b9439e3c84fa1c9eeaa9168263ee7af4/gems/libtmux-workspace/lib/libtmux/workspace/plan.rb#L11
- **Page:** https://libtmux.org/en/ruby/v0.1.1/workspace/reference/libtmux-workspace-plan-steps/

```
def steps: () -> ::Array[::LibTmux::Workspace::Plan::Step]
```

Returns the value of attribute steps.

Behavior contract: Workspace plans.

## Examples

Load the example workspace file, plan it against a snapshot, and apply the plan to an empty server. Use Ruby 3.3 or newer with Bundler, and tmux 3.3a or newer, on Unix with `/bin/cat` and `/bin/sh` available. In an empty directory, save this `Gemfile`:

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

gem "libtmux-workspace", "0.1.1"
```

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/da7b6191b9439e3c84fa1c9eeaa9168263ee7af4/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 gem and run the program. An operation or cleanup error makes it exit unsuccessfully:

```console
$ bundle install && \
  bundle exec ruby workspace_apply.rb
```

Expected output:

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