https://github.com/lovetingyuan/ty-help

Run command installed in local npm modules
https://github.com/lovetingyuan/ty-help

cli command-line help javascript local npm run tool

Last synced: 3 months ago
JSON representation

Run command installed in local npm modules

• Host: GitHub
• URL: https://github.com/lovetingyuan/ty-help
• Owner: lovetingyuan
• License: mit
• Created: 2017-05-13T18:20:43.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-12-21T03:15:52.000Z (over 7 years ago)
• Last Synced: 2025-04-01T17:11:54.398Z (3 months ago)
• Topics: cli, command-line, help, javascript, local, npm, run, tool
• Language: JavaScript
• Homepage:
• Size: 5.86 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
## ty-help

[![Version](https://img.shields.io/npm/v/ty-help.svg "version")](https://www.npmjs.com/package/ty-help)

[![depend](https://david-dm.org/lovetingyuan/ty-help/status.svg "dependencies")](https://david-dm.org/lovetingyuan/ty-help)

Run command installed in local node modules

### install

`npm install -D ty-help`

### usage:

add npm run command in your package.json file:

```json

{

  "scripts": {

    "help": "ty-help"

  }

}

```

for example, if you want to get help info of [`http-server`](https://github.com/indexzero/http-server), you can simply run:

`npm run help http-server`

or you can run a command with other options, like:

`npm run help http-server -- "./public -p 8888"`

### License

MIT