https://github.com/chipx86/itermlauncher

Console-based iTerm2 profile launcher
https://github.com/chipx86/itermlauncher

Last synced: about 1 month ago
JSON representation

Console-based iTerm2 profile launcher

• Host: GitHub
• URL: https://github.com/chipx86/itermlauncher
• Owner: chipx86
• License: mit
• Created: 2015-07-07T03:59:37.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2016-09-21T22:00:14.000Z (over 8 years ago)
• Last Synced: 2024-12-19T19:34:35.419Z (about 2 months ago)
• Language: JavaScript
• Size: 6.84 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
iTermLauncher for iTerm2

========================

iTermLauncher is a handy console-based menu for quickly launching new

terminals within the same window using iTerm2.

This is intended for use with the iTerm2 Hotkey window, for launching

additional terminals within that window. I personally use it to keep all my

development servers or SSH sessions in reach, all within the hotkey window.

Once launched, the menu will remain running until you hit Control-C or Q.

It will scan all the profiles you have configured (optionally filtering by

tags), and let you choose one to launch within the window.

Installing iTermLauncher

------------------------

Installation is simple. Just make sure you have node.js installed, and type:

    $ sudo npm -g install itermlauncher

To run it:

    $ itermlauncher

Configuring iTermLauncher

-------------------------

Configuration is completely optional. iTermLauncher will find all your

profiles and do the right thing.

There are a few configuration options, though. You can set the foreground/background colors, the width of the menu, an exported iTerm2 plist file, and the

list of tags required for a profile to appear.

If you want to change things, create a JSON file in

`~/.config/itermlauncher/config.json`. This can look something like:

    {

        "bg": "black",

        "fg": "yellow",

        "menuWidth": 50,

		"itermVersion": 2,

        "requiredTags": [

            "Dev Servers"

        ],

        "plistFilename": "/path/to/com.googlecode.iterm2.plist"

    }

The one you most likely want to set is `requiredTags`. Any profile appearing

in the menu must have all of the listed tags.

If you're running the iTerm 3 betas, you'll want to set `itermVersion` to 3.

Otherwise, it will use the old AppleScript code. Once iTerm 3 is released,

it will be the default, though iTerm 2 compatibility will remain by

setting `itermVersion` to 2.

You can also specify a custom configuration file as an argument when running

`itermlauncher`:

    $ itermlauncher my-config.json

Configuring iTerm2

------------------

You'll want to make this easy and basically automatic. I suggest hooking this

up to the hotkey window. Just follow these steps:

1. Go into the iTerm2 profile editor and select the profile for your

   Hotkey window (or create it if it doesn't exist).

2. In the General tab for the profile, set Command to: `itermlauncher`

3. In the Keys settings, under Hotkey, make sure both checkboxes are checked,

   set your desired hotkey, and make sure it's mapped to the profile you

   just configured.

4. Press the hotkey. Tada!

License

-------

iTermLauncher is MIT-licensed.

Copyright (c) 2015  Christian Hammond

Permission is hereby granted, free of charge, to any person obtaining a copy of

this software and associated documentation files (the "Software"), to deal in

the Software without restriction, including without limitation the rights to

use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies

of the Software, and to permit persons to whom the Software is furnished to do

so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.