`LibTmux::Workspace::Plan#apply`

def apply: ( server: ::LibTmux::Server, ?timeout: ::Numeric, ?cancel: untyped, ?compensate: bool ) -> ::LibTmux::Workspace::ApplyResult method libtmux-workspace [source] ¶

Behavior: Workspace apply.

Description#

Behavior contract: Workspace apply.

Examples#

Write a workspace file, load it, 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:

source "https://rubygems.org"

gem "libtmux-workspace", "0.1.2"

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. View source

# frozen_string_literal: true

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

  document = <<~'YAML'
    session_name: work
    environment:
      PROJECT_MODE: development
    windows:
      - window_name: editor
        window_index: 1
        layout: tiled
        panes:
          - shell_command: printf 'editor ready\n'
          - {}
  YAML

  Dir.mktmpdir("workspace-") do |directory|
    path = File.join(directory, "workspace.yaml")
    File.write(path, document)
    LibTmux::Server.start do |server|
      workspace = LibTmux::Workspace.load(path)
      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
  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:

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

Expected output:

planned steps: 11
applied: true
sessions: work

Parameters

server (::LibTmux::Server) #
timeout (::Numeric) #
cancel (untyped) #
compensate (bool) #

Guides#

Pages that discuss apply.

Workspace guide

In other ports#

Build a session from a workspace description

Equivalents of Build a session from a workspace description in other languages
Language	Equivalent
Python	`tmuxp.workspace.builder.ClassicWorkspaceBuilder.build`
PowerShell	`LibTmux.Workspace\Invoke-TmuxWorkspace` Applies the exact reviewed `-Plan` after PowerShell confirmation. `-WhatIf` previews without applying it; application is detached.
Julia	`LibTmuxWorkspace.apply` Applies a prepared `WorkspacePlan` on an explicit `Server`, detached and under one deadline. Existing session names fail unless reuse is explicit.
Haskell	No public Haskell equivalent is implemented; the current modules expose scalar values and version parsing.
Common Lisp	`libtmux.workspace:apply-workspace`
TypeScript	`builder.applyWorkspace`
Rust	`src.WorkspaceBuilder.build`
Go	`workspace.Build`
Java	`io.github.libtmux.workspace.WorkspaceBuilder.build`
C#	`LibTmux.Workspace.WorkspaceBuilder.BuildAsync`
C++	`libtmux::workspace::build`
Swift	`WorkspaceBuilder.build(_:on:)`
OCaml	`Libtmux_unix.Workspace.await` Apply a validated Plan through submit, then await its retained execution receipt. Inspect preserves partial and late outcomes.
Perl	`LibTmux::Workspace::load` Loads through installed public core APIs; existing-target policy and known owned rollback effects are explicit.

No equivalent is recorded in Lua, Erlang, Elixir, Clojure, Kotlin, Scala or F#.

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

`LibTmux::Workspace::Plan#apply`

Description#

Examples#

Guides#

In other ports#