LibTmux::Workspace.load
- def self.load: ( ::String, ?format: :yaml | :json | nil, ?expand
_environment : bool, ?environment: ::Hash[::String, ::String], **::Integer ) -> ::LibTmux:: Workspace -
Behavior: Workspace parsing.
Description#
Behavior contract: Workspace parsing.
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/catand/bin/shavailable. In an empty directory, save thisGemfile:source "https://rubygems.org"gem "libtmux-workspace", "0.1.2"Save this complete program as
workspace_apply.rb. ItsServer.startblock owns a private tmux server and stops it on exit, including after an error. View source# frozen_string_literal: truebegin# docs:begin mainrequire "libtmux"require "libtmux/workspace"require "tmpdir"document = <<~'YAML'session_name: workenvironment:PROJECT_MODE: developmentwindows:- window_name: editorwindow_index: 1layout: tiledpanes:- shell_command: printf 'editor ready\n'- {}YAMLDir.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(', ')}"endend# docs:end mainrescue StandardError => errorwarn "#{error.class}: #{error.message}"exit 1endInstall the gem and run the program. An operation or cleanup error makes it exit unsuccessfully:
Terminal window $ bundle install && \bundle exec ruby workspace_apply.rbExpected output:
planned steps: 11applied: truesessions: work- Parameters
-
-
expand_environment(bool) # -
environment(::Hash[::String, ::String]) #
Guides#
Pages that discuss load.
- Workspace