$ ssh-remote

Automagically switch on the SSH remote url in a Git repository.

Sometimes it happens to have repositories closed with http(s) protocol. I have 2FA enabled on GitHub and my password is complicated anyway. Since I have SSH configured on my machines, I want to use it, I never knew the SSH url format.

So, I just do now:

$ ssh-remote

...and let the magic happen.

:cloud: Installation

You can install the package globally and use it as command line tool:

# Using npm
npm install --global ssh-remote

# Using yarn
yarn global add ssh-remote

Then, run ssh-remote --help and see what the CLI tool can do.

$ ssh-remote --help
Usage: ssh-remote [options]

Options:
  -p, --path <path>  Set another path.
  -h, --help         Displays this help.
  -v, --version      Displays version information.

Examples:
  ssh-remote # Changes the remote url to ssh in the current git repo
  ssh-remote -p path/to/another/repository

Documentation can be found at https://github.com/IonicaBizau/ssh-remote

:clipboard: Example

Here is an example how to use this package as library. To install it locally, as library, you can use npm install ssh-remote (or yarn add ssh-remote):

var SshRemote = require("ssh-remote");

// Use the ssh remote url in the current directory
SshRemote();

// Use the ssh remote url in another directory
SshRemote("path/to/some/dir");

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

For full API reference, see the DOCUMENTATION.md file.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:scroll: License

MIT © Ionică Bizău