Server.run_group
One nontransactional tmux command group, with literal arguments per command.
Source and package
- Qualified name
-
LibTmux:: Server# run _group - Module
- LibTmux
- Declared in
Server- Package
- libtmux
- Source
- gems/libtmux/lib/libtmux/group.rb
-
Description#
Behavior contract: Command groups.
Examples#
Submit an ordered group whose second command fails. The group reports unknown per-step outcomes, keeps the first command's effect and never runs the third. 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", "0.1.1"Save this complete program as
run_group.rb. ItsServer.start()block owns a private tmux server and stops it on exit, including after an error. View source# frozen_string_literal: truebegin# docs:begin mainrequire "libtmux"LibTmux::Server.start do |server|server.new_session(name: "work", command: ["/bin/cat"])group = server.run_group([["set-option", "-g", "@before", "kept"],["select-pane", "-t", "%4294967294"],["set-option", "-g", "@after", "never run"]])puts "success: #{group.success?}"puts "steps: #{group.steps.map { |step| step.fetch(:outcome) }.join(', ')}"puts "@before: #{server.options(scope: :session).get('@before').as(:string)}"end# 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 run_group.rbExpected output:
success: falsesteps: unknown, unknown, unknown@before: kept