homepage

    1.0.0 • Public • Published

    homepage NPM version Dependency Status Coveralls

    Open NPM package/module homepage url from NPM registry.
    Support CLI and Promises

    Shortcuts

    Install Nodei.co stats

    Install with npm

    $ npm install homepage -g
    $ homepage --help
    

    Usage

    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
    })

    Tests

    You can also use make test

    $ npm test
    

    API

    homepage(name, [options], [callback])

    • name {String|Object} Name of the npm package
    • options {Object|Fn} Options can be callback, if repo is object and .promise: false
      • name {String} Name of the npm package
      • promise {Boolean} Handle response with promise - true/false or empty
    • callback {Fn} Node-style callback, same as always

    CLI

    $ homepage --help
    

    Flags

    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 empty

    Example usage

    $ homepage <name> [promise]
    $ homepage mocha                        # open github.com/mochajs/mocha
    $ homepage -n koa -p                    # open github.com/koajs/koa
    $ homepage gulp                         # open gulpjs.com
    $ homepage lodash -p                    # open lodash.com
    $ homepage --promise --name assemble    # open assemble.io
    $ homepage -n express                   # open expressjs.com
    

    Authors & Contributors

    Charlike Mike Reagent author tips

    License MIT license

    Copyright (c) 2014 Charlike Mike Reagent, contributors.
    Released under the MIT license.

    Install

    npm i homepage

    DownloadsWeekly Downloads

    280

    Version

    1.0.0

    License

    none

    Last publish

    Collaborators

    • vanchoy
    • tunnckocore