README.md

is-ssh

Check if an input value is a ssh url or not.

☁️ Installation

# Using npm
npm install --save is-ssh

# Using yarn
yarn add is-ssh

📋 Example

// Dependencies
const isSsh = require("is-ssh");

// Secure Shell Transport Protocol (SSH)
console.log(isSsh("ssh://[email protected]:port/path/to/repo.git/"));
// true

console.log(isSsh("ssh://[email protected]/path/to/repo.git/"));
// true

console.log(isSsh("ssh://host.xz:port/path/to/repo.git/"));
// true

console.log(isSsh("ssh://host.xz/path/to/repo.git/"));
// true

console.log(isSsh("ssh://[email protected]/path/to/repo.git/"));
// true

console.log(isSsh("ssh://host.xz/path/to/repo.git/"));
// true

console.log(isSsh("ssh://[email protected]/~user/path/to/repo.git/"));
// true

console.log(isSsh("ssh://host.xz/~user/path/to/repo.git/"));
// true

console.log(isSsh("ssh://[email protected]/~/path/to/repo.git"));
// true

console.log(isSsh("ssh://host.xz/~/path/to/repo.git"));
// true


console.log(isSsh("[email protected]:/path/to/repo.git/"));
// true

console.log(isSsh("[email protected]:~user/path/to/repo.git/"));
// true

console.log(isSsh("[email protected]:path/to/repo.git"));
// true


console.log(isSsh("host.xz:/path/to/repo.git/"));
// true

console.log(isSsh("host.xz:path/to/repo.git"));
// true

console.log(isSsh("host.xz:~user/path/to/repo.git/"));
// true


console.log(isSsh("rsync://host.xz/path/to/repo.git/"));
// true


// Git Transport Protocol
console.log(isSsh("git://host.xz/path/to/repo.git/"));
// false

console.log(isSsh("git://host.xz/~user/path/to/repo.git/"));
// false

// HTTP/S Transport Protocol
console.log(isSsh("http://host.xz/path/to/repo.git/"));
// false

console.log(isSsh("https://host.xz/path/to/repo.git/"));
// false

console.log(isSsh("http://host.xz:8000/path/to/repo.git/"))
// false

console.log(isSsh("https://host.xz:8000/path/to/repo.git/"))
// false

// Local (Filesystem) Transport Protocol
console.log(isSsh("/path/to/repo.git/"));
// false

console.log(isSsh("path/to/repo.git/"));
// false

console.log(isSsh("~/path/to/repo.git"));
// false

console.log(isSsh("file:///path/to/repo.git/"));
// false

console.log(isSsh("file://~/path/to/repo.git/"));
// false

❓ 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. 🐛
3. For direct and quick help, you can use Codementor. 🚀

📝 Documentation

isSsh(input)

Checks if an input value is a ssh url or not.

Params

• String|Array input: The input url or an array of protocols.

Return

• Boolean true if the input is a ssh url, false otherwise.

😋 How to contribute

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

💖 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 🚀

• —I love books! I will remember you after years if you buy me one. 😁 📖

• —You can make one-time donations via PayPal. I'll probably buy a coffee 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! ❤️

💫 Where is this library used?

If you are using this library in one of your projects, add it in this list. ✨

• parse-url
• parse-path
• git-up
• nodegit-clone
• bb-parse-url
• bb-git-up
• normalize-ssh
• xl-git-up
• @hawkingnetwork/react-native-tab-view
• miguelcostero-ng2-toasty
• npm-all-packages
• @apardellass/react-native-audio-stream
• l2forlerna
• react-native-plugpag-wrapper
• react-native-pulsator-native
• react-native-kakao-maps
• @geeky-apo/react-native-advanced-clipboard
• native-apple-login
• native-google-login
• @hemith/react-native-tnk
• react-native-contact-list
• @corelmax/react-native-my2c2p-sdk
• clonit
• react-native-responsive-size
• react-native-test-module-hhh
• react-native-is7
• @buganto/client
• @datalogic/react-native-datalogic-module
• birken-react-native-community-image-editor
• @lakutata/core
• react-native-flyy
• native-kakao-login

📜 License

MIT © Ionică Bizău