A simple Node CLI wrapper for http://git.io.
In Terminal, simply enter gitio shrink
followed by the GitHub URL you would like to shrink and the shortened URL will be copied automatically to your clipboard. Read more about git.io here.
Copying to clipboard is implemented via the copy-paste package which supports OSX, Windows, Linux, and OpenBSD.
A quick note: This is not a generic URL shortener. git.io—and by extension, this package—only shortens links that are hosted within the github.com
domain.
$ npm install -g node-gitio
$ gitio shrink github.com/.../my_cool_package
# => http://git.io/vZHUg ✔ copied to clipboard
$ gitio shrink github.com/.../my_cool_package -c mycoolpackage
# => http://git.io/mycoolpackage ✔ copied to clipboard
Usage: gitio [--version] [--help] <command> [<args>]
Commands:
shrink Shrink a GitHub URL.
Options:
--help, -h Show the help menu.
--version, -v Show version number.
Usage: gitio shrink <long url> [-c code] [--help]
Options:
--code, -c A custom code for the short link, e.g. http://git.io/mycode. (Optional)
--help, -h Show the help menu.
var gitio = require('node-gitio');
gitio.shrink(payload, (err, result) => {
if (!err) {
console.log(result);
}
});
Name | Type | Description | Required |
---|---|---|---|
url |
string |
The GitHub URL to shorten. Only HTTPS is supported. | ✓ |
code |
string |
A custom code for the short link, e.g. http://git.io/mycode. |
- Shorten
github.com/nathanbuchar/node-gitio
.
$ gitio shrink github.com/nathanbuchar/node-gitio
# => https://git.io/vZ9RJ ✔ copied to clipboard
- Shorten
github.com/nathanbuchar/node-gitio
and attempt to usenathan-gitio
as the custom code (if available).
$ gitio shrink github.com/nathanbuchar/node-gitio -c nathan-gitio
# => https://git.io/nathan-gitio ✔ copied to clipboard
- Shorten
github.com/nathanbuchar/node-gitio
via Node JS and log the result.
var gitio = require('node-gitio');
gitio.shrink({
url: 'github.com/nathanbuchar/node-gitio'
}, (err, result) => {
if (!err) {
console.log(result);
// => https://git.io/vZ9RJ
}
});
MIT