teamocil/README.mkd
2011-07-19 20:47:16 -04:00

53 lines
1.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

## Introduction
Teamocil is a tool used to automatically create sessions, windows and splits in `tmux` with Ruby and YAML. Like [tmuxinator](https://github.com/aziz/tmuxinator), but with splits, not just windows.
## Usage
$ gem install teamocil
$ mkdir ~/.teamocil
$ touch ~/.teamocil/sample.yml
$ tmux
$ teamocil sample
## Options
* `--here` opens the session from the current window, it doesnt create an empty first window.
* `--layout` takes a custom file path to a YAML layout file.
## Layout example
# ~/.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
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) |
| | |
'------------------'------------------'
## Contributors
* Samuel Garneau ([garno](https://github.com/garno))