- - - - - Classes: CLI, Layout - - -
- -'0.1.9'
-This class handles interaction with the tmux utility.
Print an error message and exit the utility.
Initialize a new run of tmux.
Parse the command line options.
- - - (CLI) initialize(argv, env) - - - -
Initialize a new run of tmux
- - - -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30- |
-
- # File 'lib/teamocil/cli.rb', line 12 - -def initialize(argv, env) # {{{ - bail "You must be in a tmux session to use teamocil" unless env["TMUX"] - - - if .include?(:layout) - file = [:layout] - else - file = ::File.join("#{env["HOME"]}/.teamocil", "#{argv[0]}.yml") - end - - if [:edit] - ::FileUtils.touch file unless File.exists?(file) - system("$EDITOR \"#{file}\"") - else - bail "There is no file \"#{file}\"" unless File.exists?(file) - layout = Teamocil::Layout.new(file, ) - layout.to_tmux - end -end -- |
-
- - - (Object) bail(msg) - - - -
Print an error message and exit the utility
- -
- - - -59 -60 -61 -62- |
-
- # File 'lib/teamocil/cli.rb', line 59 - -def bail(msg) # {{{ - puts "[teamocil] #{msg}" - exit 1 -end -- |
-
- - - (Object) parse_options! - - - -
Parse the command line options
- -
- - - -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54- |
-
- # File 'lib/teamocil/cli.rb', line 33 - -def - = {} - opts = ::OptionParser.new do |opts| - opts. = "Usage: teamocil [options] <layout> - - Options: - " - opts.on("--here", "Set up the first window in the current window") do - [:here] = true - end - - opts.on("--edit", "Edit the YAML layout file instead of using it") do - [:edit] = true - end - - opts.on("--layout [LAYOUT]", "Use a specific layout file, instead of ~/.teamocil/<layout>.yml") do |layout| - [:layout] = layout - end - - end - opts.parse! -end -- |
-
This class act as a wrapper around a tmux YAML layout file.
- -Execute each command in the shell.
Generate tmux commands based on the data found in the layout file.
Initialize a new layout from a file.
Generate commands and sends them to tmux.
- - - (Layout) initialize(file, options) - - - -
Initialize a new layout from a file
- -
- - - -9 -10 -11 -12- |
-
- # File 'lib/teamocil/layout.rb', line 9 - -def initialize(file, ) # {{{ - @layout = YAML.load_file(file) - = -end -- |
-
- - - (Object) execute_commands(commands) - - - -
Execute each command in the shell
- -
- - - -73 -74 -75- |
-
- # File 'lib/teamocil/layout.rb', line 73 - -def execute_commands(commands) # {{{ - `#{commands.join("; ")}` -end -- |
-
- - - (Object) generate_commands - - - -
Generate tmux commands based on the data found in the layout file
- -
- - - -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68- |
-
- # File 'lib/teamocil/layout.rb', line 21 - -def generate_commands - output = [] - - if @layout["session"].nil? - windows = @layout["windows"] - else - output << "tmux rename-session #{@layout["session"]["name"]}" if @layout["session"]["name"] - windows = @layout["session"]["windows"] - end - - windows.each_with_index do |window, window_index| - - if .include?(:here) and window_index == 0 - output << "tmux rename-window \"#{window["name"]}\"" - else - output << "tmux new-window -n \"#{window["name"]}\"" - end - - window["splits"].each_with_index do |split, index| - unless index == 0 - if split.include?("width") - cmd = "tmux split-window -h -p #{split["width"]}" - elsif split.include?("height") - cmd = "tmux split-window -p #{split["height"]}" - else - cmd = "tmux split-window" - end - cmd << " -t #{split["target"]}" if split.include?("target") - output << cmd - end - - # Support single command splits, but treat it as an array nevertheless - split["cmd"] = [split["cmd"]] unless split["cmd"].is_a? Array - - # If a `root` key exist, start each split in this directory - split["cmd"] = ["cd \"#{window["root"]}\""] + split["cmd"] if window.include?("root") - - # Execute each split command - split["cmd"].each do |command| - output << "tmux send-keys -t #{index} \"#{command}\"" - output << "tmux send-keys -t #{index} Enter" - end - end - - end - - output << "tmux select-pane -t 0" -end -- |
-
- - - (Object) to_tmux - - - -
Generate commands and sends them to tmux
- -
- - - -15 -16 -17 -18- |
-
- # File 'lib/teamocil/layout.rb', line 15 - -def to_tmux - commands = generate_commands - execute_commands(commands) -end -- |
-
Teamocil is a tool used to automatically create sessions, windows and splits in tmux with Ruby and YAML. Like tmuxinator, but with splits, not just windows.
$ gem install teamocil -$ mkdir ~/.teamocil -$ touch ~/.teamocil/sample.yml -$ tmux -$ teamocil sample -- -
--here opens the session in the current window, it doesn’t create an empty first window.--layout takes a custom file path to a YAML layout file.--edit opens the layout file (whether or not --layout is used) with $EDITOR.# ~/.teamocil/sample.yml - -session: - name: sample-session - windows: - - name: sample-window - root: ~/Code/sample/www - splits: - - cmd: - - ls -la - - git status - - cmd: rails server --port 3000 - width: 50 - - cmd: memcached -p 11211 -vv - height: 25 - target: bottom-right -- -
Running $ teamocil sample will rename the session to sample-session and create a new window named sample-window with a layout like this:
.------------------.------------------. -| (0) | (1) | -| | | -| | | -| | | -| | | -| | | -| |------------------| -| | (2) | -| | | -'------------------'------------------' -- -
To get autocompletion when typing teamocil <Tab> in a zsh session, add this line to your ~/.zshrc file:
compctl -g '~/.teamocil/*(:t:r)' teamocil -- -
Feel free to contribute and submit pull requests!
- - - -Teamocil is © 2011 Rémi Prévost and may be freely distributed under the LITL license. See the LICENSE file.
Teamocil is a tool used to automatically create sessions, windows and splits in tmux with Ruby and YAML. Like tmuxinator, but with splits, not just windows.
$ gem install teamocil -$ mkdir ~/.teamocil -$ touch ~/.teamocil/sample.yml -$ tmux -$ teamocil sample -- -
--here opens the session in the current window, it doesn’t create an empty first window.--layout takes a custom file path to a YAML layout file.--edit opens the layout file (whether or not --layout is used) with $EDITOR.# ~/.teamocil/sample.yml - -session: - name: sample-session - windows: - - name: sample-window - root: ~/Code/sample/www - splits: - - cmd: - - ls -la - - git status - - cmd: rails server --port 3000 - width: 50 - - cmd: memcached -p 11211 -vv - height: 25 - target: bottom-right -- -
Running $ teamocil sample will rename the session to sample-session and create a new window named sample-window with a layout like this:
.------------------.------------------. -| (0) | (1) | -| | | -| | | -| | | -| | | -| | | -| |------------------| -| | (2) | -| | | -'------------------'------------------' -- -
To get autocompletion when typing teamocil <Tab> in a zsh session, add this line to your ~/.zshrc file:
compctl -g '~/.teamocil/*(:t:r)' teamocil -- -
Feel free to contribute and submit pull requests!
- - - -Teamocil is © 2011 Rémi Prévost and may be freely distributed under the LITL license. See the LICENSE file.
| t |
- - - Modules: Teamocil - - - - -
- - - - - - - -