diff options
author | Kat Marchán <kzm@sykosomatic.org> | 2018-02-26 20:41:55 +0300 |
---|---|---|
committer | Rebecca Turner <me@re-becca.org> | 2018-04-11 04:19:28 +0300 |
commit | a9e7221181dc88e14820d0677acccf0648ac3c5a (patch) | |
tree | 2dd705ac217b941188bf565cb35ea8c8dd908a06 /doc | |
parent | 44972d53df2e0f0cc22d527ac88045066205dbbf (diff) |
hook: add support for managing npm hooks
PR-URL: https://github.com/npm/npm/pull/20256
Credit: @zkat
Reviewed-By: @iarna
Diffstat (limited to 'doc')
-rw-r--r-- | doc/cli/npm-hook.md | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/cli/npm-hook.md b/doc/cli/npm-hook.md new file mode 100644 index 000000000..34deecaf9 --- /dev/null +++ b/doc/cli/npm-hook.md @@ -0,0 +1,72 @@ +npm-hook(1) -- Manage registry hooks +=================================== + +## SYNOPSIS + + npm hook ls [pkg] + npm hook add <entity> <url> <secret> + npm hook update <id> <url> [secret] + npm hook rm <id> + +## EXAMPLE + +Add a hook to watch a package for changes: +``` +$ npm hook add lodash https://example.com/ my-shared-secret +``` + +Add a hook to watch packages belonging to the user `substack`: +``` +$ npm hook add ~substack https://example.com/ my-shared-secret +``` + +Add a hook to watch packages in the scope `@npm` +``` +$ npm hook add @npm https://example.com/ my-shared-secret +``` + +List all your active hooks: +``` +$ npm hook ls +``` + +List your active hooks for the `lodash` package: +``` +$ npm hook ls lodash +``` + +Update an existing hook's url: +``` +$ npm hook update id-deadbeef https://my-new-website.here/ +``` + +Remove a hook: +``` +$ npm hook rm id-deadbeef +``` + +## DESCRIPTION + +Allows you to manage [npm +hooks](http://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm), +including adding, removing, listing, and updating. + +Hooks allow you to configure URL endpoints that will be notified whenever a +change happens to any of the supported entity types. Three different types of +entities can be watched by hooks: packages, owners, and scopes. + +To create a package hook, simply reference the package name. + +To create an owner hook, prefix the owner name with `~` (as in, `~youruser`). + +To create a scope hook, prefix the scope name with `@` (as in, `@yourscope`). + +The hook `id` used by `update` and `rm` are the IDs listed in `npm hook ls` for +that particular hook. + +The shared secret will be sent along to the URL endpoint so you can verify the +request came from your own configured hook. + +## SEE ALSO + +* ["Introducing Hooks" blog post](http://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm) |