https://github.com/krisleech/tmuxinator
Generate tmux configurations for your projects
https://github.com/krisleech/tmuxinator
Last synced: about 1 year ago
JSON representation
Generate tmux configurations for your projects
- Host: GitHub
- URL: https://github.com/krisleech/tmuxinator
- Owner: krisleech
- License: mit
- Created: 2012-12-30T22:48:52.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2013-08-12T10:21:45.000Z (almost 13 years ago)
- Last Synced: 2025-04-13T03:06:53.584Z (about 1 year ago)
- Language: Ruby
- Homepage: http://teamcoding.com
- Size: 71.3 KB
- Stars: 11
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Tmuxification
Generator for tmux configurations. The default template starts a tmux session
with two windows in your project root, vim is started in the first window.
## Tested on
* Ruby 1.9
* zsh & fish shells
## Installation
$ gem install tmuxification
## Usage
### Create a new tmux project
$ cd ~/code/my_project
$ tmuxification create
You will need to reload your shell config file. The easiest way is to replace
the current process with a new instance of your shell, e.g `exec zsh`.
### Start the project (from any directory)
$ start_my_project
Note: The above will also autocomplete.
### List all your projects
$ tmuxification list
### Delete a project
$ cd ~/code/my_project
$ tmuxification destroy
### Templates
You can create your own templates, just drop them in `~/.tmuxinator` with a
filename such as `basic.tmux.erb` and specify your template as such:
$ tmuxification create --template-name=basic
You can also edit the `default.{zsh,fish}.tmux.erb` templates which are used when
no `template-name` is specified.
The default template is chosen based on the default shell.
### Project name
By default the tmux project is named after the root directory of the project, you
can specify a different project name as such:
$ cd ~/code/my_project
$ tmuxification create --project-name=foobar
$ start_foobar
## Warning
Every project created will append a line per project to `.projects`, `.zshrc` or
`config.fish` file. The `.projects` is used if it exists otherwise the rc file
for the current shell is used.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request