teamocil/README.mkd

69 lines
2.1 KiB
Markdown
Raw Normal View History

2011-08-28 13:22:36 +00:00
# Teamocil
2011-02-05 18:11:38 +00:00
2011-07-19 12:42:56 +00:00
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.
2011-02-05 18:11:38 +00:00
2011-07-19 12:44:30 +00:00
## Usage
2011-02-05 18:11:38 +00:00
2011-02-05 18:16:55 +00:00
$ gem install teamocil
2011-02-05 18:14:40 +00:00
$ mkdir ~/.teamocil
$ touch ~/.teamocil/sample.yml
$ tmux
2011-02-05 18:11:38 +00:00
$ teamocil sample
2011-07-19 12:44:30 +00:00
## Options
2011-07-19 12:42:56 +00:00
* `--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.
2011-07-20 17:17:10 +00:00
* `--edit` opens the layout file (whether or not `--layout` is used) with `$EDITOR`.
2011-07-19 12:42:56 +00:00
2011-07-19 12:44:30 +00:00
## Layout example
2011-02-05 18:11:38 +00:00
# ~/.teamocil/sample.yml
2011-02-18 03:12:39 +00:00
session:
name: sample-session
windows:
- name: sample-window
root: ~/Code/sample/www
2011-02-18 03:12:39 +00:00
splits:
- cmd:
- ls -la
- git status
- cmd: rails server --port 3000
2011-02-18 03:12:39 +00:00
width: 50
- cmd: memcached -p 11211 -vv
height: 25
target: bottom-right
2011-02-05 18:11:38 +00:00
2011-07-19 12:42:56 +00:00
Running `$ teamocil sample` will rename the session to `sample-session` and create a new window named `sample-window` with a layout like this:
2011-02-05 18:11:38 +00:00
.------------------.------------------.
| (0) | (1) |
| | |
| | |
| | |
| | |
| | |
| |------------------|
| | (2) |
| | |
'------------------'------------------'
2011-07-19 12:43:44 +00:00
2011-08-28 13:19:35 +00:00
## Extras
### Zsh autocompletion
To get autocompletion when typing `teamocil <Tab>` in a zsh session, add this line to your `~/.zshrc` file:
compctl -g '~/.teamocil/*(:t:r)' teamocil
2011-07-19 12:44:30 +00:00
## Contributors
2011-07-19 12:43:44 +00:00
2011-08-28 13:20:49 +00:00
Feel free to contribute and submit pull requests!
2011-07-19 12:43:44 +00:00
* Samuel Garneau ([garno](https://github.com/garno))
2011-08-28 19:43:40 +00:00
## License
Teamocil is © 2011 Rémi Prévost and may be freely distributed under the [LITL license](http://litl.info/). See the `LICENSE` file.