Faster package homepage open(er). Support CLI and Promises
OTHER License
Open NPM package/module homepage url from NPM registry. Support CLI and Promises
Install with npm
$ npm install homepage -g
$ pkg-open --help
You can also see bin/cli.js, tests for more example usages
promise example (open self)
homepage({promise: true})
.then(function resolve(res) {
assert(typeof res === 'object' && typeof res.visit === 'string')
assert(res.visit === 'https://github.com/tunnckoCore/homepage')
})
callback example (open mocha)
homepage('mocha', function(err, res) {
assert(err === null)
assert(typeof res === 'object' && typeof res.visit === 'string')
console.log(res.visit)
//=> https://github.com/mochajs/mocha
})
You can also use
make test
$ npm test
name
{String|Object} Name of the npm packageoptions
{Object|Fn} Options can be callback, if repo is object and .promise: false
name
{String} Name of the npm packagepromise
{Boolean} Handle response with promise - true/false or emptycallback
{Fn} Node-style callback, same as always$ pkg-open --help
Flags can be used in any order.
--help
--version
-n
|--name
|1st arg
{String} Name of the npm package-p
|--promise
|2nd arg
{Boolean} Handle response with promise - true/false or emptyExample usage
$ pkg-open <name> [promise]
$ pkg-open mocha # open github.com/mochajs/mocha
$ pkg-open -n koa -p # open github.com/koajs/koa
$ pkg-open gulp # open gulpjs.com
$ pkg-open lodash -p # open lodash.com
$ pkg-open --promise --name assemble # open assemble.io
$ pkg-open -n express # open expressjs.com
Charlike Mike Reagent
Copyright (c) 2014 Charlike Mike Reagent, contributors.
Released under the MIT
license.