hss
=========

[![Gem Version](https://badge.fury.io/rb/hss.png)](http://badge.fury.io/rb/hss)
[![Stories in Ready](https://badge.waffle.io/akerl/hss.png)](http://waffle.io/akerl/hss)

SSH helper that uses regex and fancy expansion to dynamically manage SSH shortcuts

## Usage

1. Install as per the Installation section below
2. Set your configuration yaml up as desired (See Configuration below)
3. Run `hss help` for a list of available commands
4. Run `hss $command` to do that thing

## Installation

    gem install hss
    ln -s /path/to/your/config.yml ~/.hss.yml

## Configuration

1. You can put your configuration in ~/.hss.yml or another file specified by the "HSS\_CONFIG" environment variable.
2. The only required configuration section is "patterns", which contains an array of hashes with the following attributes:
  * note: Name of this pattern ("my servers")
  * example: Shows how this is used ("jimbo -> root@jimbo.example.org")
  * short: Regex for shortcut ("^(jimbo|bob|chuck)$")
    * Use matching to collect things you want to use in the expanded form
  * long: Expanded form of this shortcut ("root@#$1.example.org")
    * This will be evaluated using Ruby's string interpolation, so you can use "#{var}", "#$1", "#{function()}", etc.
3. Other helpers are available for use in long forms
  * expand(x): Uses the "expansions" section of the config. Format for this section is a hash of lists, as such
    expansions:
        expanded_form:
            - short_form1
            - short_form2
            - shrtfrm3
  * shortcut(x): Uses the "shortcuts" section of the config. Format for this section is a hash of strings, as such
    shortcuts:
        short1: expand to this
        other_short: 'expand to something else!'
  * command(x): Runs the given string as a command and uses the output for the expanded form
  * default(x, y): If x is not nil, uses x. If it's nil, use y

## Debugging

If you want hss to print the command it would have run rather than executing it, you just need to set the HSS\_DEBUG environment variable to something:

    export HSS_DEBUG=foo
    hss bar # will print rather than exec

## License

hss is released under the MIT License. See the bundled LICENSE file for details.