diff options
Diffstat (limited to 'deps/npm/man/man1/npm-hook.1')
| -rw-r--r-- | deps/npm/man/man1/npm-hook.1 | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/deps/npm/man/man1/npm-hook.1 b/deps/npm/man/man1/npm-hook.1 new file mode 100644 index 0000000000..c4844c5a53 --- /dev/null +++ b/deps/npm/man/man1/npm-hook.1 @@ -0,0 +1,97 @@ +.TH "NPM\-HOOK" "1" "May 2018" "" "" +.SH "NAME" +\fBnpm-hook\fR \- Manage registry hooks +.SH SYNOPSIS +.P +.RS 2 +.nf +npm hook ls [pkg] +npm hook add <entity> <url> <secret> +npm hook update <id> <url> [secret] +npm hook rm <id> +.fi +.RE +.SH EXAMPLE +.P +Add a hook to watch a package for changes: +.P +.RS 2 +.nf +$ npm hook add lodash https://example\.com/ my\-shared\-secret +.fi +.RE +.P +Add a hook to watch packages belonging to the user \fBsubstack\fP: +.P +.RS 2 +.nf +$ npm hook add ~substack https://example\.com/ my\-shared\-secret +.fi +.RE +.P +Add a hook to watch packages in the scope \fB@npm\fP +.P +.RS 2 +.nf +$ npm hook add @npm https://example\.com/ my\-shared\-secret +.fi +.RE +.P +List all your active hooks: +.P +.RS 2 +.nf +$ npm hook ls +.fi +.RE +.P +List your active hooks for the \fBlodash\fP package: +.P +.RS 2 +.nf +$ npm hook ls lodash +.fi +.RE +.P +Update an existing hook's url: +.P +.RS 2 +.nf +$ npm hook update id\-deadbeef https://my\-new\-website\.here/ +.fi +.RE +.P +Remove a hook: +.P +.RS 2 +.nf +$ npm hook rm id\-deadbeef +.fi +.RE +.SH DESCRIPTION +.P +Allows you to manage npm +hooks \fIhttp://blog\.npmjs\.org/post/145260155635/introducing\-hooks\-get\-notifications\-of\-npm\fR, +including adding, removing, listing, and updating\. +.P +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\. +.P +To create a package hook, simply reference the package name\. +.P +To create an owner hook, prefix the owner name with \fB~\fP (as in, \fB~youruser\fP)\. +.P +To create a scope hook, prefix the scope name with \fB@\fP (as in, \fB@yourscope\fP)\. +.P +The hook \fBid\fP used by \fBupdate\fP and \fBrm\fP are the IDs listed in \fBnpm hook ls\fP for +that particular hook\. +.P +The shared secret will be sent along to the URL endpoint so you can verify the +request came from your own configured hook\. +.SH SEE ALSO +.RS 0 +.IP \(bu 2 +"Introducing Hooks" blog post \fIhttp://blog\.npmjs\.org/post/145260155635/introducing\-hooks\-get\-notifications\-of\-npm\fR + +.RE |