The is-ssh npm package is designed to check if a given string is a valid SSH URL. It can be used to validate SSH URLs in various applications, ensuring that the URLs conform to the expected format for SSH connections. This can be particularly useful in applications that deal with remote server management, deployment scripts, or any scenario where SSH URLs are handled programmatically.
Validate SSH URL
This feature allows you to check if a given string is a valid SSH URL. The function returns true if the string is a valid SSH URL, otherwise, it returns false. This is useful for validating user input, configuration settings, or any data that is expected to be in the form of an SSH URL.
"const isSSH = require('is-ssh');
console.log(isSSH('git@github.com:user/repo.git')); // true
console.log(isSSH('https://github.com/user/repo.git')); // false"The 'validator' package is a comprehensive library for string validation and sanitization. While it offers a wide range of validation functions, including URL validation, it does not have a specific function dedicated to SSH URL validation. Compared to is-ssh, validator is more general-purpose and does not provide the same focused functionality for SSH URLs.
The 'is-url' package is designed to validate URLs to check if they are correctly formatted. Similar to 'validator', it provides a broader URL validation functionality but does not specifically target SSH URLs. Compared to is-ssh, 'is-url' offers a more general URL validation without the specificity for SSH URL formats.
Check if an input value is a ssh url or not.
$ npm i --save is-ssh
// Dependencies
const isSsh = require("is-ssh");
// Secure Shell Transport Protocol (SSH)
console.log(isSsh("ssh://user@host.xz:port/path/to/repo.git/"));
// true
console.log(isSsh("ssh://user@host.xz/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://user@host.xz/path/to/repo.git/"));
// true
console.log(isSsh("ssh://host.xz/path/to/repo.git/"));
// true
console.log(isSsh("ssh://user@host.xz/~user/path/to/repo.git/"));
// true
console.log(isSsh("ssh://host.xz/~user/path/to/repo.git/"));
// true
console.log(isSsh("ssh://user@host.xz/~/path/to/repo.git"));
// true
console.log(isSsh("ssh://host.xz/~/path/to/repo.git"));
// true
console.log(isSsh("user@host.xz:/path/to/repo.git/"));
// true
console.log(isSsh("user@host.xz:~user/path/to/repo.git/"));
// true
console.log(isSsh("user@host.xz: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
// 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
isSsh(input)Checks if an input value is a ssh url or not.
input: The input url or an array of protocols.true if the input is a ssh url, false otherwise.Have an idea? Found a bug? See how to contribute.
If you are using this library in one of your projects, add it in this list. :sparkles:
FAQs
Check if an input value is a ssh url or not.
The npm package is-ssh receives a total of 1,705,900 weekly downloads. As such, is-ssh popularity was classified as popular.
We found that is-ssh demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.