Project

iterm_cli

0.0
Low commit activity in last 3 years
A long-lived project that still receives updates
iterm_clilabocho/iterm_cliHomepageDocumentationSource CodeBug TrackerWiki
Command line interface for iTerm2
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Popularity
Downloads
5,438
Stars
0
Forks
0
Watchers
1
 Releases
Current version
1.1.0
Total releases
3
First release
2017-04-28
Latest release
2026-09-25
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
0
Merged Pull Requests
0
Pull Request Acceptance Rate
0%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2018-01-31
Reverse Dependencies
0

 Dependencies

Development

rake
~> 10.0
rspec
>= 0
rubocop
>= 0
bundler
~> 4.0

Runtime

thor-zsh_completion
~> 0.1.1
thor
~> 1.5.0
 Project Readme

iTerm CLI

Command line interface for iTerm 2. Inspired by tmux and tmuxinator.

Requirements

Ruby 1.9.3 or later. iTerm2 Build 3.0.4 or later.

Installation

$ gem install iterm_cli

Or

$ git clone https://github.com/labocho/iterm_cli
$ cd iterm_cli
$ rake install

Usage

# If no arguments, show help.
$ iterm

new-session

# `iterm new-session` creates new session (tab)
$ iterm new-session

# with command, execute in created session
$ iterm new-session top
$ iterm new-session sleep 3
$ iterm new-session 'sleep 3'

# session name will be command name.
# --name (or -n) option names session explicitly.
$ iterm new-session --name=server rails server

send-keys

# `iterm send-keys` types keys to target session
$ iterm new-session -n foo zsh
$ iterm send-keys --target foo exit

# C-* indicates control key
$ iterm new-session top
$ iterm send-keys --target top C-c # send control-c

sessions

iterm sessions manages multiple sessions using a .iterm-sessions or Procfile configuration file in the current directory. The configuration file should be written in YAML (http://yaml.org/).

# keys are session names
console:
  # `command` passes `iterm new-session` when started
  command: rails console
  # `kill` passes `iterm send-keys` when stopped
  kill: exit
# shorthand style (killed by control-c)
server: rails server

iterm sessions have subcommands below.

# `iterm sessions ls` lists sessions defined
# marked for session exists.
$ iterm sessions ls
  console
* server


# `iterm sessions start` starts all sessions.
# If session exists, do nothing for the session.
$ iterm sessions start

# If pass session name, start the session (if not exists).
$ iterm sessions start server


# `iterm sessions kill` stops all sessions.
# If session does not exist, do nothing.
$ iterm sessions kill

# If pass session name, kill the session (if exists).
$ iterm sessions kill server

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/labocho/iterm_cli.

License

The gem is available as open source under the terms of the MIT License.