Skip to content

Latest commit

 

History

History
36 lines (28 loc) · 1.58 KB

README.md

File metadata and controls

36 lines (28 loc) · 1.58 KB

Pairest

Installation

To install Pairest, do

    gem install pairest

Pairest usage looks like this:

    $ pairest hp bl

Setup

Please create a ~/.pairest.yml with the following format (if you don't one will be created for you):

jd:
  name: John Doe
  email: [email protected]
  key_name: john.doe
eu:
  name: Example User
  email: [email protected]
  key_name: example.user

Pairest will also create an ~/.ssh/config if you do not have one already. You'll need to edit it before you can use pairest. If you already have an ~/.ssh/config, then you'll have to add an entry for whichever git origin you're accessing via SSH and tell it to point at ~/.ssh/current_key.

Pairest will manage a link under ~/.ssh/, so the key names in ./pairest.yml refer to the name of key files in the ~/.ssh/ directory. If you don't know how to create an SSH key, google the documentation for ssh-keygen or do man ssh-keygen. Pairest will create a default ssh config file that points at this link for an example host. You'll have to change it to be the host you actually care about. You can read up on the ssh config file format here or by doing man ssh_config.

Caveats

Keep in mind that the Git commands it runs are not with the --global flag. This was on purpose, but if it's useful to configure this behavior, it can be made configurable in the future.

Issues

Please feel welcome to open issues and pull requests on this repository if you have any issues or feature requests. Thanks!