https://github.com/ceejbot/jthooks

create a github webhook from the command-line
https://github.com/ceejbot/jthooks

Last synced: about 1 year ago
JSON representation

create a github webhook from the command-line

• Host: GitHub
• URL: https://github.com/ceejbot/jthooks
• Owner: ceejbot
• License: isc
• Created: 2014-10-22T21:39:45.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2017-05-02T18:29:12.000Z (about 9 years ago)
• Last Synced: 2024-10-06T07:37:31.873Z (over 1 year ago)
• Language: JavaScript
• Size: 49.8 KB
• Stars: 19
• Watchers: 3
• Forks: 5
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# jthooks

Create a github webhook from the command line. Pronounced "ji-thooks", as one would say if pronouncing "githooks" with a soft G, instead of the more common hard-G "gih-thooks".

[![on npm](http://img.shields.io/npm/v/jthooks.svg?style=flat)](https://www.npmjs.org/package/jthooks)  [![Tests](http://img.shields.io/travis/ceejbot/jthooks.svg?style=flat)](http://travis-ci.org/ceejbot/jthooks)  ![Coverage](http://img.shields.io/badge/coverage-71%25-red.svg?style=flat)   [![Dependencies](http://img.shields.io/david/ceejbot/jthooks.svg?style=flat)](https://david-dm.org/ceejbot/jthooks)

## Usage

First, create a Github oauth token that has permission to read & write webhooks. Full admin permission is not required. Keep a record of the token somewhere secure.

```shell

jthooks [add|remove] user/repo https://example.com/hook shared-sekrit

Commands:

  add     add a hook to the given repo with the shared

                              secret

  remove          delete the given webhook; can pass id instead of

                              url

Options:

  --auth, -a   auth token (can also be set in GITHUB_AUTH_TOKEN or

               GITHUB_API_TOKEN)

  --url, -u    full URL of github API to use (optional)

  --quiet, -q  only log errors

  --id         id of existing hook to update (optional)

  --help       show this help                                          [boolean]

Examples:

  jthooks add foo/bar https://example.com/hook sooper-sekrit -a auth-token   add a webhook

  jthooks remove foo/bar https://example.com/hook  remove a hook by url

  jthooks remove foo/bar 123456                    remove a hook by id

```

If you want to update an existing webhook, run the script with `--id`. Otherwise the script will attempt to find an existing hook with the same url & update that in place. If no match is found, a hook is created.

Set the `--url` option if you're not running against github.com but instead wish to change a repo on your Github Enterprise installation.

## TODO

Delete a hook.

More than merely cursory tests.

## License

ISC; see included LICENSE file.