https://github.com/dawsbot/openg

Open Github pages for npm modules in-browser
https://github.com/dawsbot/openg

Last synced: about 1 year ago
JSON representation

Open Github pages for npm modules in-browser

• Host: GitHub
• URL: https://github.com/dawsbot/openg
• Owner: dawsbot
• Created: 2016-03-22T09:30:42.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-02-15T09:16:12.000Z (over 9 years ago)
• Last Synced: 2024-11-06T11:04:30.252Z (over 1 year ago)
• Language: JavaScript
• Homepage:
• Size: 3.63 MB
• Stars: 14
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

          
# openg

[![Build Status](https://travis-ci.org/dawsbot/openg.svg?branch=master)](https://travis-ci.org/dawsbot/openg)

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

> open Github repo pages for npm modules in-browser




![demo gif](media/demo.gif)




# CLI

## Install

```

$ npm install -g openg-cli

```

If you'd rather have the API, [click here](/packages/openg)




## Usage

```sh

$ openg

# opens the github repo page for the current directory in browser

$ openg chalk

# opens the github repo page for chalk in browser

$ openg inf sist openg --issues

# opens the github issues pages for all in browser

```




More help

```sh

$ openg --help

  Usage

    $ openg []

    $ openg  []

  Options

    -i, --issues  Open the issue page for specified modules

    -d, --dryRun  List what links would be opened instead of opening

  Examples

    $ openg

    # opens the github repo page for the current directory in browser

    $ openg express

    # opens the github repo page for express in browser

    $ openg inf sist openg --issues

    #  opens the github issues pages for inf, sist, and openg in browser`,

```




## FAQ

#### How is this different than [npm repo](https://docs.npmjs.com/cli/repo)?

npm repo is an npm built-in. Here are the differences:

* `opts` allows you to open issues page(s)

* `openg` supports multiple module openings, `npm repo` supports only one at a time.




## Contribute

```js

npm run install

```

Since this is a [lerna](https://github.com/lerna/lern://github.com/lerna/lerna) project, both `openg-cli` and `openg` are contained within the `packages/` folder.




## Related

* [openm](https://github.com/dawsbot/openm)

* [opent](https://github.com/dawsbot/opent)




## License

MIT © [Dawson Botsford](http://dawsonbotsford.com)

---

If you like this, star it. If you want to follow me, follow me.