iTermocil allows you to setup pre-configured layouts of windows and panes in iTerm2, having each open in a specified directory and execute specified commands. You do this by writing YAML files.
iTermocil is compatible with teamocil, allowing anyone with teamocil files to execute those files natively in iTerm2, without needing tmux or any other dependency. Note that iTermocil does add some directives that will fail in teamocil if used, and should only be used if you don't also use teamocil. These are marked.
# Install `itermocil` via Homebrew
$ brew update
$ brew install TomAnthony/brews/itermocil
# Create your layout directory
$ mkdir ~/.teamocil
# Edit ~/.teamocil/sample.yml (look for sample layouts in this very `README.md`)
# There are also a variety of example files in 'test_layouts' directory in this repo
$ itermocil --edit sample
# Run your newly-created sample layout
$ itermocil sample$ itermocil [options] <layout-name>iTermocil is compatible with all of teamocil's flags, and they all work in the same way.
| Option | Description |
|---|---|
--list |
Lists all available layouts in ~/.teamocil |
| Option | Description |
|---|---|
--layout |
Takes a custom file path to a YAML layout file instead of [layout-name] |
--here |
Uses the current window as the layout’s first window |
--edit |
Edit the layout file in either $EDITOR or your preferred GUI editor |
--show |
Shows the layout content instead of executing it |
| Key | Description |
|---|---|
name |
This is currently ignored in iTermocil as there is no tmux session. |
windows |
An Array of windows |
| Key | Description |
|---|---|
name |
All iTerm panes in this window will be given this name. |
root |
The path where all panes in the window will be started |
layout |
The layout format that iTermocil will use (see below) |
panes |
An Array of panes |
focus |
This is currently unsupported in iTermocil |
A pane can either be a String or a Hash. If it’s a String, Teamocil will treat it as a single-command pane.
| Key | Description |
|---|---|
commands |
An Array of commands that will be ran when the pane is created |
focus |
If set to true, the pane will be selected after the layout has been executed |
See some example of various layouts below, or see Layouts for more information on the available layouts. There is also a variety of example layout files in this repo.
windows:
- name: sample-two-panes
root: ~/Code/sample/www
layout: even-horizontal
panes:
- git status
- rails server.------------------.------------------.
| (0) | (1) |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
'------------------'------------------'
windows:
- name: sample-three-panes
root: ~/Code/sample/www
layout: main-vertical
panes:
- vim
- commands:
- git pull
- git status
name: 'git'
- rails serverNote: the 'name' directive in 'commands' in an iTermocil specific addition, which will cause teamocil to fail if it tries to parse the file.
.------------------.------------------.
| (0) | (1) |
| | |
| | |
| | |
| |------------------|
| | (2) |
| | |
| | |
| | |
'------------------'------------------'
windows:
- name: sample-three-panes
root: ~/Code/sample/www
layout: main-vertical-flipped
panes:
- commands:
- git pull
- git status
- rails server
- vim.------------------.------------------.
| (0) | (2) |
| | |
| | |
| | |
|------------------| |
| (1) | |
| | |
| | |
| | |
'------------------'------------------'
windows:
- name: sample-four-panes
root: ~/Code/sample/www
layout: tiled
panes:
- vim
- foreman start web
- git status
- foreman start worker.------------------.------------------.
| (0) | (1) |
| | |
| | |
| | |
|------------------|------------------|
| (2) | (3) |
| | |
| | |
| | |
'------------------'------------------'
windows:
- name: sample-two-panes
root: ~/Code/sample/www
layout: even-horizontal
panes:
- rails server
- commands:
- rails console
focus: true.------------------.------------------.
| (0) | (1) <focus here> |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
| | |
'------------------'------------------'
In the Layouts file you can see these additional layouts:
- 3_columns - 3 columns with as many rows as needed
- double-main-vertical - 2 left full height columns, and a third multi-row column
- double-main-horizontal - 2 rows, where bottom row is 2 full width columns, and top row is multi-column
Teamocil allows supplying a name for a tmux session which has no purpose in iTerm, and so that option is ignored.
In tmux it is 'windows' that have names, whereas in iTerm each pane in a window can have a name. iTermocil will name all the child panes of a window by the window name given in a termocil file.
iTermocil works for iTerm 2+, but the script support is better in iTerm 2.9 beta so things run a bit faster/cleaner with iTerm 2.9+. If using beta builds you should grab the latest nightly, as the 2.9.20150626 'recommended beta' build does not have the required script hooks for iTermocil to work (and I have no plans to kludge something just for an incomplete beta that will never be released).
To get autocompletion when typing itermocil <Tab> in a zsh session, add this line to your ~/.zshrc file:
compctl -g '~/.teamocil/*(:t:r)' itermocilTo get autocompletion when typing itermocil <Tab> in a bash session, add this line to your ~/.bashrc file:
complete -W "$(itermocil --list)" itermocilTo get autocompletion when typing itermocil <Tab> in a fish session, add this line to your ~/.config/fish/config.fish file:
complete -c itermocil -a "(itermocil --list)"I'd love any ideas/feedback/thoughts, please open an issue or create a fork and send a pull request, like these wonderful people:
A huge thanks to Rémi Prévost who authored teamocil, which inspired iTermocil. It is a fantastic tool, and I'm hoping that iTermocil helps more people discover teamocil.
- add tmuxinator file support
- add support for bespoke file format to support things like iTerm badges and tab colours
- possibly add a flag for using windows instead of tabs for new 'windows'
- pane 'focus' is supported, but window 'focus' is not yet - I'm not sure how to focus on a certain window still
- with the --edit flag, if no $EDITOR is set and a new layout name is given, then an empty file is created to be opened in a GUI editor. Is there a better way to handle this? Maybe clean up blank files whenever itermocil is launched?
iTermocil is © 2015 Tom Anthony and may be freely distributed under the MIT license. See the LICENSE file for more information.